<!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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gtkmm <span id="projectnumber">2.24.4</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related 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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
<li class="navelem"><a class="el" href="classGtk_1_1IconFactory.html">IconFactory</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Gtk::IconFactory Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Gtk::IconFactory" --><!-- doxytag: inherits="Glib::Object" --><div class="dynheader">
Inheritance diagram for Gtk::IconFactory:</div>
<div class="dyncontent">
<div class="center"><img src="classGtk_1_1IconFactory__inherit__graph.png" border="0" usemap="#Gtk_1_1IconFactory_inherit__map" alt="Inheritance graph"/></div>
<map name="Gtk_1_1IconFactory_inherit__map" id="Gtk_1_1IconFactory_inherit__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Gtk::IconFactory:</div>
<div class="dyncontent">
<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" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,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 class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </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* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a236e9524905fbdb226329b434434bf49">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </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* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a47932b387dcb6738f3044a8a6dc7042c">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </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* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#adc700884a0e461cebc9741628c853096">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </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 </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>& stock_id, const <a class="el" href="classGtk_1_1IconSet.html">IconSet</a>& icon_set)</td></tr>
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a34e574113298733a1b503eeb6ef8b185">add_default</a> ()</td></tr>
<tr><td class="mdescLeft"> </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 factory...">Gtk::Style::lookup_icon_set()</a>. <a href="#a34e574113298733a1b503eeb6ef8b185"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a1a5f7511da06fe11d671773872946218">remove_default</a> ()</td></tr>
<tr><td class="mdescLeft"> </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><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconFactory.html">IconFactory</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a7cc95658257598471ddba97630af0013">create</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#a333322ae36c00c42160646eff3e61739">IconFactory</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconFactory.html">Gtk::IconFactory</a> > </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"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a5def8d6c4a128983a36e695dca66957d"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & 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>)</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>)</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 &stock_id, const IconSet &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>& </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>& </td>
<td class="paramname"><em>icon_set</em> </td>
</tr>
<tr>
<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 class="params">
<tr><td class="paramname">stock_id</td><td>Icon name. </td></tr>
<tr><td class="paramname">icon_set</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>)</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 factory...">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& 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" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1IconFactory.html">IconFactory</a>> Gtk::IconFactory::create </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</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>)</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" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</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>)</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" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">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>)</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>)</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" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconFactory.html">Gtk::IconFactory</a> > wrap </td>
<td>(</td>
<td class="paramtype">GtkIconFactory * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</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 class="footer"/><address class="footer"><small>Generated on Tue Jun 25 2013 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
