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 <!-- ##### STRUCT AtkComponent ##### -->
  29 <para>
  30
  31 </para>
  32
  33
  34 <!-- ##### STRUCT AtkComponentIface ##### -->
  35 <para>
  36
  37 </para>
  38
  39 @parent:
  40 @add_focus_handler:
  41 @contains:
  42 @ref_accessible_at_point:
  43 @get_extents:
  44 @get_position:
  45 @get_size:
  46 @grab_focus:
  47 @remove_focus_handler:
  48 @set_extents:
  49 @set_position:
  50 @set_size:
  51 @get_layer:
  52 @get_mdi_zorder:
  53 @pad1:
  54 @pad2:
  55
  56 <!-- ##### FUNCTION atk_component_add_focus_handler ##### -->
  57 <para>
  58
  59 </para>
  60
  61 @component:
  62 @handler:
  63 @Returns:
  64
  65
  66 <!-- ##### FUNCTION atk_component_contains ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @component:
  72 @x:
  73 @y:
  74 @coord_type:
  75 @Returns:
  76
  77
  78 <!-- ##### FUNCTION atk_component_get_extents ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @component:
  84 @x:
  85 @y:
  86 @width:
  87 @height:
  88 @coord_type:
  89
  90
  91 <!-- ##### FUNCTION atk_component_get_layer ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @component:
  97 @Returns:
  98
  99
 100 <!-- ##### FUNCTION atk_component_get_mdi_zorder ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @component:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION atk_component_get_position ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @component:
 115 @x:
 116 @y:
 117 @coord_type:
 118
 119
 120 <!-- ##### FUNCTION atk_component_get_size ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @component:
 126 @width:
 127 @height:
 128
 129
 130 <!-- ##### FUNCTION atk_component_grab_focus ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @component:
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION atk_component_ref_accessible_at_point ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @component:
 145 @x:
 146 @y:
 147 @coord_type:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION atk_component_remove_focus_handler ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @component:
 157 @handler_id:
 158
 159
 160 <!-- ##### FUNCTION atk_component_set_extents ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @component:
 166 @x:
 167 @y:
 168 @width:
 169 @height:
 170 @coord_type:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION atk_component_set_position ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @component:
 180 @x:
 181 @y:
 182 @coord_type:
 183 @Returns:
 184
 185
 186 <!-- ##### FUNCTION atk_component_set_size ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @component:
 192 @width:
 193 @height:
 194 @Returns:
 195
 196