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.GesturePan; 26 27 private import glib.ConstructionException; 28 private import gobject.ObjectG; 29 private import gobject.Signals; 30 private import gtk.Gesture; 31 private import gtk.GestureDrag; 32 private import gtk.Widget; 33 private import gtk.c.functions; 34 public import gtk.c.types; 35 public import gtkc.gtktypes; 36 private import std.algorithm; 37 38 39 /** 40 * #GtkGesturePan is a #GtkGesture implementation able to recognize 41 * pan gestures, those are drags that are locked to happen along one 42 * axis. The axis that a #GtkGesturePan handles is defined at 43 * construct time, and can be changed through 44 * gtk_gesture_pan_set_orientation(). 45 * 46 * When the gesture starts to be recognized, #GtkGesturePan will 47 * attempt to determine as early as possible whether the sequence 48 * is moving in the expected direction, and denying the sequence if 49 * this does not happen. 50 * 51 * Once a panning gesture along the expected axis is recognized, 52 * the #GtkGesturePan::pan signal will be emitted as input events 53 * are received, containing the offset in the given axis. 54 */ 55 public class GesturePan : GestureDrag 56 { 57 /** the main Gtk struct */ 58 protected GtkGesturePan* gtkGesturePan; 59 60 /** Get the main Gtk struct */ 61 public GtkGesturePan* getGesturePanStruct(bool transferOwnership = false) 62 { 63 if (transferOwnership) 64 ownedRef = false; 65 return gtkGesturePan; 66 } 67 68 /** the main Gtk struct as a void* */ 69 protected override void* getStruct() 70 { 71 return cast(void*)gtkGesturePan; 72 } 73 74 /** 75 * Sets our main struct and passes it to the parent class. 76 */ 77 public this (GtkGesturePan* gtkGesturePan, bool ownedRef = false) 78 { 79 this.gtkGesturePan = gtkGesturePan; 80 super(cast(GtkGestureDrag*)gtkGesturePan, ownedRef); 81 } 82 83 84 /** */ 85 public static GType getType() 86 { 87 return gtk_gesture_pan_get_type(); 88 } 89 90 /** 91 * Returns a newly created #GtkGesture that recognizes pan gestures. 92 * 93 * Params: 94 * widget = a #GtkWidget 95 * orientation = expected orientation 96 * 97 * Returns: a newly created #GtkGesturePan 98 * 99 * Since: 3.14 100 * 101 * Throws: ConstructionException GTK+ fails to create the object. 102 */ 103 public this(Widget widget, GtkOrientation orientation) 104 { 105 auto p = gtk_gesture_pan_new((widget is null) ? null : widget.getWidgetStruct(), orientation); 106 107 if(p is null) 108 { 109 throw new ConstructionException("null returned by new"); 110 } 111 112 this(cast(GtkGesturePan*) p, true); 113 } 114 115 /** 116 * Returns the orientation of the pan gestures that this @gesture expects. 117 * 118 * Returns: the expected orientation for pan gestures 119 * 120 * Since: 3.14 121 */ 122 public GtkOrientation getOrientation() 123 { 124 return gtk_gesture_pan_get_orientation(gtkGesturePan); 125 } 126 127 /** 128 * Sets the orientation to be expected on pan gestures. 129 * 130 * Params: 131 * orientation = expected orientation 132 * 133 * Since: 3.14 134 */ 135 public void setOrientation(GtkOrientation orientation) 136 { 137 gtk_gesture_pan_set_orientation(gtkGesturePan, orientation); 138 } 139 140 /** 141 * This signal is emitted once a panning gesture along the 142 * expected axis is detected. 143 * 144 * Params: 145 * direction = current direction of the pan gesture 146 * offset = Offset along the gesture orientation 147 * 148 * Since: 3.14 149 */ 150 gulong addOnPan(void delegate(GtkPanDirection, double, GesturePan) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 151 { 152 return Signals.connect(this, "pan", dlg, connectFlags ^ ConnectFlags.SWAPPED); 153 } 154 }