AtkValue

Name

AtkValue -- the standard mechanism for an assistive technology to determine and set numerical values as well as get minimum and maximum 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

The AtkValue interface should be supported by any object that supports a numerical value (e.g., a scroll bar). This interface provides the standard mechanism for an assistive technology to determine and set the numerical value as well as get the minimum and maximum values.

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);

};


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.