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