src/atk/ValueAtk.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  = AtkValue.html
  26  * outPack = atk
  27  * outFile = ValueAtk
  28  * strct   = AtkValue
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = ValueAtk
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - atk_value_
  40  * omit structs:
  41  * omit prefixes:
  42  * omit code:
  43  * imports:
  44  *      - gobject.Value
  45  * structWrap:
  46  *      - GValue* -> Value
  47  * local aliases:
  48  */
  49
  50 module atk.ValueAtk;
  51
  52 private import atk.atktypes;
  53
  54 private import lib.atk;
  55
  56 private import gobject.Value;
  57
  58 /**
  59  * Description
  60  * AtkValue should be implemented for components which either display a
  61  * value from a bounded range, or which allow the user to specify a value
  62  * from a bounded range, or both. For instance, most sliders and range
  63  * controls, as well as dials, should have AtkObject representations which
  64  * implement AtkValue on the component's behalf. AtKValues may be
  65  * read-only, in which case attempts to alter the value return FALSE to
  66  * indicate failure.
  67  */
  68 public class ValueAtk
  69 {
  70
  71         /** the main Gtk struct */
  72         protected AtkValue* atkValue;
  73
  74
  75         public AtkValue* getValueAtkStruct()
  76         {
  77                 return atkValue;
  78         }
  79
  80
  81         /** the main Gtk struct as a void* */
  82         protected void* getStruct()
  83         {
  84                 return cast(void*)atkValue;
  85         }
  86
  87         /**
  88          * Sets our main struct and passes it to the parent class
  89          */
  90         public this (AtkValue* atkValue)
  91         {
  92                 this.atkValue = atkValue;
  93         }
  94
  95         /**
  96          */
  97
  98
  99         /**
 100          * Gets the value of this object.
 101          * obj:
 102          *  a GObject instance that implements AtkValueIface
 103          * value:
 104          *  a GValue representing the current accessible value
 105          */
 106         public void getCurrentValue(Value value)
 107         {
 108                 // void atk_value_get_current_value (AtkValue *obj,  GValue *value);
 109                 atk_value_get_current_value(atkValue, (value is null) ? null : value.getValueStruct());
 110         }
 111
 112         /**
 113          * Gets the maximum value of this object.
 114          * obj:
 115          *  a GObject instance that implements AtkValueIface
 116          * value:
 117          *  a GValue representing the maximum accessible value
 118          */
 119         public void getMaximumValue(Value value)
 120         {
 121                 // void atk_value_get_maximum_value (AtkValue *obj,  GValue *value);
 122                 atk_value_get_maximum_value(atkValue, (value is null) ? null : value.getValueStruct());
 123         }
 124
 125         /**
 126          * Gets the minimum value of this object.
 127          * obj:
 128          *  a GObject instance that implements AtkValueIface
 129          * value:
 130          *  a GValue representing the minimum accessible value
 131          */
 132         public void getMinimumValue(Value value)
 133         {
 134                 // void atk_value_get_minimum_value (AtkValue *obj,  GValue *value);
 135                 atk_value_get_minimum_value(atkValue, (value is null) ? null : value.getValueStruct());
 136         }
 137
 138         /**
 139          * Sets the value of this object.
 140          * obj:
 141          *  a GObject instance that implements AtkValueIface
 142          * value:
 143          *  a GValue which is the desired new accessible value.
 144          * Returns:
 145          *  TRUE if new value is successfully set, FALSE otherwise.
 146          */
 147         public int setCurrentValue(Value value)
 148         {
 149                 // gboolean atk_value_set_current_value (AtkValue *obj,  const GValue *value);
 150                 return atk_value_set_current_value(atkValue, (value is null) ? null : value.getValueStruct());
 151         }
 152
 153         /**
 154          * Gets the minimum increment by which the value of this object may be changed. If zero,
 155          * the minimum increment is undefined, which may mean that it is limited only by the
 156          * floating point precision of the platform.
 157          * obj:
 158          *  a GObject instance that implements AtkValueIface
 159          * value:
 160          *  a GValue representing the minimum increment by which the accessible value may be changed
 161          * Since ATK 1.12
 162          */
 163         public void getMinimumIncrement(Value value)
 164         {
 165                 // void atk_value_get_minimum_increment (AtkValue *obj,  GValue *value);
 166                 atk_value_get_minimum_increment(atkValue, (value is null) ? null : value.getValueStruct());
 167         }
 168 }