1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gtk.IMMulticontext;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import gtk.IMContext;
31 private import gtk.MenuShell;
32 private import gtk.c.functions;
33 public  import gtk.c.types;
34 public  import gtkc.gtktypes;
35 
36 
37 /** */
38 public class IMMulticontext : IMContext
39 {
40 	/** the main Gtk struct */
41 	protected GtkIMMulticontext* gtkIMMulticontext;
42 
43 	/** Get the main Gtk struct */
44 	public GtkIMMulticontext* getIMMulticontextStruct(bool transferOwnership = false)
45 	{
46 		if (transferOwnership)
47 			ownedRef = false;
48 		return gtkIMMulticontext;
49 	}
50 
51 	/** the main Gtk struct as a void* */
52 	protected override void* getStruct()
53 	{
54 		return cast(void*)gtkIMMulticontext;
55 	}
56 
57 	protected override void setStruct(GObject* obj)
58 	{
59 		gtkIMMulticontext = cast(GtkIMMulticontext*)obj;
60 		super.setStruct(obj);
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (GtkIMMulticontext* gtkIMMulticontext, bool ownedRef = false)
67 	{
68 		this.gtkIMMulticontext = gtkIMMulticontext;
69 		super(cast(GtkIMContext*)gtkIMMulticontext, ownedRef);
70 	}
71 
72 
73 	/** */
74 	public static GType getType()
75 	{
76 		return gtk_im_multicontext_get_type();
77 	}
78 
79 	/**
80 	 * Creates a new #GtkIMMulticontext.
81 	 *
82 	 * Returns: a new #GtkIMMulticontext.
83 	 *
84 	 * Throws: ConstructionException GTK+ fails to create the object.
85 	 */
86 	public this()
87 	{
88 		auto p = gtk_im_multicontext_new();
89 
90 		if(p is null)
91 		{
92 			throw new ConstructionException("null returned by new");
93 		}
94 
95 		this(cast(GtkIMMulticontext*) p, true);
96 	}
97 
98 	/**
99 	 * Add menuitems for various available input methods to a menu;
100 	 * the menuitems, when selected, will switch the input method
101 	 * for the context and the global default input method.
102 	 *
103 	 * Deprecated: It is better to use the system-wide input
104 	 * method framework for changing input methods. Modern
105 	 * desktop shells offer on-screen displays for this that
106 	 * can triggered with a keyboard shortcut, e.g. Super-Space.
107 	 *
108 	 * Params:
109 	 *     menushell = a #GtkMenuShell
110 	 */
111 	public void appendMenuitems(MenuShell menushell)
112 	{
113 		gtk_im_multicontext_append_menuitems(gtkIMMulticontext, (menushell is null) ? null : menushell.getMenuShellStruct());
114 	}
115 
116 	/**
117 	 * Gets the id of the currently active slave of the @context.
118 	 *
119 	 * Returns: the id of the currently active slave
120 	 *
121 	 * Since: 2.16
122 	 */
123 	public string getContextId()
124 	{
125 		return Str.toString(gtk_im_multicontext_get_context_id(gtkIMMulticontext));
126 	}
127 
128 	/**
129 	 * Sets the context id for @context.
130 	 *
131 	 * This causes the currently active slave of @context to be
132 	 * replaced by the slave corresponding to the new context id.
133 	 *
134 	 * Params:
135 	 *     contextId = the id to use
136 	 *
137 	 * Since: 2.16
138 	 */
139 	public void setContextId(string contextId)
140 	{
141 		gtk_im_multicontext_set_context_id(gtkIMMulticontext, Str.toStringz(contextId));
142 	}
143 }