AccessibleAction Interface

AT-SPI C Bindings Reference Manual
<<< Previous Page	Home	Up	Next Page >>>

Details

int         AccessibleAction_ref            (AccessibleAction *obj);

Increment the reference count for an AccessibleAction.

`obj` :	a pointer to the AccessibleAction on which to operate.
Returns :	0 (no return code implemented yet).

int         AccessibleAction_unref          (AccessibleAction *obj);

Decrement the reference count for an AccessibleAction.

`obj` :	a pointer to the AccessibleAction on which to operate.
Returns :	0 (no return code implemented yet).

long        AccessibleAction_getNActions    (AccessibleAction *obj);

Get the number of actions invokable on an AccessibleAction implementor.

`obj` :	a pointer to the AccessibleAction to query.
Returns :	a long integer indicatin the number of invokable actions.

boolean     AccessibleAction_doAction       (AccessibleAction *obj,
                                             long int i);

Invoke the action indicated by index.

`obj` :	a pointer to the AccessibleAction to query.
`i` :	an integer specifying which action to invoke.
Returns :	TRUE if the action is successfully invoked, otherwise FALSE.

char*       AccessibleAction_getKeyBinding  (AccessibleAction *obj,
                                             long int i);

Get the keybindings for the i-th action invokable on an object implementing AccessibleAction, if any are defined.

`obj` :	a pointer to the AccessibleAction implementor to query.
`i` :	a long integer indicating which action to query.
Returns :	a UTF-8 string which can be parsed to determine the `i`-th invokable action's keybindings.

char*       AccessibleAction_getName        (AccessibleAction *obj,
                                             long int i);

Get the name of the 'i-th' action invokable on an object implementing AccessibleAction.

`obj` :	a pointer to the AccessibleAction implementor to query.
`i` :	a long integer indicating which action to query.
Returns :	the 'event type' name of the action, as a UTF-8 string.

char*       AccessibleAction_getDescription (AccessibleAction *obj,
                                             long int i);

Get the description of 'i-th' action invokable on an object implementing AccessibleAction.

`obj` :	a pointer to the AccessibleAction implementor to query.
`i` :	a long integer indicating which action to query.
Returns :	a UTF-8 string describing the '`i`-th' invokable action.