AccessibleApplication API

AccessibleApplication API —

Synopsis




void        AccessibleApplication_ref       (AccessibleApplication *obj);
void        AccessibleApplication_unref     (AccessibleApplication *obj);
char*       AccessibleApplication_getToolkitName
                                            (AccessibleApplication *obj);
char*       AccessibleApplication_getVersion
                                            (AccessibleApplication *obj);
long        AccessibleApplication_getID     (AccessibleApplication *obj);
SPIBoolean  AccessibleApplication_pause     (AccessibleApplication *obj);
SPIBoolean  AccessibleApplication_resume    (AccessibleApplication *obj);

Description

Details

AccessibleApplication_ref ()

void        AccessibleApplication_ref       (AccessibleApplication *obj);

Increment the reference count for an AccessibleApplication.

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

AccessibleApplication_unref ()

void        AccessibleApplication_unref     (AccessibleApplication *obj);

Decrement the reference count for an AccessibleApplication.

obj : a pointer to the AccessibleApplication object on which to operate.

AccessibleApplication_getToolkitName ()

char*       AccessibleApplication_getToolkitName
                                            (AccessibleApplication *obj);

Get the name of the UI toolkit used by an AccessibleApplication.

obj : a pointer to the AccessibleApplication to query.
Returns : a UTF-8 string indicating which UI toolkit is used by an application.

AccessibleApplication_getVersion ()

char*       AccessibleApplication_getVersion
                                            (AccessibleApplication *obj);

Get the version of the at-spi bridge exported by an AccessibleApplication instance.

obj : a pointer to the AccessibleApplication being queried.
Returns : a UTF-8 string indicating the application's at-spi version.

AccessibleApplication_getID ()

long        AccessibleApplication_getID     (AccessibleApplication *obj);

Get the unique ID assigned by the Registry to an AccessibleApplication instance. (Not Yet Implemented by the registry).

obj : a pointer to the AccessibleApplication being queried.
Returns : a unique long integer associated with the application by the Registry, or 0 if the application is not registered.

AccessibleApplication_pause ()

SPIBoolean  AccessibleApplication_pause     (AccessibleApplication *obj);

Attempt to pause the application (used when client event queue is over-full). Not Yet Implemented.

obj : a pointer to the Accessible object on which to operate.
Returns : TRUE if the application was paused successfully, FALSE otherwise.

AccessibleApplication_resume ()

SPIBoolean  AccessibleApplication_resume    (AccessibleApplication *obj);

Attempt to resume the application (used after AccessibleApplication_pause). Not Yet Implemented.

obj : a pointer to the Accessible object on which to operate.
Returns : TRUE if application processing resumed successfully, FALSE otherwise.