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 gtkc.gtk;
33 public  import gtkc.gtktypes;
34 
35 
36 /** */
37 public class IMMulticontext : IMContext
38 {
39 	/** the main Gtk struct */
40 	protected GtkIMMulticontext* gtkIMMulticontext;
41 
42 	/** Get the main Gtk struct */
43 	public GtkIMMulticontext* getIMMulticontextStruct()
44 	{
45 		return gtkIMMulticontext;
46 	}
47 
48 	/** the main Gtk struct as a void* */
49 	protected override void* getStruct()
50 	{
51 		return cast(void*)gtkIMMulticontext;
52 	}
53 
54 	protected override void setStruct(GObject* obj)
55 	{
56 		gtkIMMulticontext = cast(GtkIMMulticontext*)obj;
57 		super.setStruct(obj);
58 	}
59 
60 	/**
61 	 * Sets our main struct and passes it to the parent class.
62 	 */
63 	public this (GtkIMMulticontext* gtkIMMulticontext, bool ownedRef = false)
64 	{
65 		this.gtkIMMulticontext = gtkIMMulticontext;
66 		super(cast(GtkIMContext*)gtkIMMulticontext, ownedRef);
67 	}
68 
69 
70 	/** */
71 	public static GType getType()
72 	{
73 		return gtk_im_multicontext_get_type();
74 	}
75 
76 	/**
77 	 * Creates a new #GtkIMMulticontext.
78 	 *
79 	 * Return: a new #GtkIMMulticontext.
80 	 *
81 	 * Throws: ConstructionException GTK+ fails to create the object.
82 	 */
83 	public this()
84 	{
85 		auto p = gtk_im_multicontext_new();
86 		
87 		if(p is null)
88 		{
89 			throw new ConstructionException("null returned by new");
90 		}
91 		
92 		this(cast(GtkIMMulticontext*) p, true);
93 	}
94 
95 	/**
96 	 * Add menuitems for various available input methods to a menu;
97 	 * the menuitems, when selected, will switch the input method
98 	 * for the context and the global default input method.
99 	 *
100 	 * Deprecated: It is better to use the system-wide input
101 	 * method framework for changing input methods. Modern
102 	 * desktop shells offer on-screen displays for this that
103 	 * can triggered with a keyboard shortcut, e.g. Super-Space.
104 	 *
105 	 * Params:
106 	 *     menushell = a #GtkMenuShell
107 	 */
108 	public void appendMenuitems(MenuShell menushell)
109 	{
110 		gtk_im_multicontext_append_menuitems(gtkIMMulticontext, (menushell is null) ? null : menushell.getMenuShellStruct());
111 	}
112 
113 	/**
114 	 * Gets the id of the currently active slave of the @context.
115 	 *
116 	 * Return: the id of the currently active slave
117 	 *
118 	 * Since: 2.16
119 	 */
120 	public string getContextId()
121 	{
122 		return Str.toString(gtk_im_multicontext_get_context_id(gtkIMMulticontext));
123 	}
124 
125 	/**
126 	 * Sets the context id for @context.
127 	 *
128 	 * This causes the currently active slave of @context to be
129 	 * replaced by the slave corresponding to the new context id.
130 	 *
131 	 * Params:
132 	 *     contextId = the id to use
133 	 *
134 	 * Since: 2.16
135 	 */
136 	public void setContextId(string contextId)
137 	{
138 		gtk_im_multicontext_set_context_id(gtkIMMulticontext, Str.toStringz(contextId));
139 	}
140 }