gtkD/src/gtk/VScale.d

   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 as published by
   6  * the Free Software Foundation; either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * gtkD is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with gtkD; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 // generated automatically - do not change
  20 // find conversion definition on APILookup.txt
  21 // implement new conversion functionalities on the wrap.utils pakage
  22
  23 /*
  24  * Conversion parameters:
  25  * inFile  = GtkVScale.html
  26  * outPack = gtk
  27  * outFile = VScale
  28  * strct   = GtkVScale
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = VScale
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - gtk_vscale_
  40  *      - gtk_
  41  * omit structs:
  42  * omit prefixes:
  43  * omit code:
  44  * imports:
  45  *      - gtk.Adjustment
  46  * structWrap:
  47  *      - GtkAdjustment* -> Adjustment
  48  * module aliases:
  49  * local aliases:
  50  */
  51
  52 module gtk.VScale;
  53
  54 version(noAssert)
  55 {
  56         version(Tango)
  57         {
  58                 import tango.io.Stdout; // use the tango loging?
  59         }
  60 }
  61
  62 private import gtkc.gtktypes;
  63
  64 private import gtkc.gtk;
  65
  66
  67 private import gtk.Adjustment;
  68
  69
  70
  71
  72 /**
  73  * Description
  74  * The GtkVScale widget is used to allow the user to select a value using
  75  * a vertical slider. To create one, use gtk_hscale_new_with_range().
  76  * The position to show the current value, and the number of decimal places
  77  * shown can be set using the parent GtkScale class's functions.
  78  */
  79 private import gtk.Scale;
  80 public class VScale : Scale
  81 {
  82
  83         /** the main Gtk struct */
  84         protected GtkVScale* gtkVScale;
  85
  86
  87         public GtkVScale* getVScaleStruct()
  88         {
  89                 return gtkVScale;
  90         }
  91
  92
  93         /** the main Gtk struct as a void* */
  94         protected void* getStruct()
  95         {
  96                 return cast(void*)gtkVScale;
  97         }
  98
  99         /**
 100          * Sets our main struct and passes it to the parent class
 101          */
 102         public this (GtkVScale* gtkVScale)
 103         {
 104                 version(noAssert)
 105                 {
 106                         if ( gtkVScale is null )
 107                         {
 108                                 int zero = 0;
 109                                 version(Tango)
 110                                 {
 111                                         Stdout("struct gtkVScale is null on constructor").newline;
 112                                 }
 113                                 else
 114                                 {
 115                                         printf("struct gtkVScale is null on constructor");
 116                                 }
 117                                 zero = zero / zero;
 118                         }
 119                 }
 120                 else
 121                 {
 122                         assert(gtkVScale !is null, "struct gtkVScale is null on constructor");
 123                 }
 124                 super(cast(GtkScale*)gtkVScale);
 125                 this.gtkVScale = gtkVScale;
 126         }
 127
 128         /**
 129          */
 130
 131
 132         /**
 133          * Creates a new GtkVScale.
 134          * adjustment:
 135          * the GtkAdjustment which sets the range of the scale.
 136          * Returns:
 137          * a new GtkVScale.
 138          */
 139         public this (Adjustment adjustment)
 140         {
 141                 // GtkWidget* gtk_vscale_new (GtkAdjustment *adjustment);
 142                 this(cast(GtkVScale*)gtk_vscale_new((adjustment is null) ? null : adjustment.getAdjustmentStruct()) );
 143         }
 144
 145         /**
 146          * Creates a new vertical scale widget that lets the user input a
 147          * number between min and max (including min and max) with the
 148          * increment step. step must be nonzero; it's the distance the
 149          * slider moves when using the arrow keys to adjust the scale value.
 150          * Note that the way in which the precision is derived works best if step
 151          * is a power of ten. If the resulting precision is not suitable for your
 152          * needs, use gtk_scale_set_digits() to correct it.
 153          * min:
 154          *  minimum value
 155          * max:
 156          *  maximum value
 157          * step:
 158          *  step increment (tick size) used with keyboard shortcuts
 159          * Returns:
 160          *  a new GtkVScale
 161          */
 162         public this (double min, double max, double step)
 163         {
 164                 // GtkWidget* gtk_vscale_new_with_range (gdouble min,  gdouble max,  gdouble step);
 165                 this(cast(GtkVScale*)gtk_vscale_new_with_range(min, max, step) );
 166         }
 167 }