gtk.EventControllerLegacy 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.EventControllerLegacy;
26 
27 private import gdk.Event;
28 private import glib.ConstructionException;
29 private import gobject.ObjectG;
30 private import gobject.Signals;
31 private import gtk.EventController;
32 private import gtk.c.functions;
33 public  import gtk.c.types;
34 private import std.algorithm;
35 
36 
37 /**
38  * `GtkEventControllerLegacy` is an event controller that provides raw
39  * access to the event stream.
40  * 
41  * It should only be used as a last resort if none of the other event
42  * controllers or gestures do the job.
43  */
44 public class EventControllerLegacy : EventController
45 {
46 	/** the main Gtk struct */
47 	protected GtkEventControllerLegacy* gtkEventControllerLegacy;
48 
49 	/** Get the main Gtk struct */
50 	public GtkEventControllerLegacy* getEventControllerLegacyStruct(bool transferOwnership = false)
51 	{
52 		if (transferOwnership)
53 			ownedRef = false;
54 		return gtkEventControllerLegacy;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)gtkEventControllerLegacy;
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (GtkEventControllerLegacy* gtkEventControllerLegacy, bool ownedRef = false)
67 	{
68 		this.gtkEventControllerLegacy = gtkEventControllerLegacy;
69 		super(cast(GtkEventController*)gtkEventControllerLegacy, ownedRef);
70 	}
71 
72 
73 	/** */
74 	public static GType getType()
75 	{
76 		return gtk_event_controller_legacy_get_type();
77 	}
78 
79 	/**
80 	 * Creates a new legacy event controller.
81 	 *
82 	 * Returns: the newly created event controller.
83 	 *
84 	 * Throws: ConstructionException GTK+ fails to create the object.
85 	 */
86 	public this()
87 	{
88 		auto __p = gtk_event_controller_legacy_new();
89 
90 		if(__p is null)
91 		{
92 			throw new ConstructionException("null returned by new");
93 		}
94 
95 		this(cast(GtkEventControllerLegacy*) __p, true);
96 	}
97 
98 	/**
99 	 * Emitted for each GDK event delivered to @controller.
100 	 *
101 	 * Params:
102 	 *     event = the `GdkEvent` which triggered this signal
103 	 *
104 	 * Returns: %TRUE to stop other handlers from being invoked for the event
105 	 *     and the emission of this signal. %FALSE to propagate the event further.
106 	 */
107 	gulong addOnEvent(bool delegate(Event, EventControllerLegacy) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
108 	{
109 		return Signals.connect(this, "event", dlg, connectFlags ^ ConnectFlags.SWAPPED);
110 	}
111 }