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