docs/tmpl/atkvalue.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkValue
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 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
  27 </para>
  28
  29
  30 <!-- ##### STRUCT AtkValueIface ##### -->
  31 <para>
  32
  33 </para>
  34
  35 @parent:
  36 @get_current_value:
  37 @get_maximum_value:
  38 @get_minimum_value:
  39 @set_current_value:
  40 @pad1:
  41 @pad2:
  42
  43 <!-- ##### FUNCTION atk_value_get_current_value ##### -->
  44 <para>
  45
  46 </para>
  47
  48 @obj:
  49 @value:
  50
  51
  52 <!-- ##### FUNCTION atk_value_get_maximum_value ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @obj:
  58 @value:
  59
  60
  61 <!-- ##### FUNCTION atk_value_get_minimum_value ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @obj:
  67 @value:
  68
  69
  70 <!-- ##### FUNCTION atk_value_set_current_value ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @obj:
  76 @value:
  77 @Returns:
  78
  79