docs/tmpl/atkutil.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkUtil
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 This is a utility class which supports the adding and removal of event listeners.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 This is a utility class which supports the adding and removal of event
  10 listeners. The adding and removing of the listeners must be done in the
  11 same thread. The file also contains a number of utility functions.
  12
  13 </para>
  14
  15 <!-- ##### SECTION See_Also ##### -->
  16 <para>
  17
  18 </para>
  19
  20 <!-- ##### STRUCT AtkUtil ##### -->
  21 <para>
  22 The AtkObject structure should not be accessed directly.
  23
  24 </para>
  25
  26
  27 <!-- ##### ENUM AtkCoordType ##### -->
  28 <para>
  29
  30 </para>
  31
  32 @ATK_XY_SCREEN:
  33 @ATK_XY_WINDOW:
  34
  35 <!-- ##### FUNCTION atk_add_focus_tracker ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @focus_tracker:
  41 @Returns:
  42
  43
  44 <!-- ##### FUNCTION atk_remove_focus_tracker ##### -->
  45 <para>
  46
  47 </para>
  48
  49 @tracker_id:
  50
  51
  52 <!-- ##### FUNCTION atk_focus_tracker_init ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @add_function:
  58
  59
  60 <!-- ##### FUNCTION atk_focus_tracker_notify ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @object:
  66
  67
  68 <!-- ##### USER_FUNCTION AtkEventListener ##### -->
  69 <para>
  70 An AtkEventListener is user specified function which is called when an event,
  71 such as receiving focus, occurs. The parameter of the AtkEventListener is the
  72 AtkObject on which the event occurred.
  73 </para>
  74
  75 @Param1:
  76
  77
  78 <!-- ##### USER_FUNCTION AtkEventListenerInit ##### -->
  79 <para>
  80 An AtkEventListenerInit is an initialization function in an implementation
  81 of the ATK interface used to perform implementation-specific initialization
  82 when enabling focus tracking.
  83
  84 </para>
  85
  86
  87
  88 <!-- ##### FUNCTION atk_add_global_event_listener ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @listener:
  94 @event_type:
  95 @Returns:
  96
  97
  98 <!-- ##### FUNCTION atk_remove_global_event_listener ##### -->
  99 <para>
 100
 101 </para>
 102
 103 @listener_id:
 104
 105
 106 <!-- ##### STRUCT AtkKeyEventStruct ##### -->
 107 <para>
 108 The AtkKeyEventStruct describes a keyboard event.
 109 </para>
 110
 111 @type:
 112 @state:
 113 @keyval:
 114 @length:
 115 @string:
 116 @keycode:
 117 @timestamp:
 118
 119 <!-- ##### ENUM AtkKeyEventType ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @ATK_KEY_EVENT_PRESS:
 125 @ATK_KEY_EVENT_RELEASE:
 126 @ATK_KEY_EVENT_LAST_DEFINED:
 127
 128 <!-- ##### USER_FUNCTION AtkKeySnoopFunc ##### -->
 129 <para>
 130 An AtkKeySnoopFunc is a function which is called when a keyboard event occurs.
 131 </para>
 132
 133 @event:
 134 @func_data:
 135 @Returns:
 136
 137
 138 <!-- ##### FUNCTION atk_add_key_event_listener ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @listener:
 144 @data:
 145 @Returns:
 146
 147
 148 <!-- ##### FUNCTION atk_remove_key_event_listener ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @listener_id:
 154
 155
 156 <!-- ##### FUNCTION atk_get_root ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION atk_get_focus_object ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION atk_get_toolkit_name ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @Returns:
 178
 179
 180 <!-- ##### FUNCTION atk_get_toolkit_version ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @Returns:
 186
 187