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 <!-- ##### STRUCT AtkUtil ##### -->
  23 <para>
  24 The AtkUtil struct does not contain any fields.
  25 </para>
  26
  27
  28 <!-- ##### ENUM AtkCoordType ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @ATK_XY_SCREEN:
  34 @ATK_XY_WINDOW:
  35
  36 <!-- ##### FUNCTION atk_add_focus_tracker ##### -->
  37 <para>
  38
  39 </para>
  40
  41 @focus_tracker:
  42 @Returns:
  43
  44
  45 <!-- ##### FUNCTION atk_remove_focus_tracker ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @tracker_id:
  51
  52
  53 <!-- ##### FUNCTION atk_focus_tracker_init ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @init:
  59 <!-- # Unused Parameters # -->
  60 @add_function:
  61
  62
  63 <!-- ##### FUNCTION atk_focus_tracker_notify ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @object:
  69
  70
  71 <!-- ##### USER_FUNCTION AtkEventListener ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @obj:
  77
  78
  79 <!-- ##### USER_FUNCTION AtkEventListenerInit ##### -->
  80 <para>
  81
  82 </para>
  83
  84
  85
  86 <!-- ##### FUNCTION atk_add_global_event_listener ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @listener:
  92 @event_type:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION atk_remove_global_event_listener ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @listener_id:
 102
 103
 104 <!-- ##### STRUCT AtkKeyEventStruct ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @type:
 110 @state:
 111 @keyval:
 112 @length:
 113 @string:
 114 @keycode:
 115 @timestamp:
 116
 117 <!-- ##### ENUM AtkKeyEventType ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @ATK_KEY_EVENT_PRESS:
 123 @ATK_KEY_EVENT_RELEASE:
 124 @ATK_KEY_EVENT_LAST_DEFINED:
 125
 126 <!-- ##### USER_FUNCTION AtkKeySnoopFunc ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @event:
 132 @func_data:
 133 @Returns:
 134
 135
 136 <!-- ##### FUNCTION atk_add_key_event_listener ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @listener:
 142 @data:
 143 @Returns:
 144
 145
 146 <!-- ##### FUNCTION atk_remove_key_event_listener ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @listener_id:
 152
 153
 154 <!-- ##### FUNCTION atk_get_root ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @Returns:
 160
 161
 162 <!-- ##### FUNCTION atk_get_focus_object ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION atk_get_toolkit_name ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @Returns:
 176
 177
 178 <!-- ##### FUNCTION atk_get_toolkit_version ##### -->
 179 <para>
 180
 181 </para>
 182
 183 @Returns:
 184
 185