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

Accessibility::KeyDefinition Struct Reference

A structure which defines the identity of a key for which notifications are to be requested. More...

import "Accessibility_Registry.idl";

List of all members.

Public Attributes

long keycode
long keysym
string keystring
long unused

Detailed Description

A structure which defines the identity of a key for which notifications are to be requested.

The data in the members of a KeyDefinition are used to determine which keyboard events 'match' the notification request filed by a client.

Ordinarily a KeyDefinition specifies one and only one of the criteria below; the result of using a KeyDefinition with multiple members defined as nonzero is undefined.
keycode if nonzero, the numeric, system-dependent value corresponding to a physical key on the keyboard. Keycode values have no semantic meaning to the end-user, and may depend on the user's hardware and operating environment. They therefore are rarely useful "as-is" to AT clients, unless the client has used operating system services to identify the hardward keycode associated with a particular key symbol. Notifications for key events requested by keycode are less dependent on modifier state than keysym based notifications, but some hardware (notably many laptops) may generate more than one keycode for the same physical key, depending on the state of physical shift/modifier keys.
keysym if nonzero, the numeric value corresponding to the X Keysym of the key for which notification is requested. Note that the presence of active modifiers will affect whether notification for key events requested via "keysym" specification takes place, since the keysym depends on the modifier state for most keys.
keystring if non-NULL, the string value of the inserted characters if the corresponding key event has KeyEvent:is_text set to True, or the string representing the 'name' of the key. On X11 systems, the string 'name' of non-printing keysyms corresponds to the values in "keysymdef.h" as provided by Xlib, with the leading "XK_" stripped off.

Definition at line 367 of file Accessibility_Registry.idl.

Member Data Documentation

long Accessibility::KeyDefinition::keycode

Definition at line 368 of file Accessibility_Registry.idl.

long Accessibility::KeyDefinition::keysym

Definition at line 369 of file Accessibility_Registry.idl.

string Accessibility::KeyDefinition::keystring

Definition at line 370 of file Accessibility_Registry.idl.

long Accessibility::KeyDefinition::unused

Definition at line 371 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