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.GestureZoom;
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.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  * #GtkGestureZoom is a #GtkGesture implementation able to recognize
40  * pinch/zoom gestures, whenever the distance between both tracked
41  * sequences changes, the #GtkGestureZoom::scale-changed signal is
42  * emitted to report the scale factor.
43  */
44 public class GestureZoom : Gesture
45 {
46 	/** the main Gtk struct */
47 	protected GtkGestureZoom* gtkGestureZoom;
48 
49 	/** Get the main Gtk struct */
50 	public GtkGestureZoom* getGestureZoomStruct(bool transferOwnership = false)
51 	{
52 		if (transferOwnership)
53 			ownedRef = false;
54 		return gtkGestureZoom;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)gtkGestureZoom;
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (GtkGestureZoom* gtkGestureZoom, bool ownedRef = false)
67 	{
68 		this.gtkGestureZoom = gtkGestureZoom;
69 		super(cast(GtkGesture*)gtkGestureZoom, ownedRef);
70 	}
71 
72 
73 	/** */
74 	public static GType getType()
75 	{
76 		return gtk_gesture_zoom_get_type();
77 	}
78 
79 	/**
80 	 * Returns a newly created #GtkGesture that recognizes zoom
81 	 * in/out gestures (usually known as pinch/zoom).
82 	 *
83 	 * Params:
84 	 *     widget = a #GtkWidget
85 	 *
86 	 * Returns: a newly created #GtkGestureZoom
87 	 *
88 	 * Since: 3.14
89 	 *
90 	 * Throws: ConstructionException GTK+ fails to create the object.
91 	 */
92 	public this(Widget widget)
93 	{
94 		auto p = gtk_gesture_zoom_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(GtkGestureZoom*) p, true);
102 	}
103 
104 	/**
105 	 * If @gesture is active, this function returns the zooming difference
106 	 * since the gesture was recognized (hence the starting point is
107 	 * considered 1:1). If @gesture is not active, 1 is returned.
108 	 *
109 	 * Returns: the scale delta
110 	 *
111 	 * Since: 3.14
112 	 */
113 	public double getScaleDelta()
114 	{
115 		return gtk_gesture_zoom_get_scale_delta(gtkGestureZoom);
116 	}
117 
118 	/**
119 	 * This signal is emitted whenever the distance between both tracked
120 	 * sequences changes.
121 	 *
122 	 * Params:
123 	 *     scale = Scale delta, taking the initial state as 1:1
124 	 *
125 	 * Since: 3.14
126 	 */
127 	gulong addOnScaleChanged(void delegate(double, GestureZoom) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
128 	{
129 		return Signals.connect(this, "scale-changed", dlg, connectFlags ^ ConnectFlags.SWAPPED);
130 	}
131 }