AccessibleValue Interface: AT-SPI C Bindings Reference Manual

AccessibleValue Interface

Functions

void	AccessibleValue_ref ()
void	AccessibleValue_unref ()
double	AccessibleValue_getCurrentValue ()
double	AccessibleValue_getMaximumValue ()
double	AccessibleValue_getMinimumValue ()
SPIBoolean	AccessibleValue_setCurrentValue ()
double	AccessibleValue_getMinimumIncrement ()

Description

Functions

AccessibleValue_ref ()

void
AccessibleValue_ref (AccessibleValue *obj);

Increment the reference count for an AccessibleValue object.

Parameters

obj

a pointer to the AccessibleValue implementor on which to operate.

AccessibleValue_unref ()

void
AccessibleValue_unref (AccessibleValue *obj);

Decrement the reference count for an AccessibleValue object.

Parameters

obj

a pointer to the AccessibleValue implementor on which to operate.

AccessibleValue_getCurrentValue ()

double
AccessibleValue_getCurrentValue (AccessibleValue *obj);

Get the current value for an AccessibleValue.

Parameters

obj

a pointer to the AccessibleValue implementor on which to operate.

Returns

the current value for this object.

AccessibleValue_getMaximumValue ()

double
AccessibleValue_getMaximumValue (AccessibleValue *obj);

Get the maximum allowed value for an AccessibleValue.

Parameters

obj

a pointer to the AccessibleValue implementor on which to operate.

Returns

the maximum allowed value for this object.

AccessibleValue_getMinimumValue ()

double
AccessibleValue_getMinimumValue (AccessibleValue *obj);

Get the minimum allowed value for an AccessibleValue.

Parameters

obj

a pointer to the AccessibleValue implementor on which to operate.

Returns

the minimum allowed value for this object.

AccessibleValue_setCurrentValue ()

SPIBoolean
AccessibleValue_setCurrentValue (AccessibleValue *obj,
                                 double newValue);

Set the current value of an AccessibleValue.

Parameters

obj	a pointer to the AccessibleValue implementor on which to operate.
newValue	a float value which is the desired new value of the object.

Returns

TRUE if the value could be assigned the specified value, FALSE otherwise.

AccessibleValue_getMinimumIncrement ()

double
AccessibleValue_getMinimumIncrement (AccessibleValue *obj);

Get the minimum increment by which an AccessibleValue can be adjusted.

Parameters

obj

a pointer to the AccessibleValue implementor on which to operate.

Returns

the minimum increment by which the value may be changed, or zero if the minimum increment cannot be determined.