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
  60
  61 <!-- ##### FUNCTION atk_focus_tracker_notify ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @object:
  67
  68
  69 <!-- ##### USER_FUNCTION AtkEventListener ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @obj:
  75
  76
  77 <!-- ##### USER_FUNCTION AtkEventListenerInit ##### -->
  78 <para>
  79
  80 </para>
  81
  82
  83
  84 <!-- ##### FUNCTION atk_add_global_event_listener ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @listener:
  90 @event_type:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION atk_remove_global_event_listener ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @listener_id:
 100
 101
 102 <!-- ##### STRUCT AtkKeyEventStruct ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @type:
 108 @state:
 109 @keyval:
 110 @length:
 111 @string:
 112 @keycode:
 113 @timestamp:
 114
 115 <!-- ##### ENUM AtkKeyEventType ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @ATK_KEY_EVENT_PRESS:
 121 @ATK_KEY_EVENT_RELEASE:
 122 @ATK_KEY_EVENT_LAST_DEFINED:
 123
 124 <!-- ##### USER_FUNCTION AtkKeySnoopFunc ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @event:
 130 @func_data:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION atk_add_key_event_listener ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @listener:
 140 @data:
 141 @Returns:
 142
 143
 144 <!-- ##### FUNCTION atk_remove_key_event_listener ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @listener_id:
 150
 151
 152 <!-- ##### FUNCTION atk_get_root ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @Returns:
 158
 159
 160 <!-- ##### FUNCTION atk_get_focus_object ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @Returns:
 166
 167
 168 <!-- ##### FUNCTION atk_get_toolkit_name ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @Returns:
 174
 175
 176 <!-- ##### FUNCTION atk_get_toolkit_version ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @Returns:
 182
 183