docs/tmpl/atkcomponent.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkComponent
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The ATK interface provided by UI components which occupy a physical area on
   6 the screen.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 #AtkComponent should be implemented by most if not all UI elements with
  11 an actual on-screen presence, i.e. components which can be said to have
  12 a screen-coordinate bounding box.  Virtually all widgets will need to
  13 have #AtkComponent implementations provided for their corresponding
  14 #AtkObject class.  In short, only UI elements which are *not* GUI
  15 elements will omit this ATK interface.
  16 </para>
  17 <para>
  18 A possible exception might be textual information with a transparent
  19 background, in which case text glyph bounding box information is
  20 provided by #AtkText.
  21 </para>
  22
  23 <!-- ##### SECTION See_Also ##### -->
  24 <para>
  25
  26 </para>
  27
  28 <!-- ##### SECTION Stability_Level ##### -->
  29
  30
  31 <!-- ##### SECTION Image ##### -->
  32
  33
  34 <!-- ##### STRUCT AtkComponent ##### -->
  35 <para>
  36 The AtkComponent structure does not contain any fields.
  37
  38 </para>
  39
  40
  41 <!-- ##### SIGNAL AtkComponent::bounds-changed ##### -->
  42 <para>
  43 The 'bounds-changed" signal is emitted when the bposition or size of the
  44 a component changes.
  45 </para>
  46
  47 @atkcomponent: the object which received the signal.
  48 @arg1: The AtkRectangle giving the new position and size.
  49
  50 <!-- ##### FUNCTION atk_component_add_focus_handler ##### -->
  51 <para>
  52
  53 </para>
  54
  55 @component:
  56 @handler:
  57 @Returns:
  58
  59
  60 <!-- ##### FUNCTION atk_component_contains ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @component:
  66 @x:
  67 @y:
  68 @coord_type:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION atk_component_get_extents ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @component:
  78 @x:
  79 @y:
  80 @width:
  81 @height:
  82 @coord_type:
  83
  84
  85 <!-- ##### FUNCTION atk_component_get_layer ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @component:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION atk_component_get_mdi_zorder ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @component:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION atk_component_get_position ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @component:
 109 @x:
 110 @y:
 111 @coord_type:
 112
 113
 114 <!-- ##### FUNCTION atk_component_get_size ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @component:
 120 @width:
 121 @height:
 122
 123
 124 <!-- ##### FUNCTION atk_component_grab_focus ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @component:
 130 @Returns:
 131
 132
 133 <!-- ##### FUNCTION atk_component_ref_accessible_at_point ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @component:
 139 @x:
 140 @y:
 141 @coord_type:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION atk_component_remove_focus_handler ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @component:
 151 @handler_id:
 152
 153
 154 <!-- ##### FUNCTION atk_component_set_extents ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @component:
 160 @x:
 161 @y:
 162 @width:
 163 @height:
 164 @coord_type:
 165 @Returns:
 166
 167
 168 <!-- ##### FUNCTION atk_component_set_position ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @component:
 174 @x:
 175 @y:
 176 @coord_type:
 177 @Returns:
 178
 179
 180 <!-- ##### FUNCTION atk_component_set_size ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @component:
 186 @width:
 187 @height:
 188 @Returns:
 189
 190
 191 <!-- ##### FUNCTION atk_component_get_alpha ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @component:
 197 @Returns:
 198
 199