AtkValue

AtkValue — The ATK interface implemented by valuators and components which display or select a value from a bounded range of values.

Synopsis

                    AtkValue;
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);
void                atk_value_get_minimum_increment     (AtkValue *obj,
                                                         GValue *value);

Object Hierarchy

  GInterface
   +----AtkValue

Known Implementations

AtkValue is implemented by AtkNoOpObject.

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

AtkValue

typedef struct _AtkValue AtkValue;

The AtkValue structure does not contain any fields.

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.

atk_value_get_minimum_increment ()

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

Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform.

obj :

 a GObject instance that implements AtkValueIface

value :

 a GValue representing the minimum increment by which the accessible value may be changed

Since ATK 1.12

Generated by GTK-Doc V1.10