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