gtk.MnemonicTrigger source code

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.MnemonicTrigger;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.ShortcutTrigger;
30 private import gtk.c.functions;
31 public  import gtk.c.types;
32 
33 
34 /**
35  * A `GtkShortcutTrigger` that triggers when a specific mnemonic is pressed.
36  * 
37  * Mnemonics require a *mnemonic modifier* (typically <kbd>Alt</kbd>) to be
38  * pressed together with the mnemonic key.
39  */
40 public class MnemonicTrigger : ShortcutTrigger
41 {
42 	/** the main Gtk struct */
43 	protected GtkMnemonicTrigger* gtkMnemonicTrigger;
44 
45 	/** Get the main Gtk struct */
46 	public GtkMnemonicTrigger* getMnemonicTriggerStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return gtkMnemonicTrigger;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gtkMnemonicTrigger;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (GtkMnemonicTrigger* gtkMnemonicTrigger, bool ownedRef = false)
63 	{
64 		this.gtkMnemonicTrigger = gtkMnemonicTrigger;
65 		super(cast(GtkShortcutTrigger*)gtkMnemonicTrigger, ownedRef);
66 	}
67 
68 
69 	/** */
70 	public static GType getType()
71 	{
72 		return gtk_mnemonic_trigger_get_type();
73 	}
74 
75 	/**
76 	 * Creates a `GtkShortcutTrigger` that will trigger whenever the key with
77 	 * the given @keyval is pressed and mnemonics have been activated.
78 	 *
79 	 * Mnemonics are activated by calling code when a key event with the right
80 	 * modifiers is detected.
81 	 *
82 	 * Params:
83 	 *     keyval = The keyval to trigger for
84 	 *
85 	 * Returns: A new `GtkShortcutTrigger`
86 	 *
87 	 * Throws: ConstructionException GTK+ fails to create the object.
88 	 */
89 	public this(uint keyval)
90 	{
91 		auto __p = gtk_mnemonic_trigger_new(keyval);
92 
93 		if(__p is null)
94 		{
95 			throw new ConstructionException("null returned by new");
96 		}
97 
98 		this(cast(GtkMnemonicTrigger*) __p, true);
99 	}
100 
101 	/**
102 	 * Gets the keyval that must be pressed to succeed triggering @self.
103 	 *
104 	 * Returns: the keyval
105 	 */
106 	public uint getKeyval()
107 	{
108 		return gtk_mnemonic_trigger_get_keyval(gtkMnemonicTrigger);
109 	}
110 }