AT-SPI C Bindings Reference Manual
<<< Previous PageHomeUpNext Page >>>

AccessibleAction Interface

Name

AccessibleAction Interface -- 

Synopsis



void        AccessibleAction_ref            (AccessibleAction *obj);
void        AccessibleAction_unref          (AccessibleAction *obj);
long        AccessibleAction_getNActions    (AccessibleAction *obj);
SPIBoolean  AccessibleAction_doAction       (AccessibleAction *obj,
                                             long int i);
char*       AccessibleAction_getKeyBinding  (AccessibleAction *obj,
                                             long int i);
char*       AccessibleAction_getName        (AccessibleAction *obj,
                                             long int i);
char*       AccessibleAction_getDescription (AccessibleAction *obj,
                                             long int i);

Description

Details

AccessibleAction_ref ()

void        AccessibleAction_ref            (AccessibleAction *obj);

Increment the reference count for an AccessibleAction.

obj : a pointer to the AccessibleAction on which to operate.

AccessibleAction_unref ()

void        AccessibleAction_unref          (AccessibleAction *obj);

Decrement the reference count for an AccessibleAction.

obj : a pointer to the AccessibleAction on which to operate.

AccessibleAction_getNActions ()

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.

AccessibleAction_doAction ()

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

Invoke the action indicated by index.

obj : a pointer to the AccessibleAction to query.
Returns : TRUE if the action is successfully invoked, otherwise FALSE.

AccessibleAction_getKeyBinding ()

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.
Returns : a UTF-8 string which can be parsed to determine the i-th invokable action's keybindings.

AccessibleAction_getName ()

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.
Returns : the 'event type' name of the action, as a UTF-8 string.

AccessibleAction_getDescription ()

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.
Returns : a UTF-8 string describing the 'i-th' invokable action.



<<< Previous PageHomeUpNext Page >>>
Subinterface MethodsAccessibleComponent Interface