doc/libatspi/html/libatspi-atspi-image.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-image</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="AtspiRelation.html" title="atspi-relation">
  10 <link rel="next" href="AtspiMatchRule.html" title="atspi-matchrule">
  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="AtspiRelation.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="AtspiMatchRule.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-image.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libatspi-atspi-image.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#libatspi-atspi-image.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#libatspi-atspi-image.implementations" class="shortcut">Known Implementations</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="libatspi-atspi-image"></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-image.top_of_page"></a>atspi-image</span></h2>
  38 <p>atspi-image</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="libatspi-atspi-image.synopsis"></a><h2>Synopsis</h2>
  44 <a name="AtspiImage"></a><pre class="synopsis">                    <a class="link" href="libatspi-atspi-image.html#AtspiImage-struct" title="AtspiImage">AtspiImage</a>;
  45 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libatspi-atspi-image.html#atspi-image-get-image-description" title="atspi_image_get_image_description ()">atspi_image_get_image_description</a>   (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
  46                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  47 <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        <a class="link" href="libatspi-atspi-image.html#atspi-image-get-image-size" title="atspi_image_get_image_size ()">atspi_image_get_image_size</a>          (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
  48                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  49 <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        <a class="link" href="libatspi-atspi-image.html#atspi-image-get-image-position" title="atspi_image_get_image_position ()">atspi_image_get_image_position</a>      (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
  50                                                          <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>,
  51                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  52 <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         <a class="link" href="libatspi-atspi-image.html#atspi-image-get-image-extents" title="atspi_image_get_image_extents ()">atspi_image_get_image_extents</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
  53                                                          <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>,
  54                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  55 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libatspi-atspi-image.html#atspi-image-get-image-locale" title="atspi_image_get_image_locale ()">atspi_image_get_image_locale</a>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
  56                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="libatspi-atspi-image.object-hierarchy"></a><h2>Object Hierarchy</h2>
  61 <pre class="synopsis">
  62   GInterface
  63    +----AtspiImage
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="libatspi-atspi-image.implementations"></a><h2>Known Implementations</h2>
  68 <p>
  69 AtspiImage is implemented by
  70  <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
  71 </div>
  72 <div class="refsect1">
  73 <a name="libatspi-atspi-image.description"></a><h2>Description</h2>
  74 <p>
  75 </p>
  76 </div>
  77 <div class="refsect1">
  78 <a name="libatspi-atspi-image.details"></a><h2>Details</h2>
  79 <div class="refsect2">
  80 <a name="AtspiImage-struct"></a><h3>AtspiImage</h3>
  81 <pre class="programlisting">typedef struct _AtspiImage AtspiImage;</pre>
  82 <p>
  83 </p>
  84 </div>
  85 <hr>
  86 <div class="refsect2">
  87 <a name="atspi-image-get-image-description"></a><h3>atspi_image_get_image_description ()</h3>
  88 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             atspi_image_get_image_description   (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
  89                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  90 <p>
  91 Gets the description of the image displayed in an <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> object.
  92 </p>
  93 <div class="variablelist"><table border="0" class="variablelist">
  94 <colgroup>
  95 <col align="left" valign="top">
  96 <col>
  97 </colgroup>
  98 <tbody>
  99 <tr>
 100 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 101 <td>a pointer to the <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> implementor on which to operate.</td>
 102 </tr>
 103 <tr>
 104 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 105 <td>a UTF-8 string describing the image.</td>
 106 </tr>
 107 </tbody>
 108 </table></div>
 109 </div>
 110 <hr>
 111 <div class="refsect2">
 112 <a name="atspi-image-get-image-size"></a><h3>atspi_image_get_image_size ()</h3>
 113 <pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        atspi_image_get_image_size          (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
 114                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 115 <p>
 116 Gets the size of the image displayed in a specified <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> object.
 117 </p>
 118 <div class="variablelist"><table border="0" class="variablelist">
 119 <colgroup>
 120 <col align="left" valign="top">
 121 <col>
 122 </colgroup>
 123 <tbody>
 124 <tr>
 125 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 126 <td>a pointer to the <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> to query.</td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 130 <td>a pointer to an <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> where x corresponds to
 131 the image's width and y corresponds to the image's height.</td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 </div>
 136 <hr>
 137 <div class="refsect2">
 138 <a name="atspi-image-get-image-position"></a><h3>atspi_image_get_image_position ()</h3>
 139 <pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        atspi_image_get_image_position      (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
 140                                                          <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>,
 141                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 142 <p>
 143 Gets the minimum x and y coordinates of the image displayed in a
 144         specified <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> implementor.
 145 </p>
 146 <div class="variablelist"><table border="0" class="variablelist">
 147 <colgroup>
 148 <col align="left" valign="top">
 149 <col>
 150 </colgroup>
 151 <tbody>
 152 <tr>
 153 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 154 <td>a pointer to the <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> implementor to query.</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
 158 <td>the desired coordinate system into which to return the results,
 159 (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 163 <td>a pointer to an <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> where x and y correspond to the
 164 minimum coordinates of the displayed image.</td>
 165 </tr>
 166 </tbody>
 167 </table></div>
 168 </div>
 169 <hr>
 170 <div class="refsect2">
 171 <a name="atspi-image-get-image-extents"></a><h3>atspi_image_get_image_extents ()</h3>
 172 <pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         atspi_image_get_image_extents       (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
 173                                                          <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>,
 174                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 175 <p>
 176 Gets the bounding box of the image displayed in a
 177         specified <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> implementor.
 178 </p>
 179 <div class="variablelist"><table border="0" class="variablelist">
 180 <colgroup>
 181 <col align="left" valign="top">
 182 <col>
 183 </colgroup>
 184 <tbody>
 185 <tr>
 186 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 187 <td>a pointer to the <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> implementor to query.</td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
 191 <td>the desired coordinate system into which to return the results,
 192 (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</td>
 193 </tr>
 194 <tr>
 195 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 196 <td>a pointer to an <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> corresponding to the image's bounding box. The minimum x and y coordinates,
 197 width, and height are specified.</td>
 198 </tr>
 199 </tbody>
 200 </table></div>
 201 </div>
 202 <hr>
 203 <div class="refsect2">
 204 <a name="atspi-image-get-image-locale"></a><h3>atspi_image_get_image_locale ()</h3>
 205 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             atspi_image_get_image_locale        (<em class="parameter"><code><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> *obj</code></em>,
 206                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 207 <p>
 208 Gets the locale associated with an image and its textual representation.
 209 </p>
 210 <div class="variablelist"><table border="0" class="variablelist">
 211 <colgroup>
 212 <col align="left" valign="top">
 213 <col>
 214 </colgroup>
 215 <tbody>
 216 <tr>
 217 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 218 <td>a pointer to the <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> to query.</td>
 219 </tr>
 220 <tr>
 221 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 222 <td>A POSIX LC_MESSAGES-style locale value for image description and text.</td>
 223 </tr>
 224 </tbody>
 225 </table></div>
 226 </div>
 227 </div>
 228 </div>
 229 <div class="footer">
 230 <hr>
 231           Generated by GTK-Doc V1.18.1</div>
 232 </body>
 233 </html>