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