File: classGtk_1_1IconFactory.html

package info (click to toggle)
gtkmm2.4 1%3A2.20.3-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 73,860 kB
  • ctags: 20,553
  • sloc: xml: 79,575; sh: 10,120; cpp: 8,347; makefile: 290
file content (306 lines) | stat: -rw-r--r-- 19,024 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::IconFactory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1IconFactory.html">IconFactory</a>
  </div>
</div>
<div class="contents">
<h1>Gtk::IconFactory Class Reference</h1><!-- doxytag: class="Gtk::IconFactory" --><!-- doxytag: inherits="Glib::Object" -->
<p>Inherits <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html">Glib::Object</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::IconFactory:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1IconFactory__coll__graph.png" border="0" usemap="#Gtk_1_1IconFactory_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1IconFactory_coll__map" id="Gtk_1_1IconFactory_coll__map">
<area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,160,111,189"/><area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,125,112"/><area shape="rect" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,119,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classGtk_1_1IconFactory-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a5b84fb9d91507403e810cc836a0d7988">~IconFactory</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkIconFactory*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a236e9524905fbdb226329b434434bf49">gobj</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a236e9524905fbdb226329b434434bf49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkIconFactory*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a47932b387dcb6738f3044a8a6dc7042c">gobj</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a47932b387dcb6738f3044a8a6dc7042c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkIconFactory*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#adc700884a0e461cebc9741628c853096">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#adc700884a0e461cebc9741628c853096"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#ae434f4828ed17959165ef6309e923d3e">add</a> (const <a class="el" href="classGtk_1_1StockID.html">Gtk::StockID</a>&amp; stock_id, const <a class="el" href="classGtk_1_1IconSet.html">IconSet</a>&amp; icon_set)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the given <em>icon_set</em> to the icon factory, under the name <em>stock_id</em>. <a href="#ae434f4828ed17959165ef6309e923d3e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a34e574113298733a1b503eeb6ef8b185">add_default</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an icon factory to the list of icon factories searched by <a class="el" href="classGtk_1_1Style.html#a56707668788ba2b3fcb75fdac47668bd" title="Looks up stock_id in the icon factories associated with style and the default icon...">Gtk::Style::lookup_icon_set()</a>. <a href="#a34e574113298733a1b503eeb6ef8b185"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a1a5f7511da06fe11d671773872946218">remove_default</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes an icon factory from the list of default icon factories. <a href="#a1a5f7511da06fe11d671773872946218"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGtk_1_1IconFactory.html">IconFactory</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a7cc95658257598471ddba97630af0013">create</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a333322ae36c00c42160646eff3e61739">IconFactory</a> ()</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGtk_1_1IconFactory.html">Gtk::IconFactory</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a5def8d6c4a128983a36e695dca66957d">wrap</a> (GtkIconFactory* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a5def8d6c4a128983a36e695dca66957d"></a><br/></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5b84fb9d91507403e810cc836a0d7988"></a><!-- doxytag: member="Gtk::IconFactory::~IconFactory" ref="a5b84fb9d91507403e810cc836a0d7988" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gtk::IconFactory::~IconFactory </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a333322ae36c00c42160646eff3e61739"></a><!-- doxytag: member="Gtk::IconFactory::IconFactory" ref="a333322ae36c00c42160646eff3e61739" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gtk::IconFactory::IconFactory </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae434f4828ed17959165ef6309e923d3e"></a><!-- doxytag: member="Gtk::IconFactory::add" ref="ae434f4828ed17959165ef6309e923d3e" args="(const Gtk::StockID &amp;stock_id, const IconSet &amp;icon_set)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gtk::IconFactory::add </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">Gtk::StockID</a>&amp;&#160;</td>
          <td class="paramname"> <em>stock_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classGtk_1_1IconSet.html">IconSet</a>&amp;&#160;</td>
          <td class="paramname"> <em>icon_set</em></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Adds the given <em>icon_set</em> to the icon factory, under the name <em>stock_id</em>. </p>
<p><em>stock_id</em> should be namespaced for your application, e.g. "myapp-whatever-icon". Normally applications create a <a class="el" href="classGtk_1_1IconFactory.html">Gtk::IconFactory</a>, then add it to the list of default factories with <a class="el" href="classGtk_1_1IconFactory.html#a34e574113298733a1b503eeb6ef8b185" title="Adds an icon factory to the list of icon factories searched by Gtk::Style::lookup_icon_set()...">add_default()</a>. Then they pass the <em>stock_id</em> to widgets such as <a class="el" href="classGtk_1_1Image.html" title="A widget displaying an image.">Gtk::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 <em>factory</em> for <em>stock_id</em>, it is unreferenced and replaced with the new <em>icon_set</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>stock_id</em>&#160;</td><td>Icon name. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>icon_set</em>&#160;</td><td>Icon set. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a34e574113298733a1b503eeb6ef8b185"></a><!-- doxytag: member="Gtk::IconFactory::add_default" ref="a34e574113298733a1b503eeb6ef8b185" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gtk::IconFactory::add_default </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Adds an icon factory to the list of icon factories searched by <a class="el" href="classGtk_1_1Style.html#a56707668788ba2b3fcb75fdac47668bd" title="Looks up stock_id in the icon factories associated with style and the default icon...">Gtk::Style::lookup_icon_set()</a>. </p>
<p>This means that, for example, the <a class="el" href="classGtk_1_1Image.html#a4ad061304523827b7249d76827444914" title="Creates am Image displaying a stock icon.">Image::Image(const Gtk::StockID&amp; stock_id, IconSize size)</a> constructor will be able to find icons in <em>factory</em>. 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. </p>

</div>
</div>
<a class="anchor" id="a7cc95658257598471ddba97630af0013"></a><!-- doxytag: member="Gtk::IconFactory::create" ref="a7cc95658257598471ddba97630af0013" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGtk_1_1IconFactory.html">IconFactory</a>&gt; Gtk::IconFactory::create </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a47932b387dcb6738f3044a8a6dc7042c"></a><!-- doxytag: member="Gtk::IconFactory::gobj" ref="a47932b387dcb6738f3044a8a6dc7042c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const GtkIconFactory* Gtk::IconFactory::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GObject. </p>

<p>Reimplemented from <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>

</div>
</div>
<a class="anchor" id="a236e9524905fbdb226329b434434bf49"></a><!-- doxytag: member="Gtk::IconFactory::gobj" ref="a236e9524905fbdb226329b434434bf49" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GtkIconFactory* Gtk::IconFactory::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GObject. </p>

<p>Reimplemented from <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>

</div>
</div>
<a class="anchor" id="adc700884a0e461cebc9741628c853096"></a><!-- doxytag: member="Gtk::IconFactory::gobj_copy" ref="adc700884a0e461cebc9741628c853096" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GtkIconFactory* Gtk::IconFactory::gobj_copy </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>

</div>
</div>
<a class="anchor" id="a1a5f7511da06fe11d671773872946218"></a><!-- doxytag: member="Gtk::IconFactory::remove_default" ref="a1a5f7511da06fe11d671773872946218" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gtk::IconFactory::remove_default </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Removes an icon factory from the list of default icon factories. </p>
<p>Not normally used; you might use it for a library that can be unloaded or shut down. </p>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a5def8d6c4a128983a36e695dca66957d"></a><!-- doxytag: member="Gtk::IconFactory::wrap" ref="a5def8d6c4a128983a36e695dca66957d" args="(GtkIconFactory *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGtk_1_1IconFactory.html">Gtk::IconFactory</a> &gt; wrap </td>
          <td>(</td>
          <td class="paramtype">GtkIconFactory *&#160;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&#160;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&#160;</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/iconfactory.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:53 2010 for gtkmm by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>