gdk.PadEvent 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 gdk.PadEvent;
26 
27 private import gdk.Event;
28 private import gdk.c.functions;
29 public  import gdk.c.types;
30 
31 
32 /**
33  * An event related to a pad-based device.
34  */
35 public class PadEvent : Event
36 {
37 	/** the main Gtk struct */
38 	protected GdkPadEvent* gdkPadEvent;
39 
40 	/** Get the main Gtk struct */
41 	public GdkPadEvent* getPadEventStruct(bool transferOwnership = false)
42 	{
43 		if (transferOwnership)
44 			ownedRef = false;
45 		return gdkPadEvent;
46 	}
47 
48 	/** the main Gtk struct as a void* */
49 	protected override void* getStruct()
50 	{
51 		return cast(void*)gdkPadEvent;
52 	}
53 
54 	/**
55 	 * Sets our main struct and passes it to the parent class.
56 	 */
57 	public this (GdkPadEvent* gdkPadEvent, bool ownedRef = false)
58 	{
59 		this.gdkPadEvent = gdkPadEvent;
60 		super(cast(GdkEvent*)gdkPadEvent, ownedRef);
61 	}
62 
63 
64 	/** */
65 	public static GType getType()
66 	{
67 		return gdk_pad_event_get_type();
68 	}
69 
70 	/**
71 	 * Extracts the information from a pad strip or ring event.
72 	 *
73 	 * Params:
74 	 *     index = Return location for the axis index
75 	 *     value = Return location for the axis value
76 	 */
77 	public void getAxisValue(out uint index, out double value)
78 	{
79 		gdk_pad_event_get_axis_value(cast(GdkEvent*)gdkPadEvent, &index, &value);
80 	}
81 
82 	/**
83 	 * Extracts information about the pressed button from
84 	 * a pad event.
85 	 *
86 	 * Returns: the button of @event
87 	 */
88 	public uint getButton()
89 	{
90 		return gdk_pad_event_get_button(cast(GdkEvent*)gdkPadEvent);
91 	}
92 
93 	/**
94 	 * Extracts group and mode information from a pad event.
95 	 *
96 	 * Params:
97 	 *     group = return location for the group
98 	 *     mode = return location for the mode
99 	 */
100 	public void getGroupMode(out uint group, out uint mode)
101 	{
102 		gdk_pad_event_get_group_mode(cast(GdkEvent*)gdkPadEvent, &group, &mode);
103 	}
104 }