File: GestureStylus.d

package info (click to toggle)
gtk-d 3.10.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,204 kB
  • sloc: javascript: 565; sh: 71; makefile: 23
file content (192 lines) | stat: -rw-r--r-- 5,413 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module gtk.GestureStylus;

private import gdk.DeviceTool;
private import glib.ConstructionException;
private import gobject.ObjectG;
private import gobject.Signals;
private import gtk.Gesture;
private import gtk.GestureSingle;
private import gtk.Widget;
private import gtk.c.functions;
public  import gtk.c.types;
public  import gtkc.gtktypes;
private import std.algorithm;


/**
 * #GtkGestureStylus is a #GtkGesture implementation specific to stylus
 * input. The provided signals just provide the basic information
 */
public class GestureStylus : GestureSingle
{
	/** the main Gtk struct */
	protected GtkGestureStylus* gtkGestureStylus;

	/** Get the main Gtk struct */
	public GtkGestureStylus* getGestureStylusStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkGestureStylus;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkGestureStylus;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GtkGestureStylus* gtkGestureStylus, bool ownedRef = false)
	{
		this.gtkGestureStylus = gtkGestureStylus;
		super(cast(GtkGestureSingle*)gtkGestureStylus, ownedRef);
	}


	/** */
	public static GType getType()
	{
		return gtk_gesture_stylus_get_type();
	}

	/**
	 * Creates a new #GtkGestureStylus.
	 *
	 * Params:
	 *     widget = a #GtkWidget
	 *
	 * Returns: a newly created stylus gesture
	 *
	 * Since: 3.24
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(Widget widget)
	{
		auto p = gtk_gesture_stylus_new((widget is null) ? null : widget.getWidgetStruct());

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(GtkGestureStylus*) p, true);
	}

	/**
	 * Returns the current values for the requested @axes. This function
	 * must be called from either the #GtkGestureStylus:down,
	 * #GtkGestureStylus:motion, #GtkGestureStylus:up or #GtkGestureStylus:proximity
	 * signals.
	 *
	 * Params:
	 *     axes = array of requested axes, terminated with #GDK_AXIS_IGNORE
	 *     values = return location for the axis values
	 *
	 * Returns: #TRUE if there is a current value for the axes
	 *
	 * Since: 3.24
	 */
	public bool getAxes(GdkAxisUse[] axes, out double[] values)
	{
		double* outvalues = null;

		auto p = gtk_gesture_stylus_get_axes(gtkGestureStylus, axes.ptr, &outvalues) != 0;

		values = outvalues[0 .. getArrayLength(outvalues)];

		return p;
	}

	/**
	 * Returns the current value for the requested @axis. This function
	 * must be called from either the #GtkGestureStylus:down,
	 * #GtkGestureStylus:motion, #GtkGestureStylus:up or #GtkGestureStylus:proximity
	 * signals.
	 *
	 * Params:
	 *     axis = requested device axis
	 *     value = return location for the axis value
	 *
	 * Returns: #TRUE if there is a current value for the axis
	 *
	 * Since: 3.24
	 */
	public bool getAxis(GdkAxisUse axis, out double value)
	{
		return gtk_gesture_stylus_get_axis(gtkGestureStylus, axis, &value) != 0;
	}

	/**
	 * Returns the #GdkDeviceTool currently driving input through this gesture.
	 * This function must be called from either the #GtkGestureStylus::down,
	 * #GtkGestureStylus::motion, #GtkGestureStylus::up or #GtkGestureStylus::proximity
	 * signal handlers.
	 *
	 * Returns: The current stylus tool
	 *
	 * Since: 3.24
	 */
	public DeviceTool getDeviceTool()
	{
		auto p = gtk_gesture_stylus_get_device_tool(gtkGestureStylus);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(DeviceTool)(cast(GdkDeviceTool*) p);
	}

	/** */
	gulong addOnDown(void delegate(double, double, GestureStylus) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		return Signals.connect(this, "down", dlg, connectFlags ^ ConnectFlags.SWAPPED);
	}

	/** */
	gulong addOnMotion(void delegate(double, double, GestureStylus) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		return Signals.connect(this, "motion", dlg, connectFlags ^ ConnectFlags.SWAPPED);
	}

	/** */
	gulong addOnProximity(void delegate(double, double, GestureStylus) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		return Signals.connect(this, "proximity", dlg, connectFlags ^ ConnectFlags.SWAPPED);
	}

	/** */
	gulong addOnUp(void delegate(double, double, GestureStylus) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		return Signals.connect(this, "up", dlg, connectFlags ^ ConnectFlags.SWAPPED);
	}
}