| libatspi Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
atspi-devicelisteneratspi-devicelistener — An interface for creating and manipulating device listeners. |
gboolean (*AtspiDeviceListenerCB) (const AtspiDeviceEvent *stroke,void *user_data); gboolean (*AtspiDeviceListenerSimpleCB) (const AtspiDeviceEvent *stroke); struct AtspiDeviceListener; struct AtspiDeviceListenerClass; AtspiDeviceListener * atspi_device_listener_new (AtspiDeviceListenerCB callback,void *user_data,GDestroyNotify callback_destroyed); AtspiDeviceListener * atspi_device_listener_new_simple (AtspiDeviceListenerSimpleCB callback,GDestroyNotify callback_destroyed); void atspi_device_listener_add_callback (AtspiDeviceListener *listener,AtspiDeviceListenerCB callback,GDestroyNotify callback_destroyed,void *user_data); void atspi_device_listener_remove_callback (AtspiDeviceListener *listener,AtspiDeviceListenerCB callback);
gboolean (*AtspiDeviceListenerCB) (const AtspiDeviceEvent *stroke,void *user_data);
A callback function prototype via which clients receive device event notifications.
|
The AtspiDeviceEvent for which notification is being received. [transfer full] |
|
Data which is passed to the client each time this callback is notified. |
Returns : |
TRUE if the client wishes to consume/preempt the event, preventing it from being relayed to the currently focussed application, FALSE if the event delivery should proceed as normal. |
gboolean (*AtspiDeviceListenerSimpleCB) (const AtspiDeviceEvent *stroke);
Similar to AtspiDeviceListenerCB, but with no user data.
|
The AtspiDeviceEvent for which notification is being received. [transfer full] |
Returns : |
TRUE if the client wishes to consume/preempt the event, preventing it from being relayed to the currently focussed application, FALSE if the event delivery should proceed as normal. |
struct AtspiDeviceListenerClass {
GObjectClass parent_class;
gboolean (*device_event) (AtspiDeviceListener *listener, const AtspiDeviceEvent *event);
};
AtspiDeviceListener * atspi_device_listener_new (AtspiDeviceListenerCB callback,void *user_data,GDestroyNotify callback_destroyed);
Creates a new AtspiDeviceListener with a specified callback function.
|
an AtspiDeviceListenerCB callback function, or NULL. [scope notified] |
|
a pointer to data which will be passed to the callback when invoked. [closure] |
|
A GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It can be NULL. |
Returns : |
a pointer to a newly-created AtspiDeviceListener. [transfer full] |
AtspiDeviceListener * atspi_device_listener_new_simple (AtspiDeviceListenerSimpleCB callback,GDestroyNotify callback_destroyed);
Creates a new AtspiDeviceListener with a specified callback function. This method is similar to atspi_device_listener_new, but callback takes no user data.
|
an AtspiDeviceListenerCB callback function, or NULL. [scope notified] |
|
A GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It an be NULL. |
Returns : |
a pointer to a newly-created AtspiDeviceListener. |
void atspi_device_listener_add_callback (AtspiDeviceListener *listener,AtspiDeviceListenerCB callback,GDestroyNotify callback_destroyed,void *user_data);
Adds an in-process callback function to an existing AtspiDeviceListener.
|
the AtspiDeviceListener instance to modify. |
|
an AtspiDeviceListenerCB function pointer. [scope notified] |
|
A GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It can be NULL. |
|
a pointer to data which will be passed to the callback when invoked. [closure] |
void atspi_device_listener_remove_callback (AtspiDeviceListener *listener,AtspiDeviceListenerCB callback);
Removes an in-process callback function from an existing AtspiDeviceListener.
|
the AtspiDeviceListener instance to modify. |
|
an AtspiDeviceListenerCB function pointer. [scope call] |