gtk.KeyvalTrigger 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.KeyvalTrigger;
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 keyval and modifiers are pressed.
36  */
37 public class KeyvalTrigger : ShortcutTrigger
38 {
39 	/** the main Gtk struct */
40 	protected GtkKeyvalTrigger* gtkKeyvalTrigger;
41 
42 	/** Get the main Gtk struct */
43 	public GtkKeyvalTrigger* getKeyvalTriggerStruct(bool transferOwnership = false)
44 	{
45 		if (transferOwnership)
46 			ownedRef = false;
47 		return gtkKeyvalTrigger;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gtkKeyvalTrigger;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GtkKeyvalTrigger* gtkKeyvalTrigger, bool ownedRef = false)
60 	{
61 		this.gtkKeyvalTrigger = gtkKeyvalTrigger;
62 		super(cast(GtkShortcutTrigger*)gtkKeyvalTrigger, ownedRef);
63 	}
64 
65 
66 	/** */
67 	public static GType getType()
68 	{
69 		return gtk_keyval_trigger_get_type();
70 	}
71 
72 	/**
73 	 * Creates a `GtkShortcutTrigger` that will trigger whenever
74 	 * the key with the given @keyval and @modifiers is pressed.
75 	 *
76 	 * Params:
77 	 *     keyval = The keyval to trigger for
78 	 *     modifiers = the modifiers that need to be present
79 	 *
80 	 * Returns: A new `GtkShortcutTrigger`
81 	 *
82 	 * Throws: ConstructionException GTK+ fails to create the object.
83 	 */
84 	public this(uint keyval, GdkModifierType modifiers)
85 	{
86 		auto __p = gtk_keyval_trigger_new(keyval, modifiers);
87 
88 		if(__p is null)
89 		{
90 			throw new ConstructionException("null returned by new");
91 		}
92 
93 		this(cast(GtkKeyvalTrigger*) __p, true);
94 	}
95 
96 	/**
97 	 * Gets the keyval that must be pressed to succeed
98 	 * triggering @self.
99 	 *
100 	 * Returns: the keyval
101 	 */
102 	public uint getKeyval()
103 	{
104 		return gtk_keyval_trigger_get_keyval(gtkKeyvalTrigger);
105 	}
106 
107 	/**
108 	 * Gets the modifiers that must be present to succeed
109 	 * triggering @self.
110 	 *
111 	 * Returns: the modifiers
112 	 */
113 	public GdkModifierType getModifiers()
114 	{
115 		return gtk_keyval_trigger_get_modifiers(gtkKeyvalTrigger);
116 	}
117 }