<!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>glibmm: Gio::ThemedIcon 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 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> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1ThemedIcon.html">ThemedIcon</a> </div> </div> <div class="contents"> <h1>Gio::ThemedIcon Class Reference</h1><!-- doxytag: class="Gio::ThemedIcon" --><!-- doxytag: inherits="Glib::Object,Gio::Icon" --> <p><a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Icon</a> theming support <a class="el" href="classGio_1_1ThemedIcon.html" title="Icon theming support ThemedIcon is an implementation of Gio::Icon that supports icon...">ThemedIcon</a> is an implementation of <a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Gio::Icon</a> that supports icon themes. <a href="#_details">More...</a></p> <p>Inherits <a class="el" href="classGlib_1_1Object.html">Glib::Object</a>, and <a class="el" href="classGio_1_1Icon.html">Gio::Icon</a>.</p> <div class="dynheader"> Collaboration diagram for Gio::ThemedIcon:</div> <div class="dynsection"> <div class="center"><img src="classGio_1_1ThemedIcon__coll__graph.png" border="0" usemap="#Gio_1_1ThemedIcon_coll__map" alt="Collaboration graph"/></div> <map name="Gio_1_1ThemedIcon_coll__map" id="Gio_1_1ThemedIcon_coll__map"> <area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,237,96,267"/><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="39,83,159,112"/><area shape="rect" href="classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="100,160,204,189"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="45,5,152,35"/><area shape="rect" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons." alt="" coords="120,237,195,267"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGio_1_1ThemedIcon-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#ac5c41faafeffac479079e871edc4a66f">~ThemedIcon</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">GThemedIcon* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#aa179d9788f6a17df73a258c6f89049fd">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aa179d9788f6a17df73a258c6f89049fd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const GThemedIcon* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#ac962dc5a62c1d2b19611a497d92671ba">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ac962dc5a62c1d2b19611a497d92671ba"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">GThemedIcon* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#a077eea103e0f5713697f55cb66243997">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="#a077eea103e0f5713697f55cb66243997"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#aa61fe78bdd8512c138a3ec23c6fa32f6">prepend_name</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& iconname)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prepend a name to the list of icons from within <em>icon</em>. <a href="#aa61fe78bdd8512c138a3ec23c6fa32f6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#a15fb8158d3eede3d3aa4050fbdcbe124">append_name</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& iconname)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Append a name to the list of icons from within <em>icon</em>. <a href="#a15fb8158d3eede3d3aa4050fbdcbe124"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/> < bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#add0cea54573bfff7a41d0f8d60445ced">property_use_default_fallbacks</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Whether to use default fallbacks found by shortening the name at '-' characters. <a href="#add0cea54573bfff7a41d0f8d60445ced"></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="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1ThemedIcon.html">ThemedIcon</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#a843b98f320f1aa6316d55f266fbf8219">create</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& iconname, bool use_default_callbacks=false)</td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#ac378bb89f60335fe0c24e10ce96cba12">ThemedIcon</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& iconname, bool use_default_callbacks=false)</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="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1ThemedIcon.html">Gio::ThemedIcon</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1ThemedIcon.html#a6e1861d53d63b929cd84e012e704c396">wrap</a> (GThemedIcon* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a6e1861d53d63b929cd84e012e704c396"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p><a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Icon</a> theming support <a class="el" href="classGio_1_1ThemedIcon.html" title="Icon theming support ThemedIcon is an implementation of Gio::Icon that supports icon...">ThemedIcon</a> is an implementation of <a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Gio::Icon</a> that supports icon themes. </p> <p><a class="el" href="classGio_1_1ThemedIcon.html" title="Icon theming support ThemedIcon is an implementation of Gio::Icon that supports icon...">ThemedIcon</a> contains a list of all of the icons present in an icon theme, so that icons can be looked up quickly. <a class="el" href="classGio_1_1ThemedIcon.html" title="Icon theming support ThemedIcon is an implementation of Gio::Icon that supports icon...">ThemedIcon</a> does not provide actual pixmaps for icons, just the icon names. Ideally something like Gtk::IconTheme::choose_icon() should be used to resolve the list of names so that fallback icons work nicely with themes that inherit other themes.</p> <dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000043">Since glibmm 2.16:</a></b></dt><dd></dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac5c41faafeffac479079e871edc4a66f"></a><!-- doxytag: member="Gio::ThemedIcon::~ThemedIcon" ref="ac5c41faafeffac479079e871edc4a66f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Gio::ThemedIcon::~ThemedIcon </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="ac378bb89f60335fe0c24e10ce96cba12"></a><!-- doxytag: member="Gio::ThemedIcon::ThemedIcon" ref="ac378bb89f60335fe0c24e10ce96cba12" args="(const std::string &iconname, bool use_default_callbacks=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gio::ThemedIcon::ThemedIcon </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td> <td class="paramname"> <em>iconname</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>use_default_callbacks</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [explicit, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a15fb8158d3eede3d3aa4050fbdcbe124"></a><!-- doxytag: member="Gio::ThemedIcon::append_name" ref="a15fb8158d3eede3d3aa4050fbdcbe124" args="(const std::string &iconname)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gio::ThemedIcon::append_name </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td> <td class="paramname"> <em>iconname</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Append a name to the list of icons from within <em>icon</em>. </p> <p><note></p> <p>Note that doing so invalidates the hash computed by prior calls to g_icon_hash(). </p> <p></note> </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>iconname</em> </td><td>Name of icon to append to list of icons from within <em>icon</em>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a843b98f320f1aa6316d55f266fbf8219"></a><!-- doxytag: member="Gio::ThemedIcon::create" ref="a843b98f320f1aa6316d55f266fbf8219" args="(const std::string &iconname, bool use_default_callbacks=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1ThemedIcon.html">ThemedIcon</a>> Gio::ThemedIcon::create </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td> <td class="paramname"> <em>iconname</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>use_default_callbacks</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ac962dc5a62c1d2b19611a497d92671ba"></a><!-- doxytag: member="Gio::ThemedIcon::gobj" ref="ac962dc5a62c1d2b19611a497d92671ba" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GThemedIcon* Gio::ThemedIcon::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="el" href="classGio_1_1Icon.html#a94b7e4b63ce6c1c0f05673dd8b4adf94">Gio::Icon</a>.</p> </div> </div> <a class="anchor" id="aa179d9788f6a17df73a258c6f89049fd"></a><!-- doxytag: member="Gio::ThemedIcon::gobj" ref="aa179d9788f6a17df73a258c6f89049fd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GThemedIcon* Gio::ThemedIcon::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="el" href="classGio_1_1Icon.html#a02ef784d9a07a205ce1d7daac39d2054">Gio::Icon</a>.</p> </div> </div> <a class="anchor" id="a077eea103e0f5713697f55cb66243997"></a><!-- doxytag: member="Gio::ThemedIcon::gobj_copy" ref="a077eea103e0f5713697f55cb66243997" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GThemedIcon* Gio::ThemedIcon::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="aa61fe78bdd8512c138a3ec23c6fa32f6"></a><!-- doxytag: member="Gio::ThemedIcon::prepend_name" ref="aa61fe78bdd8512c138a3ec23c6fa32f6" args="(const std::string &iconname)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gio::ThemedIcon::prepend_name </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td> <td class="paramname"> <em>iconname</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Prepend a name to the list of icons from within <em>icon</em>. </p> <p><note></p> <p>Note that doing so invalidates the hash computed by prior calls to g_icon_hash(). </p> <p></note></p> <dl class="since_2_18"><dt><b><a class="el" href="since_2_18.html#_since_2_18000026">Since glibmm 2.18:</a></b></dt><dd></dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>iconname</em> </td><td>Name of icon to prepend to list of icons from within <em>icon</em>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="add0cea54573bfff7a41d0f8d60445ced"></a><!-- doxytag: member="Gio::ThemedIcon::property_use_default_fallbacks" ref="add0cea54573bfff7a41d0f8d60445ced" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gio::ThemedIcon::property_use_default_fallbacks </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Whether to use default fallbacks found by shortening the name at '-' characters. </p> <p>Ignores names after the first if multiple names are given.</p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a6e1861d53d63b929cd84e012e704c396"></a><!-- doxytag: member="Gio::ThemedIcon::wrap" ref="a6e1861d53d63b929cd84e012e704c396" args="(GThemedIcon *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1ThemedIcon.html">Gio::ThemedIcon</a> > wrap </td> <td>(</td> <td class="paramtype">GThemedIcon * </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><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A <a class="el" href="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> </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> </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>giomm/themedicon.h</li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 11:07:24 2009 for glibmm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>