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
|
<!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::Gtk::IconFactory Class Reference</h1>A GtkIconFactory C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="iconfactory_8hh-source.html">gfc/gtk/iconfactory.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::IconFactory:
<p><center><img src="classGFC_1_1Gtk_1_1IconFactory.png" usemap="#GFC::Gtk::IconFactory_map" border="0" alt=""></center>
<map name="GFC::Gtk::IconFactory_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,136,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,136,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,136,24">
</map>
<a href="classGFC_1_1Gtk_1_1IconFactory-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z575_0" doxytag="GFC::Gtk::IconFactory::IconFactory" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z575_0">IconFactory</a> ()
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a>. <br></dl><li><a class="anchor" name="z575_1" doxytag="GFC::Gtk::IconFactory::~IconFactory" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z575_1">~IconFactory</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z576_0" doxytag="GFC::Gtk::IconFactory::gtk_icon_factory" ></a>
GtkIconFactory * <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z576_0">gtk_icon_factory</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkIconFactory structure. <br></dl><li><a class="anchor" name="z576_1" doxytag="GFC::Gtk::IconFactory::operator GtkIconFactory *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z576_1">operator GtkIconFactory *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a> to a GtkIconFactory pointer. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z577_0">add</a> (const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> &stock_id, <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> &icon_set)
<dl class="el"><dd class="mdescRight">Adds the given icon_set to the icon factory, under the name stock_id. <a href="#z577_0"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> > <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z577_1">lookup</a> (const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> &stock_id)
<dl class="el"><dd class="mdescRight">Looks up <em>stock_id</em> in the icon factory, returning an icon set if found, otherwise null. <a href="#z577_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z577_2">add_default</a> ()
<dl class="el"><dd class="mdescRight">Adds the <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a> to the list of icon factories searched by <a class="el" href="classGFC_1_1Gtk_1_1Style.html#z850_3">Gtk::Style::lookup_icon_set()</a>. <a href="#z577_2"></a><br></dl><li><a class="anchor" name="z577_3" doxytag="GFC::Gtk::IconFactory::remove_default" ></a>
void <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z577_3">remove_default</a> ()
<dl class="el"><dd class="mdescRight">Removes the <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a> from the list of default icon factories. <br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> > <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#e0">lookup_default</a> (const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> &stock_id)
<dl class="el"><dd class="mdescRight">Looks for an icon set in the list of default icon factories. <a href="#e0"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z574_0">IconFactory</a> (GtkIconFactory *icon_factory, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a> from an existing GtkIconFactory. <a href="#z574_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkIconFactory C++ wrapper class.
<p>
An icon factory manages a collection of IconSets; an <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> manages a set of variants of a particular icon (i.e. a <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> contains variants for different sizes and widget states). Icons in an icon factory are named by a stock ID, which is a simple string identifying the icon. Each <a class="el" href="classGFC_1_1Gtk_1_1Style.html">Style</a> has a list of IconFactorys derived from the current theme; those icon factories are consulted first when searching for an icon. If the theme doesn't set a particular icon, GTK+ looks for the icon in a list of default icon factories, maintained by IconFactory's <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z577_2">add_default()</a> and <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z577_3">remove_default()</a> methods. Applications with icons should add a default icon factory with their icons, which will allow themes to override the icons for the application (see application.cc in the gfc-demo demo program).
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z574_0" doxytag="GFC::Gtk::IconFactory::IconFactory" ></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"> GFC::Gtk::IconFactory::IconFactory </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkIconFactory * </td>
<td class="mdname" nowrap> <em>icon_factory</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a> from an existing GtkIconFactory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>icon_factory</em> </td><td>A pointer to a GtkIconFactory. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>icon_factory</em> can be a newly created GtkIconFactory or an existing GtkIconFactory (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z577_0" doxytag="GFC::Gtk::IconFactory::add" ></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::Gtk::IconFactory::add </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> & </td>
<td class="mdname" nowrap> <em>stock_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> & </td>
<td class="mdname" nowrap> <em>icon_set</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>
Adds the given icon_set to the icon factory, under the name stock_id.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>stock_id</em> </td><td>The stock icon identifier. </td></tr>
<tr><td></td><td valign=top><em>icon_set</em> </td><td>The icon set.</td></tr>
</table>
</dl>
<br>
The <em>stock_id</em> should be namespaced for your application, e.g. "myapp-whatever-icon". Normally applications create an <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a>, then add it to the list of default factories with <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html#z577_2">add_default()</a>. Then they pass the stock_id to widgets such as <a class="el" href="classGFC_1_1Gtk_1_1Image.html">Image</a> to display the icon. Themes can provide an icon with the same name (such as "myapp-whatever-icon") to override your application's default icons. If an icon already existed in factory for stock_id, it is unreferenced and replaced with the new icon_set. </td>
</tr>
</table>
<a class="anchor" name="z577_2" doxytag="GFC::Gtk::IconFactory::add_default" ></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::Gtk::IconFactory::add_default </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </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>
Adds the <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a> to the list of icon factories searched by <a class="el" href="classGFC_1_1Gtk_1_1Style.html#z850_3">Gtk::Style::lookup_icon_set()</a>.
<p>
This means that, for example, a stock <a class="el" href="classGFC_1_1Gtk_1_1Image.html">Image</a> widget will be able to find icons in an icon factory. There will normally be an icon factory added for each library or application that comes with icons. The default icon factories can be overridden by themes. </td>
</tr>
</table>
<a class="anchor" name="z577_1" doxytag="GFC::Gtk::IconFactory::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"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a>> GFC::Gtk::IconFactory::lookup </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>stock_id</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 <em>stock_id</em> in the icon factory, returning an icon set if found, otherwise null.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>stock_id</em> </td><td>The stock icon identifier. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The icon set of stock_id.</dd></dl>
<br>
For display to the user, use <a class="el" href="classGFC_1_1Gtk_1_1Style.html#z850_3">Gtk::Style::lookup_icon_set()</a> for the widget that will display the icon instead of using this method directly, so that themes are taken into account. </td>
</tr>
</table>
<a class="anchor" name="e0" doxytag="GFC::Gtk::IconFactory::lookup_default" ></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_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a>> GFC::Gtk::IconFactory::lookup_default </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>stock_id</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Looks for an icon set in the list of default icon factories.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>stock_id</em> </td><td>The stock icon identifier. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The icon set of stock_id.</dd></dl>
<br>
For display to the user, use <a class="el" href="classGFC_1_1Gtk_1_1Style.html#z850_3">Gtk::Style::lookup_icon_set()</a> for the widget that will display the icon instead of using this method directly, so that themes are taken into account. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="iconfactory_8hh-source.html">iconfactory.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:40 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>
|
