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 <!-- ##### STRUCT AtkComponent ##### -->
  32 <para>
  33 The AtkComponent structure does not contain any fields.
  34
  35 </para>
  36
  37
  38 <!-- ##### SIGNAL AtkComponent::bounds-changed ##### -->
  39 <para>
  40 The 'bounds-changed" signal is emitted when the bposition or size of the
  41 a component changes.
  42 </para>
  43
  44 @atkcomponent: the object which received the signal.
  45 @arg1: The AtkRectangle giving the new position and size.
  46
  47 <!-- ##### FUNCTION atk_component_add_focus_handler ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @component:
  53 @handler:
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION atk_component_contains ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @component:
  63 @x:
  64 @y:
  65 @coord_type:
  66 @Returns:
  67
  68
  69 <!-- ##### FUNCTION atk_component_get_extents ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @component:
  75 @x:
  76 @y:
  77 @width:
  78 @height:
  79 @coord_type:
  80
  81
  82 <!-- ##### FUNCTION atk_component_get_layer ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @component:
  88 @Returns:
  89
  90
  91 <!-- ##### FUNCTION atk_component_get_mdi_zorder ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @component:
  97 @Returns:
  98
  99
 100 <!-- ##### FUNCTION atk_component_get_position ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @component:
 106 @x:
 107 @y:
 108 @coord_type:
 109
 110
 111 <!-- ##### FUNCTION atk_component_get_size ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @component:
 117 @width:
 118 @height:
 119
 120
 121 <!-- ##### FUNCTION atk_component_grab_focus ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @component:
 127 @Returns:
 128
 129
 130 <!-- ##### FUNCTION atk_component_ref_accessible_at_point ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @component:
 136 @x:
 137 @y:
 138 @coord_type:
 139 @Returns:
 140
 141
 142 <!-- ##### FUNCTION atk_component_remove_focus_handler ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @component:
 148 @handler_id:
 149
 150
 151 <!-- ##### FUNCTION atk_component_set_extents ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @component:
 157 @x:
 158 @y:
 159 @width:
 160 @height:
 161 @coord_type:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION atk_component_set_position ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @component:
 171 @x:
 172 @y:
 173 @coord_type:
 174 @Returns:
 175
 176
 177 <!-- ##### FUNCTION atk_component_set_size ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @component:
 183 @width:
 184 @height:
 185 @Returns:
 186
 187