src/gtk/VScale.d

   1 /*
   2  * This file is part of duit.
   3  *
   4  * duit 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  * duit 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 duit; 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  * local aliases:
  49  */
  50
  51 module gtk.VScale;
  52
  53 private import gtk.gtktypes;
  54
  55 private import lib.gtk;
  56
  57 private import gtk.Adjustment;
  58
  59 /**
  60  * Description
  61  * The GtkVScale widget is used to allow the user to select a value using
  62  * a vertical slider. To create one, use gtk_hscale_new_with_range().
  63  * The position to show the current value, and the number of decimal places
  64  * shown can be set using the parent GtkScale class's functions.
  65  */
  66 private import gtk.Scale;
  67 public class VScale : Scale
  68 {
  69
  70         /** the main Gtk struct */
  71         protected GtkVScale* gtkVScale;
  72
  73
  74         public GtkVScale* getVScaleStruct()
  75         {
  76                 return gtkVScale;
  77         }
  78
  79
  80         /** the main Gtk struct as a void* */
  81         protected void* getStruct()
  82         {
  83                 return cast(void*)gtkVScale;
  84         }
  85
  86         /**
  87          * Sets our main struct and passes it to the parent class
  88          */
  89         public this (GtkVScale* gtkVScale)
  90         {
  91                 super(cast(GtkScale*)gtkVScale);
  92                 this.gtkVScale = gtkVScale;
  93         }
  94
  95         /**
  96          */
  97
  98
  99         /**
 100          * Creates a new GtkVScale.
 101          * adjustment:
 102          * the GtkAdjustment which sets the range of the scale.
 103          * Returns:
 104          * a new GtkVScale.
 105          */
 106         public this (Adjustment adjustment)
 107         {
 108                 // GtkWidget* gtk_vscale_new (GtkAdjustment *adjustment);
 109                 this(cast(GtkVScale*)gtk_vscale_new((adjustment is null) ? null : adjustment.getAdjustmentStruct()) );
 110         }
 111
 112         /**
 113          * Creates a new vertical scale widget that lets the user input a
 114          * number between min and max (including min and max) with the
 115          * increment step. step must be nonzero; it's the distance the
 116          * slider moves when using the arrow keys to adjust the scale value.
 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          * min:
 121          *  minimum value
 122          * max:
 123          *  maximum value
 124          * step:
 125          *  step increment (tick size) used with keyboard shortcuts
 126          * Returns:
 127          *  a new GtkVScale
 128          */
 129         public this (double min, double max, double step)
 130         {
 131                 // GtkWidget* gtk_vscale_new_with_range (gdouble min,  gdouble max,  gdouble step);
 132                 this(cast(GtkVScale*)gtk_vscale_new_with_range(min, max, step) );
 133         }
 134 }