gtk.AlternativeTrigger 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.AlternativeTrigger;
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 combines two triggers.
36  * 
37  * The `GtkAlternativeTrigger` triggers when either of two trigger.
38  * 
39  * This can be cascaded to combine more than two triggers.
40  */
41 public class AlternativeTrigger : ShortcutTrigger
42 {
43 	/** the main Gtk struct */
44 	protected GtkAlternativeTrigger* gtkAlternativeTrigger;
45 
46 	/** Get the main Gtk struct */
47 	public GtkAlternativeTrigger* getAlternativeTriggerStruct(bool transferOwnership = false)
48 	{
49 		if (transferOwnership)
50 			ownedRef = false;
51 		return gtkAlternativeTrigger;
52 	}
53 
54 	/** the main Gtk struct as a void* */
55 	protected override void* getStruct()
56 	{
57 		return cast(void*)gtkAlternativeTrigger;
58 	}
59 
60 	/**
61 	 * Sets our main struct and passes it to the parent class.
62 	 */
63 	public this (GtkAlternativeTrigger* gtkAlternativeTrigger, bool ownedRef = false)
64 	{
65 		this.gtkAlternativeTrigger = gtkAlternativeTrigger;
66 		super(cast(GtkShortcutTrigger*)gtkAlternativeTrigger, ownedRef);
67 	}
68 
69 
70 	/** */
71 	public static GType getType()
72 	{
73 		return gtk_alternative_trigger_get_type();
74 	}
75 
76 	/**
77 	 * Creates a `GtkShortcutTrigger` that will trigger whenever
78 	 * either of the two given triggers gets triggered.
79 	 *
80 	 * Note that nesting is allowed, so if you want more than two
81 	 * alternative, create a new alternative trigger for each option.
82 	 *
83 	 * Params:
84 	 *     first = The first trigger that may trigger
85 	 *     second = The second trigger that may trigger
86 	 *
87 	 * Returns: a new `GtkShortcutTrigger`
88 	 *
89 	 * Throws: ConstructionException GTK+ fails to create the object.
90 	 */
91 	public this(ShortcutTrigger first, ShortcutTrigger second)
92 	{
93 		auto __p = gtk_alternative_trigger_new((first is null) ? null : first.getShortcutTriggerStruct(), (second is null) ? null : second.getShortcutTriggerStruct());
94 
95 		if(__p is null)
96 		{
97 			throw new ConstructionException("null returned by new");
98 		}
99 
100 		this(cast(GtkAlternativeTrigger*) __p, true);
101 	}
102 
103 	/**
104 	 * Gets the first of the two alternative triggers that may
105 	 * trigger @self.
106 	 *
107 	 * [method@Gtk.AlternativeTrigger.get_second] will return
108 	 * the other one.
109 	 *
110 	 * Returns: the first alternative trigger
111 	 */
112 	public ShortcutTrigger getFirst()
113 	{
114 		auto __p = gtk_alternative_trigger_get_first(gtkAlternativeTrigger);
115 
116 		if(__p is null)
117 		{
118 			return null;
119 		}
120 
121 		return ObjectG.getDObject!(ShortcutTrigger)(cast(GtkShortcutTrigger*) __p);
122 	}
123 
124 	/**
125 	 * Gets the second of the two alternative triggers that may
126 	 * trigger @self.
127 	 *
128 	 * [method@Gtk.AlternativeTrigger.get_first] will return
129 	 * the other one.
130 	 *
131 	 * Returns: the second alternative trigger
132 	 */
133 	public ShortcutTrigger getSecond()
134 	{
135 		auto __p = gtk_alternative_trigger_get_second(gtkAlternativeTrigger);
136 
137 		if(__p is null)
138 		{
139 			return null;
140 		}
141 
142 		return ObjectG.getDObject!(ShortcutTrigger)(cast(GtkShortcutTrigger*) __p);
143 	}
144 }