Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

Accessibility::DeviceEvent Struct Reference

A structure which encapsulates information about a device event. More...

import "Accessibility_Registry.idl";

List of all members.

Public Attributes

EventType type
 Identifies the type of the containing DeviceEvent.
long id
 an identifier which identifies this event in the event stream.
short hw_code
 a numeric code which is hardware and system-dependent, identifying the specific hardware button or key on the device for which the event has occurred.
unsigned short modifiers
 an unsigned short int consisting of zero or more of the following values OR'ed together:
unsigned long timestamp
 an unsigned integer representing the time that the event occurred.
string event_string
 A string representation of the event.
boolean is_text
 True if the event results in the insertion of characters into an input text buffer, or would do so if delivered to a focussed text input field.


Detailed Description

A structure which encapsulates information about a device event.

Definition at line 293 of file Accessibility_Registry.idl.


Member Data Documentation

EventType Accessibility::DeviceEvent::type
 

Identifies the type of the containing DeviceEvent.

Definition at line 294 of file Accessibility_Registry.idl.

long Accessibility::DeviceEvent::id
 

an identifier which identifies this event in the event stream.

On X Window systems this corresponds to the XEvent serial number.

Definition at line 295 of file Accessibility_Registry.idl.

short Accessibility::DeviceEvent::hw_code
 

a numeric code which is hardware and system-dependent, identifying the specific hardware button or key on the device for which the event has occurred.

On X Window systems, for global key notifications and for most non-global key notifications as well, this code corresponds to the XKeycode. For switch and button events it indicates the switch or button number.

Note:
For technical reasons, this code may differ from the XKeycode when generated by Java applications for consumption by non-global key listeners. This is subject to change in future versions of the DeviceEventController implementation.

Definition at line 298 of file Accessibility_Registry.idl.

unsigned short Accessibility::DeviceEvent::modifiers
 

an unsigned short int consisting of zero or more of the following values OR'ed together:

Definition at line 311 of file Accessibility_Registry.idl.

unsigned long Accessibility::DeviceEvent::timestamp
 

an unsigned integer representing the time that the event occurred.

On X Window systems this event is a time in milliseconds from some arbitrary starting point; it therefore has a cycle time of approximately 50 days.

Definition at line 321 of file Accessibility_Registry.idl.

string Accessibility::DeviceEvent::event_string
 

A string representation of the event.

If is_text is True, then this string represents the character or typographic sequence that would be received by a focussed text input field. event_string is in general suitable for exposure to the end-user for purposes of keyboard echo.

Definition at line 327 of file Accessibility_Registry.idl.

boolean Accessibility::DeviceEvent::is_text
 

True if the event results in the insertion of characters into an input text buffer, or would do so if delivered to a focussed text input field.

¨Typographical¨ key events have this field set to True, whereas ¨control¨ key events generally do not.

Definition at line 333 of file Accessibility_Registry.idl.


The documentation for this struct was generated from the following file:
Generated on Fri Dec 2 15:20:46 2005 for AT_SPI_IDL by  doxygen 1.4.3