docs/tmpl/atkutil.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkUtil
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A set of ATK utility functions for event and toolkit support.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A set of ATK utility functions which are used to support event registration of
  10 various types, and obtaining the 'root' accessible of a process and
  11 information about the current ATK implementation and toolkit version.
  12 </para>
  13
  14 <!-- ##### SECTION See_Also ##### -->
  15 <para>
  16
  17 </para>
  18
  19 <!-- ##### SECTION Stability_Level ##### -->
  20
  21
  22 <!-- ##### SECTION Image ##### -->
  23
  24
  25 <!-- ##### STRUCT AtkUtil ##### -->
  26 <para>
  27 The AtkUtil struct does not contain any fields.
  28 </para>
  29
  30
  31 <!-- ##### ENUM AtkCoordType ##### -->
  32 <para>
  33
  34 </para>
  35
  36 @ATK_XY_SCREEN:
  37 @ATK_XY_WINDOW:
  38
  39 <!-- ##### FUNCTION atk_add_focus_tracker ##### -->
  40 <para>
  41
  42 </para>
  43
  44 @focus_tracker:
  45 @Returns:
  46
  47
  48 <!-- ##### FUNCTION atk_remove_focus_tracker ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @tracker_id:
  54
  55
  56 <!-- ##### FUNCTION atk_focus_tracker_init ##### -->
  57 <para>
  58
  59 </para>
  60
  61 @init:
  62
  63
  64 <!-- ##### FUNCTION atk_focus_tracker_notify ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @object:
  70
  71
  72 <!-- ##### USER_FUNCTION AtkEventListener ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @obj:
  78
  79
  80 <!-- ##### USER_FUNCTION AtkEventListenerInit ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @void:
  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
 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
 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 @void:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION atk_get_focus_object ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @void:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION atk_get_toolkit_name ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @void:
 180 @Returns:
 181
 182
 183 <!-- ##### FUNCTION atk_get_toolkit_version ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @void:
 189 @Returns:
 190
 191