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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
<!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>iconfactory.hh File Reference</h1>A GtkIconFactory C++ wrapper interface. <a href="#_details">More...</a>
<p>
<code>#include <gfc/glib/object.hh></code><br>
<code>#include <<a class="el" href="iconset_8hh-source.html">gfc/gtk/iconset.hh</a>></code><br>
<code>#include <<a class="el" href="stockid_8hh-source.html">gfc/gtk/stockid.hh</a>></code><br>
<code>#include <gfc/gtk/inline/iconfactory.inl></code><br>
<p>
<a href="iconfactory_8hh-source.html">Go to the source code of this file.</a><h2>Namespaces</h2>
<ul>
<li>namespace <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a>
<li>namespace <a class="el" href="namespaceGFC_1_1Gdk.html">GFC::Gdk</a>
<li>namespace <a class="el" href="namespaceGFC_1_1Gtk.html">GFC::Gtk</a>
</ul>
<h2>Classes</h2>
<ul>
<li>class <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">GFC::Gtk::IconFactory</a>
<dl class="el"><dd class="mdescRight">A GtkIconFactory C++ wrapper class. <a href="classGFC_1_1Gtk_1_1IconFactory.html#_details">More...</a><br></dl></ul>
<h2>Icon Size Methods</h2>
<ul>
<li>bool <a class="el" href="namespaceGFC_1_1Gtk.html#a299">icon_size_lookup</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> size, int *width, int *height, Settings *settings=0)
<dl class="el"><dd class="mdescRight">Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular <a class="el" href="classGFC_1_1Gtk_1_1Settings.html">Settings</a>. <a href="#a299"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> <a class="el" href="namespaceGFC_1_1Gtk.html#a301">icon_size_register</a> (const String &name, int width, int height)
<dl class="el"><dd class="mdescRight">Registers a new icon size, along the same lines as ICON_SIZE_MENU, etc. <a href="#a301"></a><br></dl><li>void <a class="el" href="namespaceGFC_1_1Gtk.html#a303">icon_size_register_alias</a> (const String &alias, <a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> target)
<dl class="el"><dd class="mdescRight">Registers <em>alias</em> as another name for <em>target</em>. <a href="#a303"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> <a class="el" href="namespaceGFC_1_1Gtk.html#a305">icon_size_from_name</a> (const String &name)
<dl class="el"><dd class="mdescRight">Looks up the icon size associated with <em>name</em>. <a href="#a305"></a><br></dl><li>String <a class="el" href="namespaceGFC_1_1Gtk.html#a306">icon_size_get_name</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> size)
<dl class="el"><dd class="mdescRight">Gets the canonical name of the given icon size. <a href="#a306"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkIconFactory C++ wrapper interface.
<p>
Provides IconFactory, an object that manages a collection of IconSets.<hr><h2>Function Documentation</h2>
<a class="anchor" name="a305" doxytag="iconfactory.hh::icon_size_from_name" ></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="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> icon_size_from_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>name</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>
Looks up the icon size associated with <em>name</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>name</em> </td><td>The name to look up. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The icon size with the given name. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a306" doxytag="iconfactory.hh::icon_size_get_name" ></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"> String icon_size_get_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> </td>
<td class="mdname1" valign="top" nowrap> <em>size</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>
Gets the canonical name of the given icon size.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>size</em> </td><td>An IconSize. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The name of the given icon size. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a299" doxytag="iconfactory.hh::icon_size_lookup" ></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 icon_size_lookup </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> </td>
<td class="mdname" nowrap> <em>size</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 class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>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>Settings * </td>
<td class="mdname" nowrap> <em>settings</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular <a class="el" href="classGFC_1_1Gtk_1_1Settings.html">Settings</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>size</em> </td><td>An icon size. </td></tr>
<tr><td></td><td valign=top><em>width</em> </td><td>The location to store icon width. </td></tr>
<tr><td></td><td valign=top><em>height</em> </td><td>The location to store icon height. </td></tr>
<tr><td></td><td valign=top><em>settings</em> </td><td>A <a class="el" href="classGFC_1_1Gtk_1_1Settings.html">Settings</a> object, used to determine which set of user preferences to use, or null to use the settings for the default screen. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if size was a valid size.</dd></dl>
<br>
Normally size would be ICON_SIZE_MENU, ICON_SIZE_BUTTON, etc. This method isn't normally needed, <a class="el" href="classGFC_1_1Gtk_1_1Widget.html#z1053_73">Gtk::Widget::render_icon()</a> is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by size_lookup(), because themes are free to render the pixbuf however they like, including changing the usual size.<p>
<b>Note:</b> The default GDK screen is the only screen in the absence of MultiHead support. </td>
</tr>
</table>
<a class="anchor" name="a301" doxytag="iconfactory.hh::icon_size_register" ></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="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> icon_size_register </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname" nowrap> <em>name</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 class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>height</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Registers a new icon size, along the same lines as ICON_SIZE_MENU, etc.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>name</em> </td><td>The name of the icon size. </td></tr>
<tr><td></td><td valign=top><em>width</em> </td><td>The icon width. </td></tr>
<tr><td></td><td valign=top><em>height</em> </td><td>The icon height. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The integer value for the size, as an IconSize. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a303" doxytag="iconfactory.hh::icon_size_register_alias" ></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 icon_size_register_alias </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname" nowrap> <em>alias</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> </td>
<td class="mdname" nowrap> <em>target</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Registers <em>alias</em> as another name for <em>target</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>alias</em> </td><td>An alias for target. </td></tr>
<tr><td></td><td valign=top><em>target</em> </td><td>An existing icon size.</td></tr>
</table>
</dl>
<br>
Calling size_from_name() with <em>alias</em> as the argument will return <em>target</em>. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:33 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>
|
