docs/tmpl/atkvalue.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkValue
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The ATK interface implemented by valuators and components which display or
   6 select a value from a bounded range of values.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 #AtkValue should be implemented for components which either display a
  11 value from a bounded range, or which allow the user to specify a value
  12 from a bounded range, or both.  For instance, most sliders and range
  13 controls, as well as dials, should have #AtkObject representations which
  14 implement #AtkValue on the component's behalf.  #AtKValues may be
  15 read-only, in which case attempts to alter the value return FALSE to
  16 indicate failure.
  17 </para>
  18
  19 <!-- ##### SECTION See_Also ##### -->
  20 <para>
  21
  22 </para>
  23
  24 <!-- ##### STRUCT AtkValue ##### -->
  25 <para>
  26 The AtkValue structure does not contain any fields.
  27
  28 </para>
  29
  30
  31 <!-- ##### FUNCTION atk_value_get_current_value ##### -->
  32 <para>
  33
  34 </para>
  35
  36 @obj:
  37 @value:
  38
  39
  40 <!-- ##### FUNCTION atk_value_get_maximum_value ##### -->
  41 <para>
  42
  43 </para>
  44
  45 @obj:
  46 @value:
  47
  48
  49 <!-- ##### FUNCTION atk_value_get_minimum_value ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @obj:
  55 @value:
  56
  57
  58 <!-- ##### FUNCTION atk_value_set_current_value ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @obj:
  64 @value:
  65 @Returns:
  66
  67