diff options
author | Bill Haneman <billh@src.gnome.org> | 2006-03-21 17:52:39 +0000 |
---|---|---|
committer | Bill Haneman <billh@src.gnome.org> | 2006-03-21 17:52:39 +0000 |
commit | 3aedda07471e2692ff1361bac6af433b52dec629 (patch) | |
tree | eac9657bd00a9329357e21229ce1045465511155 /atk/atkutil.h | |
parent | d155ef26c49995dc0a82b54ef7e961c65c564a33 (diff) | |
download | atk-3aedda07471e2692ff1361bac6af433b52dec629.tar.gz |
Improved documentation: ATK now has 100% gtk-doc coverage with no
sections tagged as incomplete.
Diffstat (limited to 'atk/atkutil.h')
-rwxr-xr-x | atk/atkutil.h | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/atk/atkutil.h b/atk/atkutil.h index 1dbfcf3..57e804e 100755 --- a/atk/atkutil.h +++ b/atk/atkutil.h @@ -84,6 +84,27 @@ typedef void (*AtkEventListenerInit) (void); typedef gint (*AtkKeySnoopFunc) (AtkKeyEventStruct *event, gpointer func_data); +/** + * AtkKeyEventStruct: + * @type: An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE + * @state: A bitmask representing the state of the modifier keys immediately after the event takes place. + * The meaning of the bits is currently defined to match the bitmask used by GDK in + * GdkEventType.state, see + * http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html#GdkEventKey + * @keyval: A guint representing a keysym value corresponding to those used by GDK and X11: see + * /usr/X11/include/keysymdef.h. + * @length: The length of member #string. + * @string: A string containing one of the following: either a string approximating the text that would + * result from this keypress, if the key is a control or graphic character, or a symbolic name for this keypress. + * Alphanumeric and printable keys will have the symbolic key name in this string member, for instance "A". "0", + * "semicolon", "aacute". Keypad keys have the prefix "KP". + * @keycode: The raw hardware code that generated the key event. This field is raraly useful. + * @timestamp: A timestamp in milliseconds indicating when the event occurred. + * These timestamps are relative to a starting point which should be considered arbitrary, + * and only used to compare the dispatch times of events to one another. + * + * Encapsulates information about a key event. + **/ struct _AtkKeyEventStruct { gint type; guint state; |