Top | ![]() |
![]() |
![]() |
![]() |
void (*AccessibleEventListenerCB) (const AccessibleEvent *event
,void *user_data
);
A function prototype for callbacks via which clients are notified of AT-SPI events.
This is a function which is specified when creating a EventListener. It is called when an event being listened for occurs.
AccessibleApplication *
AccessibleEvent_getSourceApplication (const AccessibleEvent *e
);
Get the Application hosting the object which emitted the event.
SPIBoolean AccessibleEvent_getSourceDetails (const AccessibleEvent *e
,char **name
,AccessibleRole *role
,AccessibleApplication **app
);
Get the host Application, "accessible name", and AccessibleRole of the object which emitted the event.
e |
an AccessibleEvent to be queried. |
|
name |
a pointer to a character string which will point to the name of the event source on successful completion of the call. |
|
role |
a pointer to an AccessibleRole which will point to the role of the event source on successful completion of the call. |
|
app |
A pointer to an AccessibleApplication which points to the host application for this event on successful completion of the call. |
char *
AccessibleEvent_getSourceName (const AccessibleEvent *e
);
Get the 'accessible-name' of the object emitting the event.
AccessibleRole
AccessibleEvent_getSourceRole (const AccessibleEvent *e
);
Get the AccessibleRole of the object emitting the event.
AccessibleRole of the event source, or SPI_ROLE_UNKNOWN if the event source's role is unknown or unspecified. (Some kinds of events, such as 'mouse:' events or toolkit events, don't have associated object roles.)
SPIBoolean
AccessibleEvent_ref (const AccessibleEvent *e
);
Increments by 1 the reference count of the event
void
AccessibleEvent_unref (const AccessibleEvent *e
);
Decrements by 1 the reference count of the event. The event is destroyed when the reference count recahes zero.
AccessibleEventListener * SPI_createAccessibleEventListener (AccessibleEventListenerCB callback
,void *user_data
);
Create a new AccessibleEventListener with a specified (in-process) callback function.
callback |
an AccessibleEventListenerCB callback function, or NULL. |
|
user_data |
a pointer to data which will be passed to the callback when invoked. |
void
AccessibleEventListener_unref (AccessibleEventListener *listener
);
Decrements an AccessibleEventListener's reference count.
SPIBoolean AccessibleEventListener_addCallback (AccessibleEventListener *listener
,AccessibleEventListenerCB callback
,void *user_data
);
Add an in-process callback function to an existing AccessibleEventListener.
Note that the callback function must live in the same address
space as the AccessibleEventListener implementation code, thus one should not
use this function to attach callbacks to a 'remote' event listener
(that is, one that was not created by a client call to
createAccessibleEventListener()
;
listener |
the AccessibleEventListener instance to modify. |
|
callback |
an AccessibleEventListenerCB function pointer. |
|
user_data |
a pointer to data which will be passed to the callback when invoked. |
SPIBoolean AccessibleEventListener_removeCallback (AccessibleEventListener *listener
,AccessibleEventListenerCB callback
);
Remove an in-process callback function from an existing AccessibleEventListener.
listener |
the AccessibleEventListener instance to modify. |
|
callback |
an AccessibleEventListenerCB function pointer. |
Accessible *
AccessibleActiveDescendantChangedEvent_getActiveDescendant
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:active-descendant-changed"
to get a reference to the changed Accessible.
Note that context Accessibles are not guaranteed to outlive
event delivery, in which case this call may return NULL
even if the object existed at the time of dispatch.
Accessible *
AccessibleChildChangedEvent_getChildAccessible
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:children_changed"
to get a reference to the changed Accessible.
Note that context Accessibles are not guaranteed to outlive
event delivery, in which case this call may return NULL
even if the object existed at the time of dispatch.
the context Accessible for the event, or NULL
if
there is no longer a valid context Accessible
object for the event.
char *
AccessibleDescriptionChangedEvent_getDescriptionString
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:property-changed:accessible-description" returning the new description.
char *
AccessibleNameChangedEvent_getNameString
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:property-change:accessible_name:", returning the name.
Accessible *
AccessibleParentChangedEvent_getParentAccessible
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:property-change:accessible-parent"
to get a reference to the changed Accessible.
Note that context Accessibles are not guaranteed to outlive
event delivery, in which case this call may return NULL
even if the object existed at the time of dispatch.
SPIRect *
AccessibleBoundsChangedEvent_getNewBounds
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:bounds-changed", returning a pointer to an SPIRect structure containing the new bounds, or NULL on error. The returned structure should be freed with SPI_freeRect when the caller has finished referencing it.
Since
: AT-SPI 1.6
char *
AccessibleTableCaptionChangedEvent_getCaptionString
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:property-changed:accessible-table-caption-object" returning the text in the caption, if present.
char *
AccessibleTableColumnDescriptionChangedEvent_getDescriptionString
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:property-changed:accessible-table-column-description" returning the new table column description.
Accessible *
AccessibleTableHeaderChangedEvent_getHeaderAccessible
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type
"object:property-changed:accessible-table-row-header" or
"object:property-changed:accessible-table-column-header"
to get a reference to the changed Accessible.
Note that context Accessibles are not guaranteed to outlive
event delivery, in which case this call may return NULL
even if the object existed at the time of dispatch.
char *
AccessibleTableRowDescriptionChangedEvent_getDescriptionString
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:property-changed:accessible-table-row-description" returning the new table row description.
Accessible *
AccessibleTableSummaryChangedEvent_getSummaryAccessible
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:property-changed:accessible-table-summary"
to get a reference to the changed Accessible.
Note that context Accessibles are not guaranteed to outlive
event delivery, in which case this call may return NULL
even if the object existed at the time of dispatch.
char *
AccessibleTextChangedEvent_getChangeString
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:text-changed", returning the text inserted or deleted.
char *
AccessibleTextSelectionChangedEvent_getSelectionString
(const AccessibleEvent *e
);
Queries an AccessibleEvent of type "object:text-selection-changed", returning the newly added, removed, or modified selection string.
char *
AccessibleWindowEvent_getTitleString (const AccessibleEvent *e
);
Queries an AccessibleEvent of type "window:", returning the window title.
typedef struct { const char *type; Accessible *source; long detail1; long detail2; } AccessibleEvent;
A structure used to encapsulate event information.
AccessibleEvent is a struct used to encapsulate event information.
a string representing the type of the event, with increasing specificity from left to right, delimited by colons. Leftmost token represents event source type, next token represents event category, and next token represents the subcategory of the event, for instance the specific property, state, or attribute being notified. |
||
Accessible * |
The Accessible from which the event originated. |