← Back to branch summary

~ubuntu-branches/ubuntu/maverick/at-spi/maverick

« back to all changes in this revision

Viewing changes to docs/reference/cspi/html/at-spi-cspi-AccessibleImage-Interface.html

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2009-09-23 08:38:27 UTC
  • mfrom: (1.1.45 upstream)
  • Revision ID: james.westby@ubuntu.com-20090923083827-lgmk1ulka14gji51
Tags: 1.28.0-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/html/at-spi-cspi-AccessibleImage-Interface.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>AccessibleImage Interface</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
7
 
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
 
7
<link rel="start" href="index.html" title="AT-SPI C Bindings Reference Manual">
8
8
<link rel="up" href="spi-component.html" title="Subinterface Methods">
9
9
<link rel="prev" href="at-spi-cspi-AccessibleHypertext-Interface.html" title="AccessibleHypertext Interface">
10
10
<link rel="next" href="at-spi-cspi-AccessibleSelection-Interface.html" title="AccessibleSelection Interface">
31
31
                <a href="#at-spi-cspi-AccessibleImage-Interface.description" class="shortcut">Description</a>
32
32
</td></tr>
33
33
</table>
34
 
<div class="refentry" title="AccessibleImage Interface">
 
34
<div class="refentry" lang="en">
35
35
<a name="at-spi-cspi-AccessibleImage-Interface"></a><div class="titlepage"></div>
36
36
<div class="refnamediv"><table width="100%"><tr>
37
37
<td valign="top">
38
38
<h2><span class="refentrytitle"><a name="at-spi-cspi-AccessibleImage-Interface.top_of_page"></a>AccessibleImage Interface</span></h2>
39
 
<p>AccessibleImage Interface</p>
 
39
<p>AccessibleImage Interface — </p>
40
40
</td>
41
41
<td valign="top" align="right"></td>
42
42
</tr></table></div>
43
 
<div class="refsynopsisdiv" title="Synopsis">
 
43
<div class="refsynopsisdiv">
44
44
<a name="at-spi-cspi-AccessibleImage-Interface.synopsis"></a><h2>Synopsis</h2>
45
45
<pre class="synopsis">
46
 
void                <a class="link" href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-ref" title="AccessibleImage_ref ()">AccessibleImage_ref</a>                 (AccessibleImage *obj);
47
 
void                <a class="link" href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-unref" title="AccessibleImage_unref ()">AccessibleImage_unref</a>               (AccessibleImage *obj);
48
 
char *              <a class="link" href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImageDescription" title="AccessibleImage_getImageDescription ()">AccessibleImage_getImageDescription</a> (AccessibleImage *obj);
49
 
void                <a class="link" href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImageSize" title="AccessibleImage_getImageSize ()">AccessibleImage_getImageSize</a>        (AccessibleImage *obj,
 
46
void                <a href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-ref" title="AccessibleImage_ref ()">AccessibleImage_ref</a>                 (AccessibleImage *obj);
 
47
void                <a href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-unref" title="AccessibleImage_unref ()">AccessibleImage_unref</a>               (AccessibleImage *obj);
 
48
char *              <a href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImageDescription" title="AccessibleImage_getImageDescription ()">AccessibleImage_getImageDescription</a> (AccessibleImage *obj);
 
49
void                <a href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImageSize" title="AccessibleImage_getImageSize ()">AccessibleImage_getImageSize</a>        (AccessibleImage *obj,
50
50
                                                         long int *width,
51
51
                                                         long int *height);
52
 
void                <a class="link" href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImagePosition" title="AccessibleImage_getImagePosition ()">AccessibleImage_getImagePosition</a>    (AccessibleImage *obj,
 
52
void                <a href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImagePosition" title="AccessibleImage_getImagePosition ()">AccessibleImage_getImagePosition</a>    (AccessibleImage *obj,
53
53
                                                         long int *x,
54
54
                                                         long int *y,
55
 
                                                         <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a> ctype);
56
 
void                <a class="link" href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImageExtents" title="AccessibleImage_getImageExtents ()">AccessibleImage_getImageExtents</a>     (AccessibleImage *obj,
 
55
                                                         <a href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a> ctype);
 
56
void                <a href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImageExtents" title="AccessibleImage_getImageExtents ()">AccessibleImage_getImageExtents</a>     (AccessibleImage *obj,
57
57
                                                         long int *x,
58
58
                                                         long int *y,
59
59
                                                         long int *width,
60
60
                                                         long int *height,
61
 
                                                         <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a> ctype);
62
 
char *              <a class="link" href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImageLocale" title="AccessibleImage_getImageLocale ()">AccessibleImage_getImageLocale</a>      (AccessibleImage *obj);
 
61
                                                         <a href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a> ctype);
 
62
char *              <a href="at-spi-cspi-AccessibleImage-Interface.html#AccessibleImage-getImageLocale" title="AccessibleImage_getImageLocale ()">AccessibleImage_getImageLocale</a>      (AccessibleImage *obj);
63
63
</pre>
64
64
</div>
65
 
<div class="refsect1" title="Description">
 
65
<div class="refsect1" lang="en">
66
66
<a name="at-spi-cspi-AccessibleImage-Interface.description"></a><h2>Description</h2>
67
67
<p>
68
68
</p>
69
69
</div>
70
 
<div class="refsect1" title="Details">
 
70
<div class="refsect1" lang="en">
71
71
<a name="at-spi-cspi-AccessibleImage-Interface.details"></a><h2>Details</h2>
72
 
<div class="refsect2" title="AccessibleImage_ref ()">
 
72
<div class="refsect2" lang="en">
73
73
<a name="AccessibleImage-ref"></a><h3>AccessibleImage_ref ()</h3>
74
74
<pre class="programlisting">void                AccessibleImage_ref                 (AccessibleImage *obj);</pre>
75
75
<p>
79
79
<div class="variablelist"><table border="0">
80
80
<col align="left" valign="top">
81
81
<tbody><tr>
82
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
82
<td>
 
83
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
83
84
<td> a pointer to the <span class="type">AccessibleImage</span> implementor on which to operate.
84
85
</td>
85
86
</tr></tbody>
86
87
</table></div>
87
88
</div>
88
89
<hr>
89
 
<div class="refsect2" title="AccessibleImage_unref ()">
 
90
<div class="refsect2" lang="en">
90
91
<a name="AccessibleImage-unref"></a><h3>AccessibleImage_unref ()</h3>
91
92
<pre class="programlisting">void                AccessibleImage_unref               (AccessibleImage *obj);</pre>
92
93
<p>
96
97
<div class="variablelist"><table border="0">
97
98
<col align="left" valign="top">
98
99
<tbody><tr>
99
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
100
<td>
 
101
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
100
102
<td> a pointer to the <span class="type">AccessibleImage</span> implementor on which to operate.
101
103
</td>
102
104
</tr></tbody>
103
105
</table></div>
104
106
</div>
105
107
<hr>
106
 
<div class="refsect2" title="AccessibleImage_getImageDescription ()">
 
108
<div class="refsect2" lang="en">
107
109
<a name="AccessibleImage-getImageDescription"></a><h3>AccessibleImage_getImageDescription ()</h3>
108
110
<pre class="programlisting">char *              AccessibleImage_getImageDescription (AccessibleImage *obj);</pre>
109
111
<p>
114
116
<col align="left" valign="top">
115
117
<tbody>
116
118
<tr>
117
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
119
<td>
 
120
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
118
121
<td> a pointer to the <span class="type">AccessibleImage</span> implementor on which to operate.
119
122
</td>
120
123
</tr>
121
124
<tr>
122
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
125
<td>
 
126
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
123
127
<td> a UTF-8 string describing the image.
124
128
</td>
125
129
</tr>
127
131
</table></div>
128
132
</div>
129
133
<hr>
130
 
<div class="refsect2" title="AccessibleImage_getImageSize ()">
 
134
<div class="refsect2" lang="en">
131
135
<a name="AccessibleImage-getImageSize"></a><h3>AccessibleImage_getImageSize ()</h3>
132
136
<pre class="programlisting">void                AccessibleImage_getImageSize        (AccessibleImage *obj,
133
137
                                                         long int *width,
140
144
<col align="left" valign="top">
141
145
<tbody>
142
146
<tr>
143
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
147
<td>
 
148
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
144
149
<td> a pointer to the <span class="type">AccessibleImage</span> to query.
145
150
</td>
146
151
</tr>
147
152
<tr>
148
 
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 
153
<td>
 
154
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
149
155
<td> a pointer to a <span class="type">long</span> into which the x extents (width) will be returned.
150
156
</td>
151
157
</tr>
152
158
<tr>
153
 
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 
159
<td>
 
160
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
154
161
<td> a pointer to a <span class="type">long</span> into which the y extents (height) will be returned.
155
162
</td>
156
163
</tr>
158
165
</table></div>
159
166
</div>
160
167
<hr>
161
 
<div class="refsect2" title="AccessibleImage_getImagePosition ()">
 
168
<div class="refsect2" lang="en">
162
169
<a name="AccessibleImage-getImagePosition"></a><h3>AccessibleImage_getImagePosition ()</h3>
163
170
<pre class="programlisting">void                AccessibleImage_getImagePosition    (AccessibleImage *obj,
164
171
                                                         long int *x,
165
172
                                                         long int *y,
166
 
                                                         <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a> ctype);</pre>
 
173
                                                         <a href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a> ctype);</pre>
167
174
<p>
168
175
Get the minimum x and y coordinates of the image displayed in a
169
176
        specified <span class="type">AccessibleImage</span> implementor.</p>
173
180
<col align="left" valign="top">
174
181
<tbody>
175
182
<tr>
176
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
183
<td>
 
184
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
177
185
<td> a pointer to the <span class="type">AccessibleImage</span> implementor to query.
178
186
</td>
179
187
</tr>
180
188
<tr>
181
 
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 
189
<td>
 
190
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
182
191
<td> a pointer to a <span class="type">long</span> into which the minimum x coordinate will be returned.
183
192
</td>
184
193
</tr>
185
194
<tr>
186
 
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 
195
<td>
 
196
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
187
197
<td> a pointer to a <span class="type">long</span> into which the minimum y coordinate will be returned.
188
198
</td>
189
199
</tr>
190
200
<tr>
191
 
<td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
 
201
<td>
 
202
<span class="term"><em class="parameter"><code>ctype</code></em> :</span></td>
192
203
<td> the desired coordinate system into which to return the results,
193
204
        (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
194
205
</td>
197
208
</table></div>
198
209
</div>
199
210
<hr>
200
 
<div class="refsect2" title="AccessibleImage_getImageExtents ()">
 
211
<div class="refsect2" lang="en">
201
212
<a name="AccessibleImage-getImageExtents"></a><h3>AccessibleImage_getImageExtents ()</h3>
202
213
<pre class="programlisting">void                AccessibleImage_getImageExtents     (AccessibleImage *obj,
203
214
                                                         long int *x,
204
215
                                                         long int *y,
205
216
                                                         long int *width,
206
217
                                                         long int *height,
207
 
                                                         <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a> ctype);</pre>
 
218
                                                         <a href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a> ctype);</pre>
208
219
<p>
209
220
Get the bounding box of the image displayed in a
210
221
        specified <span class="type">AccessibleImage</span> implementor.</p>
214
225
<col align="left" valign="top">
215
226
<tbody>
216
227
<tr>
217
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
228
<td>
 
229
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
218
230
<td> a pointer to the <span class="type">AccessibleImage</span> implementor to query.
219
231
</td>
220
232
</tr>
221
233
<tr>
222
 
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 
234
<td>
 
235
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
223
236
<td> a pointer to a <span class="type">long</span> into which the minimum x coordinate will be returned.
224
237
</td>
225
238
</tr>
226
239
<tr>
227
 
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 
240
<td>
 
241
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
228
242
<td> a pointer to a <span class="type">long</span> into which the minimum y coordinate will be returned.
229
243
</td>
230
244
</tr>
231
245
<tr>
232
 
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 
246
<td>
 
247
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
233
248
<td> a pointer to a <span class="type">long</span> into which the image x extent will be returned.
234
249
</td>
235
250
</tr>
236
251
<tr>
237
 
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 
252
<td>
 
253
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
238
254
<td> a pointer to a <span class="type">long</span> into which the image y extent will be returned.
239
255
</td>
240
256
</tr>
241
257
<tr>
242
 
<td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
 
258
<td>
 
259
<span class="term"><em class="parameter"><code>ctype</code></em> :</span></td>
243
260
<td> the desired coordinate system into which to return the results,
244
261
        (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
245
262
</td>
248
265
</table></div>
249
266
</div>
250
267
<hr>
251
 
<div class="refsect2" title="AccessibleImage_getImageLocale ()">
 
268
<div class="refsect2" lang="en">
252
269
<a name="AccessibleImage-getImageLocale"></a><h3>AccessibleImage_getImageLocale ()</h3>
253
270
<pre class="programlisting">char *              AccessibleImage_getImageLocale      (AccessibleImage *obj);</pre>
254
271
<p>
259
276
<col align="left" valign="top">
260
277
<tbody>
261
278
<tr>
262
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
279
<td>
 
280
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
263
281
<td> The <span class="type">AccessibleImage</span> being queried.
264
282
</td>
265
283
</tr>
266
284
<tr>
267
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
285
<td>
 
286
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
268
287
<td> A POSIX LC_MESSAGES-style Locale value for image description and text.
269
288
</td>
270
289
</tr>