doc/libatspi/tmpl/atspi-component.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 atspi-component
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5  An interface implemented by objects which have onscreen visual
   6  representations.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10   The Component interface is implemented by objects which occupy on-screen
  11   space, e.g. objects which have onscreen visual representations. The methods
  12   in Component allow clients to identify where the objects lie in the onscreen
  13   coordinate system, their relative size, stacking order, and position. It
  14   also provides a mechanism whereby keyboard focus may be transferred to
  15   specific user interface elements programmatically.  This is a 2D API.
  16   Coordinates of 3D objects are projected into the 2-dimensional screen view
  17   for purposes of this interface.
  18 </para>
  19
  20 <!-- ##### SECTION See_Also ##### -->
  21 <para>
  22
  23 </para>
  24
  25 <!-- ##### SECTION Stability_Level ##### -->
  26
  27
  28 <!-- ##### SECTION Image ##### -->
  29
  30
  31 <!-- ##### STRUCT AtspiRect ##### -->
  32 <para>
  33
  34 </para>
  35
  36
  37 <!-- ##### MACRO ATSPI_TYPE_RECT ##### -->
  38 <para>
  39
  40 </para>
  41
  42
  43
  44 <!-- ##### FUNCTION atspi_rect_copy ##### -->
  45 <para>
  46
  47 </para>
  48
  49 @src:
  50 @Returns:
  51
  52
  53 <!-- ##### STRUCT AtspiPoint ##### -->
  54 <para>
  55
  56 </para>
  57
  58
  59 <!-- ##### MACRO ATSPI_TYPE_POINT ##### -->
  60 <para>
  61
  62 </para>
  63
  64
  65
  66 <!-- ##### FUNCTION atspi_point_get_type ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @Returns:
  72
  73
  74 <!-- ##### FUNCTION atspi_point_copy ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @src:
  80 @Returns:
  81
  82
  83 <!-- ##### FUNCTION atspi_component_get_type ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @Returns:
  89
  90
  91 <!-- ##### STRUCT AtspiComponent ##### -->
  92 <para>
  93
  94 </para>
  95
  96
  97 <!-- ##### FUNCTION atspi_component_contains ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @obj:
 103 @x:
 104 @y:
 105 @ctype:
 106 @error:
 107 @Returns:
 108
 109
 110 <!-- ##### FUNCTION atspi_component_get_accessible_at_point ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @obj:
 116 @x:
 117 @y:
 118 @ctype:
 119 @error:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION atspi_component_get_extents ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @obj:
 129 @ctype:
 130 @error:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION atspi_component_get_position ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @obj:
 140 @ctype:
 141 @error:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION atspi_component_get_size ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @obj:
 151 @error:
 152 @Returns:
 153
 154
 155 <!-- ##### FUNCTION atspi_component_get_layer ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @obj:
 161 @error:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION atspi_component_get_mdi_z_order ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @obj:
 171 @error:
 172 @Returns:
 173
 174
 175 <!-- ##### FUNCTION atspi_component_grab_focus ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @obj:
 181 @error:
 182 @Returns:
 183
 184
 185 <!-- ##### FUNCTION atspi_component_get_alpha ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @obj:
 191 @error:
 192 @Returns:
 193
 194