1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Atk::Image Class Reference</h1>An AtkImage C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="gtk_2image_8hh-source.html">gfc/atk/image.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Atk::Image:
<p><center><img src="classGFC_1_1Atk_1_1Image.png" usemap="#GFC::Atk::Image_map" border="0" alt=""></center>
<map name="GFC::Atk::Image_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,137,24">
</map>
<a href="classGFC_1_1Atk_1_1Image-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z29_0" doxytag="GFC::Atk::Image::atk_image" ></a>
AtkImage * <a class="el" href="classGFC_1_1Atk_1_1Image.html#z29_0">atk_image</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the AtkImage structure. <br></dl><li><a class="anchor" name="z29_1" doxytag="GFC::Atk::Image::operator AtkImage *" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Image.html#z29_1">operator AtkImage *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Atk_1_1Image.html">Image</a> to an AtkImage pointer. <br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> <a class="el" href="classGFC_1_1Atk_1_1Image.html#z29_2">get_image_description</a> () const
<dl class="el"><dd class="mdescRight">Get a textual description of the image. <a href="#z29_2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1Image.html#z29_3">get_image_size</a> (int *height, int *width) const
<dl class="el"><dd class="mdescRight">Get the width and height in pixels for the specified image. <a href="#z29_3"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1Image.html#z29_4">get_image_position</a> (int *x, int *y, <a class="el" href="namespaceGFC_1_1Atk.html#a200">CoordType</a> coord_type) const
<dl class="el"><dd class="mdescRight">Gets the position of the image in the form of a point specifying the images top-left corner. <a href="#z29_4"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>bool <a class="el" href="classGFC_1_1Atk_1_1Image.html#z30_1">set_image_description</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &description)
<dl class="el"><dd class="mdescRight">Sets the textual description for the image. <a href="#z30_1"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z28_0" doxytag="GFC::Atk::Image::Image" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Image.html#z28_0">Image</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Atk_1_1Image.html">Image</a> object. <br></dl><li><a class="anchor" name="z28_1" doxytag="GFC::Atk::Image::~Image" ></a>
virtual <a class="el" href="classGFC_1_1Atk_1_1Image.html#z28_1">~Image</a> ()=0
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An AtkImage C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Atk_1_1Image.html">Image</a> should be implemented by <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> subtypes on behalf of components which display image or pixmap information on-screen, and which provide information (other than just widget borders, etc.) via that image content. For instance, icons, buttons with icons, toolbar elements, and image viewing panes typically should implement <a class="el" href="classGFC_1_1Atk_1_1Image.html">Image</a>.<p>
<a class="el" href="classGFC_1_1Atk_1_1Image.html">Image</a> primarily provides two types of information: coordinate information (useful for screen review mode of screen readers, and for use by on-screen magnifiers), and descriptive information. The descriptive information is provided for alternative, text-only presentation of the most significant information present in the image.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z29_2" doxytag="GFC::Atk::Image::get_image_description" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> GFC::Atk::Image::get_image_description </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get a textual description of the image.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A string representing the image description. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z29_4" doxytag="GFC::Atk::Image::get_image_position" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::Image::get_image_position </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>x</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>y</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Atk.html#a200">CoordType</a> </td>
<td class="mdname" nowrap> <em>coord_type</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the position of the image in the form of a point specifying the images top-left corner.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>x</em> </td><td>The address of an int to put the x coordinate position, or null. </td></tr>
<tr><td></td><td valign=top><em>y</em> </td><td>The address of an int to put the y coordinate position, or null. </td></tr>
<tr><td></td><td valign=top><em>coord_type</em> </td><td>Specifies whether the coordinates are relative to the screen or to the components top level window.</td></tr>
</table>
</dl>
<br>
The values of <em>x</em> and <em>y</em> are returned as -1 if the values cannot be obtained. </td>
</tr>
</table>
<a class="anchor" name="z29_3" doxytag="GFC::Atk::Image::get_image_size" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::Image::get_image_size </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>height</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>width</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the width and height in pixels for the specified image.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>width</em> </td><td>The address of an int filled with the image width, or null. </td></tr>
<tr><td></td><td valign=top><em>height</em> </td><td>The address of an int filled with the image height, or null.</td></tr>
</table>
</dl>
<br>
The values of width and height are returned as -1 if the values cannot be obtained. </td>
</tr>
</table>
<a class="anchor" name="z30_1" doxytag="GFC::Atk::Image::set_image_description" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Atk::Image::set_image_description </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>description</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the textual description for the image.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>description</em> </td><td>A string description to set for image. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the description is set, <em>false</em> otherwise. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="atk_2image_8hh-source.html">atk/image.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:34 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
