Next: , Previous: AtkUtil, Up: Top


25 AtkValue

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

25.1 Overview

<atk-value> 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 <atk-object> representations which implement <atk-value> on the component's behalf. <at-kvalues> may be read-only, in which case attempts to alter the value return FALSE to indicate failure.

25.2 Usage

— Class: <atk-value>

Derives from <ginterface>.

This class defines no direct slots.

— Function: atk-value-get-current-value (self <atk-value>) (value <gvalue>)
— Method: get-current-value

Gets the value of this object.

obj
a GObject instance that implements AtkValueIface
value
a <gvalue> representing the current accessible value
— Function: atk-value-get-maximum-value (self <atk-value>) (value <gvalue>)
— Method: get-maximum-value

Gets the maximum value of this object.

obj
a GObject instance that implements AtkValueIface
value
a <gvalue> representing the maximum accessible value
— Function: atk-value-get-minimum-value (self <atk-value>) (value <gvalue>)
— Method: get-minimum-value

Gets the minimum value of this object.

obj
a GObject instance that implements AtkValueIface
value
a <gvalue> representing the minimum accessible value
— Function: atk-value-set-current-value (self <atk-value>) (value <gvalue>) ⇒  (ret bool)
— Method: set-current-value

Sets the value of this object.

obj
a GObject instance that implements AtkValueIface
value
a <gvalue> which is the desired new accessible value.
ret
#t’ if new value is successfully set, ‘#f’ otherwise.
— Function: atk-value-get-minimum-increment (self <atk-value>) (value <gvalue>)
— Method: get-minimum-increment

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