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.VScale;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Adjustment;
30 private import gtk.Scale;
31 private import gtk.Widget;
32 private import gtk.c.functions;
33 public  import gtk.c.types;
34 public  import gtkc.gtktypes;
35 
36 
37 /**
38  * The #GtkVScale widget is used to allow the user to select a value using
39  * a vertical slider. To create one, use gtk_hscale_new_with_range().
40  * 
41  * The position to show the current value, and the number of decimal places
42  * shown can be set using the parent #GtkScale class’s functions.
43  * 
44  * GtkVScale has been deprecated, use #GtkScale instead.
45  */
46 public class VScale : Scale
47 {
48 	/** the main Gtk struct */
49 	protected GtkVScale* gtkVScale;
50 
51 	/** Get the main Gtk struct */
52 	public GtkVScale* getVScaleStruct(bool transferOwnership = false)
53 	{
54 		if (transferOwnership)
55 			ownedRef = false;
56 		return gtkVScale;
57 	}
58 
59 	/** the main Gtk struct as a void* */
60 	protected override void* getStruct()
61 	{
62 		return cast(void*)gtkVScale;
63 	}
64 
65 	protected override void setStruct(GObject* obj)
66 	{
67 		gtkVScale = cast(GtkVScale*)obj;
68 		super.setStruct(obj);
69 	}
70 
71 	/**
72 	 * Sets our main struct and passes it to the parent class.
73 	 */
74 	public this (GtkVScale* gtkVScale, bool ownedRef = false)
75 	{
76 		this.gtkVScale = gtkVScale;
77 		super(cast(GtkScale*)gtkVScale, ownedRef);
78 	}
79 
80 
81 	/** */
82 	public static GType getType()
83 	{
84 		return gtk_vscale_get_type();
85 	}
86 
87 	/**
88 	 * Creates a new #GtkVScale.
89 	 *
90 	 * Deprecated: Use gtk_scale_new() with %GTK_ORIENTATION_VERTICAL instead
91 	 *
92 	 * Params:
93 	 *     adjustment = the #GtkAdjustment which sets the range of the scale.
94 	 *
95 	 * Returns: a new #GtkVScale.
96 	 *
97 	 * Throws: ConstructionException GTK+ fails to create the object.
98 	 */
99 	public this(Adjustment adjustment)
100 	{
101 		auto p = gtk_vscale_new((adjustment is null) ? null : adjustment.getAdjustmentStruct());
102 
103 		if(p is null)
104 		{
105 			throw new ConstructionException("null returned by new");
106 		}
107 
108 		this(cast(GtkVScale*) p);
109 	}
110 
111 	/**
112 	 * Creates a new vertical scale widget that lets the user input a
113 	 * number between @min and @max (including @min and @max) with the
114 	 * increment @step.  @step must be nonzero; it’s the distance the
115 	 * slider moves when using the arrow keys to adjust the scale value.
116 	 *
117 	 * Note that the way in which the precision is derived works best if @step
118 	 * is a power of ten. If the resulting precision is not suitable for your
119 	 * needs, use gtk_scale_set_digits() to correct it.
120 	 *
121 	 * Deprecated: Use gtk_scale_new_with_range() with %GTK_ORIENTATION_VERTICAL instead
122 	 *
123 	 * Params:
124 	 *     min = minimum value
125 	 *     max = maximum value
126 	 *     step = step increment (tick size) used with keyboard shortcuts
127 	 *
128 	 * Returns: a new #GtkVScale
129 	 *
130 	 * Throws: ConstructionException GTK+ fails to create the object.
131 	 */
132 	public this(double min, double max, double step)
133 	{
134 		auto p = gtk_vscale_new_with_range(min, max, step);
135 
136 		if(p is null)
137 		{
138 			throw new ConstructionException("null returned by new_with_range");
139 		}
140 
141 		this(cast(GtkVScale*) p);
142 	}
143 }