<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>gtkmm 2.4: Gtk::IconFactory Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head> <body bgcolor="#ffffff"> <table border="0" width="100%"> <tr> <td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td> <td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td> </tr> </table> <center> <a class="qindex" href="../../index.html">Main Page</a> <a href="group__Widgets.html">Widgets</a> <a class="qindex" href="namespaces.html"> Namespaces</a> <a href="../../tutorial/html/index.html"> Book</a> </center> <hr width="100%"/> <!-- begin main content --> <div id="content"> <!-- Generated by Doxygen 1.5.1 --> <div class="nav"> <a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1IconFactory.html">IconFactory</a></div> <h1>Gtk::IconFactory Class Reference</h1><!-- doxytag: class="Gtk::IconFactory" --><!-- doxytag: inherits="Glib::Object" -->Inheritance diagram for Gtk::IconFactory:<p><center><img src="classGtk_1_1IconFactory__inherit__graph.png" border="0" usemap="#Gtk_1_1IconFactory__inherit__map" alt="Inheritance graph"></center> <map name="Gtk_1_1IconFactory__inherit__map"> <area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Object.html" shape="rect" coords="21,161,115,188" alt=""> <area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="5,84,131,111" alt=""> <area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="12,7,124,33" alt=""> </map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGtk_1_1IconFactory-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#e434f4828ed17959165ef6309e923d3e">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="#e434f4828ed17959165ef6309e923d3e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#34e574113298733a1b503eeb6ef8b185">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#56707668788ba2b3fcb75fdac47668bd">Gtk::Style::lookup_icon_set()</a>. <a href="#34e574113298733a1b503eeb6ef8b185"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const GtkIconFactory* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#e889dde0a5a3b690c568e65911b40252">gobj</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#e889dde0a5a3b690c568e65911b40252"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">GtkIconFactory* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#236e9524905fbdb226329b434434bf49">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#236e9524905fbdb226329b434434bf49"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">GtkIconFactory* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#dc700884a0e461cebc9741628c853096">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="#dc700884a0e461cebc9741628c853096"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#1a5f7511da06fe11d671773872946218">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="#1a5f7511da06fe11d671773872946218"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#5b84fb9d91507403e810cc836a0d7988">~IconFactory</a> ()</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#7cc95658257598471ddba97630af0013">create</a> ()</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#333322ae36c00c42160646eff3e61739">IconFactory</a> ()</td></tr> <tr><td colspan="2"><br><h2>Related Functions</h2></td></tr> <tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#5def8d6c4a128983a36e695dca66957d">wrap</a> (GtkIconFactory* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#5def8d6c4a128983a36e695dca66957d"></a><br></td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="5b84fb9d91507403e810cc836a0d7988"></a><!-- doxytag: member="Gtk::IconFactory::~IconFactory" ref="5b84fb9d91507403e810cc836a0d7988" 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 width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="333322ae36c00c42160646eff3e61739"></a><!-- doxytag: member="Gtk::IconFactory::IconFactory" ref="333322ae36c00c42160646eff3e61739" 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 width="100%"><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="e434f4828ed17959165ef6309e923d3e"></a><!-- doxytag: member="Gtk::IconFactory::add" ref="e434f4828ed17959165ef6309e923d3e" 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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></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> <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#34e574113298733a1b503eeb6ef8b185">add_default()</a>. Then they pass the <em>stock_id</em> to widgets such as <a class="el" href="classGtk_1_1Image.html">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> . <dl compact><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> </td><td>Icon name. </td></tr> <tr><td valign="top"></td><td valign="top"><em>icon_set</em> </td><td>Icon set. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="34e574113298733a1b503eeb6ef8b185"></a><!-- doxytag: member="Gtk::IconFactory::add_default" ref="34e574113298733a1b503eeb6ef8b185" 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 width="100%"></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#56707668788ba2b3fcb75fdac47668bd">Gtk::Style::lookup_icon_set()</a>. <p> This means that, for example, the Image::Image(const Gtk::StockID& stock_id, IconSize size) 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. </div> </div><p> <a class="anchor" name="7cc95658257598471ddba97630af0013"></a><!-- doxytag: member="Gtk::IconFactory::create" ref="7cc95658257598471ddba97630af0013" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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 width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="e889dde0a5a3b690c568e65911b40252"></a><!-- doxytag: member="Gtk::IconFactory::gobj" ref="e889dde0a5a3b690c568e65911b40252" 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 width="100%"> 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_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html#2b7010748d60e770e9e0b3d65c100cf2">Glib::ObjectBase</a>. </div> </div><p> <a class="anchor" name="236e9524905fbdb226329b434434bf49"></a><!-- doxytag: member="Gtk::IconFactory::gobj" ref="236e9524905fbdb226329b434434bf49" 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 width="100%"><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_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>. </div> </div><p> <a class="anchor" name="dc700884a0e461cebc9741628c853096"></a><!-- doxytag: member="Gtk::IconFactory::gobj_copy" ref="dc700884a0e461cebc9741628c853096" 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 width="100%"></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><p> <a class="anchor" name="1a5f7511da06fe11d671773872946218"></a><!-- doxytag: member="Gtk::IconFactory::remove_default" ref="1a5f7511da06fe11d671773872946218" 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 width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Removes an icon factory from the list of default icon factories. <p> Not normally used; you might use it for a library that can be unloaded or shut down. </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="5def8d6c4a128983a36e695dca66957d"></a><!-- doxytag: member="Gtk::IconFactory::wrap" ref="5def8d6c4a128983a36e695dca66957d" 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_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p> A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr> <tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="iconfactory_8h.html">iconfactory.h</a></ul> </div> <!-- end main content --> <hr><address><small> Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html"> Doxygen</a> 1.5.1 © 1997-2001</small></address> </body> </html>