ATK Library Reference Manual
<<< Previous PageHomeUp 

AtkValue

Name

AtkValue -- ATK Interface implemented by valuators and components which display or select a value from a bounded range of values.

Synopsis



struct      AtkValue;
struct      AtkValueIface;
void        atk_value_get_current_value     (AtkValue *obj,
                                             GValue *value);
void        atk_value_get_maximum_value     (AtkValue *obj,
                                             GValue *value);
void        atk_value_get_minimum_value     (AtkValue *obj,
                                             GValue *value);
gboolean    atk_value_set_current_value     (AtkValue *obj,
                                             const GValue *value);

Description

AtkValue should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have AtkObject representations which implement AtkValue on the component's behalf. AtKValues may be read-only, in which case attempts to alter the value return FALSE to indicate failure.

Details

struct AtkValue

struct AtkValue;

struct AtkValueIface

struct AtkValueIface
{
  GTypeInterface parent;

  void     (* get_current_value) (AtkValue     *obj,
                                  GValue       *value);
  void     (* get_maximum_value) (AtkValue     *obj,
                                  GValue       *value);
  void     (* get_minimum_value) (AtkValue     *obj,
                                  GValue       *value);
  gboolean (* set_current_value) (AtkValue     *obj,
                                  const GValue *value);

  AtkFunction pad1;
  AtkFunction pad2;
};

atk_value_get_current_value ()

void        atk_value_get_current_value     (AtkValue *obj,
                                             GValue *value);

Gets the value of this object.

obj : a GObject instance that implements AtkValueIface
value : a GValue representing the current accessible value

atk_value_get_maximum_value ()

void        atk_value_get_maximum_value     (AtkValue *obj,
                                             GValue *value);

Gets the maximum value of this object.

obj : a GObject instance that implements AtkValueIface
value : a GValue representing the maximum accessible value

atk_value_get_minimum_value ()

void        atk_value_get_minimum_value     (AtkValue *obj,
                                             GValue *value);

Gets the minimum value of this object.

obj : a GObject instance that implements AtkValueIface
value : a GValue representing the minimum accessible value

atk_value_set_current_value ()

gboolean    atk_value_set_current_value     (AtkValue *obj,
                                             const GValue *value);

Sets the value of this object.

obj : a GObject instance that implements AtkValueIface
value : a GValue which is the desired new accessible value.
Returns : TRUE if new value is successfully set, FALSE otherwise.



<<< Previous PageHomeUp 
AtkUtil