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