<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>gtkmm: Gtk::IconFactory Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <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">3.10.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <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><!-- top --> <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> | <a href="classGtk_1_1IconFactory-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Gtk::IconFactory Class Reference</div> </div> </div><!--header--> <div class="contents"> <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,155,115,181"/><area shape="rect" id="node3" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,80,131,107"/><area shape="rect" id="node4" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a5b84fb9d91507403e810cc836a0d7988"><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 class="separator:a5b84fb9d91507403e810cc836a0d7988"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a236e9524905fbdb226329b434434bf49"><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 class="memdesc:a236e9524905fbdb226329b434434bf49"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a236e9524905fbdb226329b434434bf49">More...</a><br/></td></tr> <tr class="separator:a236e9524905fbdb226329b434434bf49"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a47932b387dcb6738f3044a8a6dc7042c"><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 class="memdesc:a47932b387dcb6738f3044a8a6dc7042c"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a47932b387dcb6738f3044a8a6dc7042c">More...</a><br/></td></tr> <tr class="separator:a47932b387dcb6738f3044a8a6dc7042c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adc700884a0e461cebc9741628c853096"><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 class="memdesc:adc700884a0e461cebc9741628c853096"><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">More...</a><br/></td></tr> <tr class="separator:adc700884a0e461cebc9741628c853096"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae95a54ee507cbb2ee0a663c801e3c4a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#ae95a54ee507cbb2ee0a663c801e3c4a3">add</a> (const <a class="el" href="classGtk_1_1StockID.html">Gtk::StockID</a>& stock_id, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconSet.html">IconSet</a> >& icon_set)</td></tr> <tr class="memdesc:ae95a54ee507cbb2ee0a663c801e3c4a3"><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="#ae95a54ee507cbb2ee0a663c801e3c4a3">More...</a><br/></td></tr> <tr class="separator:ae95a54ee507cbb2ee0a663c801e3c4a3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a34e574113298733a1b503eeb6ef8b185"><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 class="memdesc:a34e574113298733a1b503eeb6ef8b185"><td class="mdescLeft"> </td><td class="mdescRight">Adds an icon factory to the list of icon factories searched by Gtk::Style::lookup_icon_set(). <a href="#a34e574113298733a1b503eeb6ef8b185">More...</a><br/></td></tr> <tr class="separator:a34e574113298733a1b503eeb6ef8b185"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1a5f7511da06fe11d671773872946218"><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 class="memdesc:a1a5f7511da06fe11d671773872946218"><td class="mdescLeft"> </td><td class="mdescRight">Removes an icon factory from the list of default icon factories. <a href="#a1a5f7511da06fe11d671773872946218">More...</a><br/></td></tr> <tr class="separator:a1a5f7511da06fe11d671773872946218"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:aa773d986238ba25e18bf101e2f571046"><td class="memItemLeft" align="right" valign="top">static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconFactory.html#aa773d986238ba25e18bf101e2f571046">get_type</a> ()</td></tr> <tr class="memdesc:aa773d986238ba25e18bf101e2f571046"><td class="mdescLeft"> </td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <a href="#aa773d986238ba25e18bf101e2f571046">More...</a><br/></td></tr> <tr class="separator:aa773d986238ba25e18bf101e2f571046"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7cc95658257598471ddba97630af0013"><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 class="separator:a7cc95658257598471ddba97630af0013"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a333322ae36c00c42160646eff3e61739"><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 class="separator:a333322ae36c00c42160646eff3e61739"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a> Related Functions</h2></td></tr> <tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> </td></tr> <tr class="memitem:a5def8d6c4a128983a36e695dca66957d"><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 class="memdesc:a5def8d6c4a128983a36e695dca66957d"><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">More...</a><br/></td></tr> <tr class="separator:a5def8d6c4a128983a36e695dca66957d"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000366">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> instead. </dd></dl> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a5b84fb9d91507403e810cc836a0d7988"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual Gtk::IconFactory::~IconFactory </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a333322ae36c00c42160646eff3e61739"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Gtk::IconFactory::IconFactory </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ae95a54ee507cbb2ee0a663c801e3c4a3"></a> <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="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <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> <p>Deprecated: 3.10: Use <a class="el" href="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> instead. </p> <dl class="params"><dt>Parameters</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> <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 Gtk::Style::lookup_icon_set(). </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> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="aa773d986238ba25e18bf101e2f571046"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static GType Gtk::IconFactory::get_type </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the GType for this class, for use with the underlying GObject type system. </p> </div> </div> <a class="anchor" id="a236e9524905fbdb226329b434434bf49"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">GtkIconFactory* Gtk::IconFactory::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Provides access to the underlying C GObject. </p> </div> </div> <a class="anchor" id="a47932b387dcb6738f3044a8a6dc7042c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const GtkIconFactory* Gtk::IconFactory::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Provides access to the underlying C GObject. </p> </div> </div> <a class="anchor" id="adc700884a0e461cebc9741628c853096"></a> <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> <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> <p>Deprecated: 3.10: Use <a class="el" href="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> instead. </p> </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a class="anchor" id="a5def8d6c4a128983a36e695dca66957d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">related</span></span> </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 class="params"><dt>Parameters</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="section return"><dt>Returns</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><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>