doc/libatspi/html/libatspi-atspi-component.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>atspi-component</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="libatspi-atspi-hypertext.html" title="atspi-hypertext">
  10 <link rel="next" href="libatspi-atspi-registry.html" title="atspi-registry">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libatspi-atspi-hypertext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="libatspi-atspi-registry.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libatspi-atspi-component.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libatspi-atspi-component.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#libatspi-atspi-component.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#libatspi-atspi-component.implementations" class="shortcut">Known Implementations</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="libatspi-atspi-component"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="libatspi-atspi-component.top_of_page"></a>atspi-component</span></h2>
  38 <p>atspi-component —  An interface implemented by objects which have onscreen visual
  39  representations.</p>
  40 </td>
  41 <td valign="top" align="right"></td>
  42 </tr></table></div>
  43 <div class="refsynopsisdiv">
  44 <a name="libatspi-atspi-component.synopsis"></a><h2>Synopsis</h2>
  45 <a name="AtspiRect"></a><a name="AtspiPoint"></a><a name="AtspiComponent"></a><pre class="synopsis">struct              <a class="link" href="libatspi-atspi-component.html#AtspiRect-struct" title="struct AtspiRect">AtspiRect</a>;
  46 #define             <a class="link" href="libatspi-atspi-component.html#ATSPI-TYPE-RECT:CAPS" title="ATSPI_TYPE_RECT">ATSPI_TYPE_RECT</a>
  47 <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         <a class="link" href="libatspi-atspi-component.html#atspi-rect-copy" title="atspi_rect_copy ()">atspi_rect_copy</a>                     (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> *src</code></em>);
  48 struct              <a class="link" href="libatspi-atspi-component.html#AtspiPoint-struct" title="struct AtspiPoint">AtspiPoint</a>;
  49 #define             <a class="link" href="libatspi-atspi-component.html#ATSPI-TYPE-POINT:CAPS" title="ATSPI_TYPE_POINT">ATSPI_TYPE_POINT</a>
  50 <a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="libatspi-atspi-component.html#atspi-point-get-type" title="atspi_point_get_type ()">atspi_point_get_type</a>                ();
  51 <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        <a class="link" href="libatspi-atspi-component.html#atspi-point-copy" title="atspi_point_copy ()">atspi_point_copy</a>                    (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> *src</code></em>);
  52 <a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="libatspi-atspi-component.html#atspi-component-get-type" title="atspi_component_get_type ()">atspi_component_get_type</a>            ();
  53                     <a class="link" href="libatspi-atspi-component.html#AtspiComponent-struct" title="AtspiComponent">AtspiComponent</a>;
  54 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libatspi-atspi-component.html#atspi-component-contains" title="atspi_component_contains ()">atspi_component_contains</a>            (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  55                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
  56                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
  57                                                          <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
  58                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  59 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *   <a class="link" href="libatspi-atspi-component.html#atspi-component-get-accessible-at-point" title="atspi_component_get_accessible_at_point ()">atspi_component_get_accessible_at_point</a>
  60                                                         (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  61                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
  62                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
  63                                                          <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
  64                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  65 <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         <a class="link" href="libatspi-atspi-component.html#atspi-component-get-extents" title="atspi_component_get_extents ()">atspi_component_get_extents</a>         (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  66                                                          <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
  67                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  68 <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        <a class="link" href="libatspi-atspi-component.html#atspi-component-get-position" title="atspi_component_get_position ()">atspi_component_get_position</a>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  69                                                          <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
  70                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  71 <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        <a class="link" href="libatspi-atspi-component.html#atspi-component-get-size" title="atspi_component_get_size ()">atspi_component_get_size</a>            (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  72                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  73 <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="returnvalue">AtspiComponentLayer</span></a> <a class="link" href="libatspi-atspi-component.html#atspi-component-get-layer" title="atspi_component_get_layer ()">atspi_component_get_layer</a>           (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  74                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  75 <a href="../glib/glib-Basic-Types.html#gshort"><span class="returnvalue">gshort</span></a>              <a class="link" href="libatspi-atspi-component.html#atspi-component-get-mdi-z-order" title="atspi_component_get_mdi_z_order ()">atspi_component_get_mdi_z_order</a>     (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  76                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  77 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libatspi-atspi-component.html#atspi-component-grab-focus" title="atspi_component_grab_focus ()">atspi_component_grab_focus</a>          (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  78                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  79 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="libatspi-atspi-component.html#atspi-component-get-alpha" title="atspi_component_get_alpha ()">atspi_component_get_alpha</a>           (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
  80                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  81 </pre>
  82 </div>
  83 <div class="refsect1">
  84 <a name="libatspi-atspi-component.object-hierarchy"></a><h2>Object Hierarchy</h2>
  85 <pre class="synopsis">
  86   GBoxed
  87    +----AtspiRect
  88 </pre>
  89 <pre class="synopsis">
  90   GBoxed
  91    +----AtspiPoint
  92 </pre>
  93 <pre class="synopsis">
  94   GInterface
  95    +----AtspiComponent
  96 </pre>
  97 </div>
  98 <div class="refsect1">
  99 <a name="libatspi-atspi-component.implementations"></a><h2>Known Implementations</h2>
 100 <p>
 101 AtspiComponent is implemented by
 102  <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
 103 </div>
 104 <div class="refsect1">
 105 <a name="libatspi-atspi-component.description"></a><h2>Description</h2>
 106 <p>
 107   The Component interface is implemented by objects which occupy on-screen
 108   space, e.g. objects which have onscreen visual representations. The methods
 109   in Component allow clients to identify where the objects lie in the onscreen
 110   coordinate system, their relative size, stacking order, and position. It
 111   also provides a mechanism whereby keyboard focus may be transferred to
 112   specific user interface elements programmatically.  This is a 2D API.
 113   Coordinates of 3D objects are projected into the 2-dimensional screen view
 114   for purposes of this interface.
 115 </p>
 116 </div>
 117 <div class="refsect1">
 118 <a name="libatspi-atspi-component.details"></a><h2>Details</h2>
 119 <div class="refsect2">
 120 <a name="AtspiRect-struct"></a><h3>struct AtspiRect</h3>
 121 <pre class="programlisting">struct AtspiRect {
 122   gint x;
 123   gint y;
 124   gint width;
 125   gint height;
 126 };
 127 </pre>
 128 <p>
 129 </p>
 130 </div>
 131 <hr>
 132 <div class="refsect2">
 133 <a name="ATSPI-TYPE-RECT:CAPS"></a><h3>ATSPI_TYPE_RECT</h3>
 134 <pre class="programlisting">#define ATSPI_TYPE_RECT (atspi_rect_get_type ())
 135 </pre>
 136 <p>
 137 The <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for a boxed type holding a <a class="link" href="libatspi-atspi-types.html#AtspiEvent"><span class="type">AtspiEvent</span></a>.
 138 </p>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="atspi-rect-copy"></a><h3>atspi_rect_copy ()</h3>
 143 <pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         atspi_rect_copy                     (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> *src</code></em>);</pre>
 144 <p>
 145 </p>
 146 </div>
 147 <hr>
 148 <div class="refsect2">
 149 <a name="AtspiPoint-struct"></a><h3>struct AtspiPoint</h3>
 150 <pre class="programlisting">struct AtspiPoint {
 151   gint x;
 152   gint y;
 153 };
 154 </pre>
 155 <p>
 156 </p>
 157 </div>
 158 <hr>
 159 <div class="refsect2">
 160 <a name="ATSPI-TYPE-POINT:CAPS"></a><h3>ATSPI_TYPE_POINT</h3>
 161 <pre class="programlisting">#define ATSPI_TYPE_POINT (atspi_point_get_type ())
 162 </pre>
 163 <p>
 164 The <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for a boxed type holding a <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a>.
 165 </p>
 166 </div>
 167 <hr>
 168 <div class="refsect2">
 169 <a name="atspi-point-get-type"></a><h3>atspi_point_get_type ()</h3>
 170 <pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               atspi_point_get_type                ();</pre>
 171 <p>
 172 </p>
 173 </div>
 174 <hr>
 175 <div class="refsect2">
 176 <a name="atspi-point-copy"></a><h3>atspi_point_copy ()</h3>
 177 <pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        atspi_point_copy                    (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> *src</code></em>);</pre>
 178 <p>
 179 </p>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="atspi-component-get-type"></a><h3>atspi_component_get_type ()</h3>
 184 <pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               atspi_component_get_type            ();</pre>
 185 <p>
 186 </p>
 187 </div>
 188 <hr>
 189 <div class="refsect2">
 190 <a name="AtspiComponent-struct"></a><h3>AtspiComponent</h3>
 191 <pre class="programlisting">typedef struct _AtspiComponent AtspiComponent;</pre>
 192 <p>
 193 </p>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="atspi-component-contains"></a><h3>atspi_component_contains ()</h3>
 198 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_component_contains            (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 199                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
 200                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
 201                                                          <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
 202                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 203 <p>
 204 Queries whether a given <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> contains a particular point.
 205 </p>
 206 <div class="variablelist"><table border="0" class="variablelist">
 207 <colgroup>
 208 <col align="left" valign="top">
 209 <col>
 210 </colgroup>
 211 <tbody>
 212 <tr>
 213 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 214 <td>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
 215 </tr>
 216 <tr>
 217 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 218 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the x coordinate in question.</td>
 219 </tr>
 220 <tr>
 221 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 222 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the y coordinate in question.</td>
 223 </tr>
 224 <tr>
 225 <td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
 226 <td>the desired coordinate system of the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>)
 227 (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).</td>
 228 </tr>
 229 <tr>
 230 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 231 <td>
 232 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the specified component contains the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>),
 233 <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
 234 </tr>
 235 </tbody>
 236 </table></div>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="atspi-component-get-accessible-at-point"></a><h3>atspi_component_get_accessible_at_point ()</h3>
 241 <pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *   atspi_component_get_accessible_at_point
 242                                                         (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 243                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
 244                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
 245                                                          <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
 246                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 247 <p>
 248 Gets the accessible child at a given coordinate within an <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
 249 </p>
 250 <div class="variablelist"><table border="0" class="variablelist">
 251 <colgroup>
 252 <col align="left" valign="top">
 253 <col>
 254 </colgroup>
 255 <tbody>
 256 <tr>
 257 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 258 <td>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
 259 </tr>
 260 <tr>
 261 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 262 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the x coordinate of the point in question.</td>
 263 </tr>
 264 <tr>
 265 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 266 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the y coordinate of the point in question.</td>
 267 </tr>
 268 <tr>
 269 <td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
 270 <td>the coordinate system of the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>)
 271 (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</td>
 272 </tr>
 273 <tr>
 274 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 275 <td>a pointer to an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> child of the
 276 specified component which contains the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>), or NULL if
 277 no child contains the point. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 278 </td>
 279 </tr>
 280 </tbody>
 281 </table></div>
 282 </div>
 283 <hr>
 284 <div class="refsect2">
 285 <a name="atspi-component-get-extents"></a><h3>atspi_component_get_extents ()</h3>
 286 <pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         atspi_component_get_extents         (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 287                                                          <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
 288                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 289 <p>
 290 Gets the bounding box of the specified <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
 291 </p>
 292 <div class="variablelist"><table border="0" class="variablelist">
 293 <colgroup>
 294 <col align="left" valign="top">
 295 <col>
 296 </colgroup>
 297 <tbody>
 298 <tr>
 299 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 300 <td>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
 301 </tr>
 302 <tr>
 303 <td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
 304 <td>the desired coordinate system into which to return the results,
 305 (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</td>
 306 </tr>
 307 <tr>
 308 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 309 <td>An <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> giving the accessible's extents.</td>
 310 </tr>
 311 </tbody>
 312 </table></div>
 313 </div>
 314 <hr>
 315 <div class="refsect2">
 316 <a name="atspi-component-get-position"></a><h3>atspi_component_get_position ()</h3>
 317 <pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        atspi_component_get_position        (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 318                                                          <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
 319                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 320 <p>
 321 Gets the minimum x and y coordinates of the specified <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
 322 </p>
 323 <div class="variablelist"><table border="0" class="variablelist">
 324 <colgroup>
 325 <col align="left" valign="top">
 326 <col>
 327 </colgroup>
 328 <tbody>
 329 <tr>
 330 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 331 <td>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
 332 </tr>
 333 <tr>
 334 <td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
 335 <td>the desired coordinate system into which to return the results,
 336 (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</td>
 337 </tr>
 338 <tr>
 339 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 340 <td>An <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> giving the <em class="parameter"><code>obj</code></em>'s position.</td>
 341 </tr>
 342 </tbody>
 343 </table></div>
 344 </div>
 345 <hr>
 346 <div class="refsect2">
 347 <a name="atspi-component-get-size"></a><h3>atspi_component_get_size ()</h3>
 348 <pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        atspi_component_get_size            (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 349                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 350 <p>
 351 Gets the size of the specified <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
 352 </p>
 353 <div class="variablelist"><table border="0" class="variablelist">
 354 <colgroup>
 355 <col align="left" valign="top">
 356 <col>
 357 </colgroup>
 358 <tbody>
 359 <tr>
 360 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 361 <td>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
 362 </tr>
 363 <tr>
 364 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 365 <td>An <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> giving the <em class="parameter"><code>obj</code></em>'s size.</td>
 366 </tr>
 367 </tbody>
 368 </table></div>
 369 </div>
 370 <hr>
 371 <div class="refsect2">
 372 <a name="atspi-component-get-layer"></a><h3>atspi_component_get_layer ()</h3>
 373 <pre class="programlisting"><a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="returnvalue">AtspiComponentLayer</span></a> atspi_component_get_layer           (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 374                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 375 <p>
 376 Queries which layer the component is painted into, to help determine its
 377      visibility in terms of stacking order.
 378 </p>
 379 <div class="variablelist"><table border="0" class="variablelist">
 380 <colgroup>
 381 <col align="left" valign="top">
 382 <col>
 383 </colgroup>
 384 <tbody>
 385 <tr>
 386 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 387 <td>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
 388 </tr>
 389 <tr>
 390 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 391 <td>the <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a> into which this component is painted.</td>
 392 </tr>
 393 </tbody>
 394 </table></div>
 395 </div>
 396 <hr>
 397 <div class="refsect2">
 398 <a name="atspi-component-get-mdi-z-order"></a><h3>atspi_component_get_mdi_z_order ()</h3>
 399 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gshort"><span class="returnvalue">gshort</span></a>              atspi_component_get_mdi_z_order     (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 400                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 401 <p>
 402 Queries the z stacking order of a component which is in the MDI or window
 403       layer. (Bigger z-order numbers mean nearer the top)
 404 </p>
 405 <div class="variablelist"><table border="0" class="variablelist">
 406 <colgroup>
 407 <col align="left" valign="top">
 408 <col>
 409 </colgroup>
 410 <tbody>
 411 <tr>
 412 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 413 <td>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
 414 </tr>
 415 <tr>
 416 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 417 <td>a <a href="../glib/glib-Basic-Types.html#gshort"><span class="type">gshort</span></a> indicating the stacking order of the component
 418 in the MDI layer, or -1 if the component is not in the MDI layer.</td>
 419 </tr>
 420 </tbody>
 421 </table></div>
 422 </div>
 423 <hr>
 424 <div class="refsect2">
 425 <a name="atspi-component-grab-focus"></a><h3>atspi_component_grab_focus ()</h3>
 426 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_component_grab_focus          (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 427                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 428 <p>
 429 Attempts to set the keyboard input focus to the specified
 430         <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
 431 </p>
 432 <div class="variablelist"><table border="0" class="variablelist">
 433 <colgroup>
 434 <col align="left" valign="top">
 435 <col>
 436 </colgroup>
 437 <tbody>
 438 <tr>
 439 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 440 <td>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> on which to operate.</td>
 441 </tr>
 442 <tr>
 443 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 444 <td>
 445 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
 446 </tr>
 447 </tbody>
 448 </table></div>
 449 </div>
 450 <hr>
 451 <div class="refsect2">
 452 <a name="atspi-component-get-alpha"></a><h3>atspi_component_get_alpha ()</h3>
 453 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             atspi_component_get_alpha           (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
 454                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 455 <p>
 456 Gets the opacity/alpha value of a component, if alpha blending is in use.
 457 </p>
 458 <div class="variablelist"><table border="0" class="variablelist">
 459 <colgroup>
 460 <col align="left" valign="top">
 461 <col>
 462 </colgroup>
 463 <tbody>
 464 <tr>
 465 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 466 <td>The <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to be queried.</td>
 467 </tr>
 468 <tr>
 469 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 470 <td>the opacity value of a component, as a <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> between 0.0 and 1.0.</td>
 471 </tr>
 472 </tbody>
 473 </table></div>
 474 </div>
 475 </div>
 476 </div>
 477 <div class="footer">
 478 <hr>
 479           Generated by GTK-Doc V1.18.1</div>
 480 </body>
 481 </html>