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.EventControllerMotion;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gobject.Signals;
30 private import gtk.EventController;
31 private import gtk.Widget;
32 private import gtk.c.functions;
33 public  import gtk.c.types;
34 public  import gtkc.gtktypes;
35 private import std.algorithm;
36 
37 
38 /**
39  * #GtkEventControllerMotion is an event controller meant for situations
40  * where you need to track the position of the pointer.
41  * 
42  * This object was added in 3.24.
43  */
44 public class EventControllerMotion : EventController
45 {
46 	/** the main Gtk struct */
47 	protected GtkEventControllerMotion* gtkEventControllerMotion;
48 
49 	/** Get the main Gtk struct */
50 	public GtkEventControllerMotion* getEventControllerMotionStruct(bool transferOwnership = false)
51 	{
52 		if (transferOwnership)
53 			ownedRef = false;
54 		return gtkEventControllerMotion;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)gtkEventControllerMotion;
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (GtkEventControllerMotion* gtkEventControllerMotion, bool ownedRef = false)
67 	{
68 		this.gtkEventControllerMotion = gtkEventControllerMotion;
69 		super(cast(GtkEventController*)gtkEventControllerMotion, ownedRef);
70 	}
71 
72 
73 	/** */
74 	public static GType getType()
75 	{
76 		return gtk_event_controller_motion_get_type();
77 	}
78 
79 	/**
80 	 * Creates a new event controller that will handle motion events
81 	 * for the given @widget.
82 	 *
83 	 * Params:
84 	 *     widget = a #GtkWidget
85 	 *
86 	 * Returns: a new #GtkEventControllerMotion
87 	 *
88 	 * Since: 3.24
89 	 *
90 	 * Throws: ConstructionException GTK+ fails to create the object.
91 	 */
92 	public this(Widget widget)
93 	{
94 		auto p = gtk_event_controller_motion_new((widget is null) ? null : widget.getWidgetStruct());
95 
96 		if(p is null)
97 		{
98 			throw new ConstructionException("null returned by new");
99 		}
100 
101 		this(cast(GtkEventControllerMotion*) p, true);
102 	}
103 
104 	/**
105 	 * Signals that the pointer has entered the widget.
106 	 *
107 	 * Params:
108 	 *     x = the x coordinate
109 	 *     y = the y coordinate
110 	 */
111 	gulong addOnEnter(void delegate(double, double, EventControllerMotion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
112 	{
113 		return Signals.connect(this, "enter", dlg, connectFlags ^ ConnectFlags.SWAPPED);
114 	}
115 
116 	/**
117 	 * Signals that pointer has left the widget.
118 	 */
119 	gulong addOnLeave(void delegate(EventControllerMotion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
120 	{
121 		return Signals.connect(this, "leave", dlg, connectFlags ^ ConnectFlags.SWAPPED);
122 	}
123 
124 	/**
125 	 * Emitted when the pointer moves inside the widget.
126 	 *
127 	 * Params:
128 	 *     x = the x coordinate
129 	 *     y = the y coordinate
130 	 */
131 	gulong addOnMotion(void delegate(double, double, EventControllerMotion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
132 	{
133 		return Signals.connect(this, "motion", dlg, connectFlags ^ ConnectFlags.SWAPPED);
134 	}
135 }