docs/tmpl/atkcomponent.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkComponent
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 ATK Interface provided by UI components which occupy a physical area on
   6 the screen.
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #AtkComponent should be implemented by most if not all UI elements with
  10 an actual on-screen presence, i.e. components which can be said to have
  11 a screen-coordinate bounding box.  Virtually all widgets will need to
  12 have #AtkComponent implementations provided for their corresponding
  13 #AtkObject class.  In short, only UI elements which are *not* GUI
  14 elements will omit this ATK interface.
  15 </para>
  16 <para>
  17 A possible exception might be textual information with a transparent
  18 background, in which case text glyph bounding box information is
  19 provided by #AtkText.
  20 </para>
  21
  22 <!-- ##### SECTION See_Also ##### -->
  23 <para>
  24
  25 </para>
  26
  27 <!-- ##### STRUCT AtkComponent ##### -->
  28 <para>
  29
  30 </para>
  31
  32
  33 <!-- ##### STRUCT AtkComponentIface ##### -->
  34 <para>
  35
  36 </para>
  37
  38 @parent:
  39 @add_focus_handler:
  40 @contains:
  41 @ref_accessible_at_point:
  42 @get_extents:
  43 @get_position:
  44 @get_size:
  45 @grab_focus:
  46 @remove_focus_handler:
  47 @set_extents:
  48 @set_position:
  49 @set_size:
  50
  51 <!-- ##### FUNCTION atk_component_add_focus_handler ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @component:
  57 @handler:
  58 @Returns:
  59
  60
  61 <!-- ##### FUNCTION atk_component_contains ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @component:
  67 @x:
  68 @y:
  69 @coord_type:
  70 @Returns:
  71
  72
  73 <!-- ##### FUNCTION atk_component_get_extents ##### -->
  74 <para>
  75
  76 </para>
  77
  78 @component:
  79 @x:
  80 @y:
  81 @width:
  82 @height:
  83 @coord_type:
  84
  85
  86 <!-- ##### FUNCTION atk_component_get_position ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @component:
  92 @x:
  93 @y:
  94 @coord_type:
  95
  96
  97 <!-- ##### FUNCTION atk_component_get_size ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @component:
 103 @width:
 104 @height:
 105
 106
 107 <!-- ##### FUNCTION atk_component_grab_focus ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @component:
 113 @Returns:
 114
 115
 116 <!-- ##### FUNCTION atk_component_ref_accessible_at_point ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @component:
 122 @x:
 123 @y:
 124 @coord_type:
 125 @Returns:
 126
 127
 128 <!-- ##### FUNCTION atk_component_remove_focus_handler ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @component:
 134 @handler_id:
 135
 136
 137 <!-- ##### FUNCTION atk_component_set_extents ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @component:
 143 @x:
 144 @y:
 145 @width:
 146 @height:
 147 @coord_type:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION atk_component_set_position ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @component:
 157 @x:
 158 @y:
 159 @coord_type:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION atk_component_set_size ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @component:
 169 @width:
 170 @height:
 171 @Returns:
 172
 173