<!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::Emblem 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_1Emblem.html">Emblem</a>
</div>
</div>
<div class="contents">
<h1>Gio::Emblem Class Reference</h1><!-- doxytag: class="Gio::Emblem" --><!-- doxytag: inherits="Glib::Object,Gio::Icon" -->
<p>An object for emblems. <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::Emblem:</div>
<div class="dynsection">
<div class="center"><img src="classGio_1_1Emblem__coll__graph.png" border="0" usemap="#Gio_1_1Emblem_coll__map" alt="Collaboration graph"/></div>
<map name="Gio_1_1Emblem_coll__map" id="Gio_1_1Emblem_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_1Emblem-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_1Emblem.html#a3b0b61279f632bcac5894004b99c5f4b">~Emblem</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GEmblem* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#a18a84361942885e0b75a82ffbc342947">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a18a84361942885e0b75a82ffbc342947"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GEmblem* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#aedc2ab1a8682aff33ba0dbdaf5d05afb">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aedc2ab1a8682aff33ba0dbdaf5d05afb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GEmblem* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#a37489c6af0fd3ebcc26f2ad70499ab69">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="#a37489c6af0fd3ebcc26f2ad70499ab69"></a><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_1Icon.html">Icon</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#a2272bb4eb06787a561eae7593912aa04">get_icon</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gives back the icon from <em>emblem</em>. <a href="#a2272bb4eb06787a561eae7593912aa04"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGio_1_1Icon.html">Icon</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#aaea925c28921a3d9a5e772aace7a2ff4">get_icon</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gives back the icon from <em>emblem</em>. <a href="#aaea925c28921a3d9a5e772aace7a2ff4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__giommEnums.html#ga7f2c8f757fdeb91ca48c0bc8184f9270">EmblemOrigin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#ae2e37f3de1e0d50b50a3ba4e9ff3d30f">get_origin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the origin of the emblem. <a href="#ae2e37f3de1e0d50b50a3ba4e9ff3d30f"></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_1Emblem.html">Emblem</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#a73b765b853f364b1681352efc8a73a69">create</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1Icon.html">Icon</a> >& icon)</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_1Emblem.html">Emblem</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#a49167949418fba4e254c3044b5b2808d">create</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1Icon.html">Icon</a> >& icon, <a class="el" href="group__giommEnums.html#ga7f2c8f757fdeb91ca48c0bc8184f9270">EmblemOrigin</a> origin)</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_1Emblem.html#a145a95e9ca6ee5d31be2c94be935c060">Emblem</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1Icon.html">Icon</a> >& icon)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#a2ff0e5c38e6fc97b2c57188099304fef">Emblem</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1Icon.html">Icon</a> >& icon, <a class="el" href="group__giommEnums.html#ga7f2c8f757fdeb91ca48c0bc8184f9270">EmblemOrigin</a> origin)</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_1Emblem.html">Gio::Emblem</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Emblem.html#a53ecca7bfb4c8b1e3ac4305a8087bf3e">wrap</a> (GEmblem* 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="#a53ecca7bfb4c8b1e3ac4305a8087bf3e"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An object for emblems. </p>
<p><a class="el" href="classGio_1_1Emblem.html" title="An object for emblems.">Emblem</a> is an implementation of GIcon that supports having an emblem, which is an icon with additional properties. It can than be added to a <a class="el" href="classGio_1_1EmblemedIcon.html" title="Icons with Emblems.">EmblemedIcon</a>.</p>
<p>Currently, only metainformation about the emblem's origin is supported. More may be added in the future.</p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000008">Since glibmm 2.20:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3b0b61279f632bcac5894004b99c5f4b"></a><!-- doxytag: member="Gio::Emblem::~Emblem" ref="a3b0b61279f632bcac5894004b99c5f4b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gio::Emblem::~Emblem </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="a145a95e9ca6ee5d31be2c94be935c060"></a><!-- doxytag: member="Gio::Emblem::Emblem" ref="a145a95e9ca6ee5d31be2c94be935c060" args="(const Glib::RefPtr< Icon > &icon)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gio::Emblem::Emblem </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1Icon.html">Icon</a> >& </td>
<td class="paramname"> <em>icon</em></td>
<td> ) </td>
<td><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2ff0e5c38e6fc97b2c57188099304fef"></a><!-- doxytag: member="Gio::Emblem::Emblem" ref="a2ff0e5c38e6fc97b2c57188099304fef" args="(const Glib::RefPtr< Icon > &icon, EmblemOrigin origin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gio::Emblem::Emblem </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1Icon.html">Icon</a> >& </td>
<td class="paramname"> <em>icon</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__giommEnums.html#ga7f2c8f757fdeb91ca48c0bc8184f9270">EmblemOrigin</a> </td>
<td class="paramname"> <em>origin</em></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="a49167949418fba4e254c3044b5b2808d"></a><!-- doxytag: member="Gio::Emblem::create" ref="a49167949418fba4e254c3044b5b2808d" args="(const Glib::RefPtr< Icon > &icon, EmblemOrigin origin)" -->
<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_1Emblem.html">Emblem</a>> Gio::Emblem::create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1Icon.html">Icon</a> >& </td>
<td class="paramname"> <em>icon</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__giommEnums.html#ga7f2c8f757fdeb91ca48c0bc8184f9270">EmblemOrigin</a> </td>
<td class="paramname"> <em>origin</em></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="a73b765b853f364b1681352efc8a73a69"></a><!-- doxytag: member="Gio::Emblem::create" ref="a73b765b853f364b1681352efc8a73a69" args="(const Glib::RefPtr< Icon > &icon)" -->
<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_1Emblem.html">Emblem</a>> Gio::Emblem::create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1Icon.html">Icon</a> >& </td>
<td class="paramname"> <em>icon</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aaea925c28921a3d9a5e772aace7a2ff4"></a><!-- doxytag: member="Gio::Emblem::get_icon" ref="aaea925c28921a3d9a5e772aace7a2ff4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGio_1_1Icon.html">Icon</a>> Gio::Emblem::get_icon </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gives back the icon from <em>emblem</em>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Icon</a>. The returned object belongs to the emblem and should not be modified or freed.</dd></dl>
<dl class="since_2_18"><dt><b><a class="el" href="since_2_18.html#_since_2_18000007">Since glibmm 2.18:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a2272bb4eb06787a561eae7593912aa04"></a><!-- doxytag: member="Gio::Emblem::get_icon" ref="a2272bb4eb06787a561eae7593912aa04" args="()" -->
<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_1Icon.html">Icon</a>> Gio::Emblem::get_icon </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gives back the icon from <em>emblem</em>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Icon</a>. The returned object belongs to the emblem and should not be modified or freed.</dd></dl>
<dl class="since_2_18"><dt><b><a class="el" href="since_2_18.html#_since_2_18000006">Since glibmm 2.18:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ae2e37f3de1e0d50b50a3ba4e9ff3d30f"></a><!-- doxytag: member="Gio::Emblem::get_origin" ref="ae2e37f3de1e0d50b50a3ba4e9ff3d30f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__giommEnums.html#ga7f2c8f757fdeb91ca48c0bc8184f9270">EmblemOrigin</a> Gio::Emblem::get_origin </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the origin of the emblem. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The origin of the emblem</dd></dl>
<dl class="since_2_18"><dt><b><a class="el" href="since_2_18.html#_since_2_18000008">Since glibmm 2.18:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="aedc2ab1a8682aff33ba0dbdaf5d05afb"></a><!-- doxytag: member="Gio::Emblem::gobj" ref="aedc2ab1a8682aff33ba0dbdaf5d05afb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GEmblem* Gio::Emblem::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="a18a84361942885e0b75a82ffbc342947"></a><!-- doxytag: member="Gio::Emblem::gobj" ref="a18a84361942885e0b75a82ffbc342947" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GEmblem* Gio::Emblem::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="a37489c6af0fd3ebcc26f2ad70499ab69"></a><!-- doxytag: member="Gio::Emblem::gobj_copy" ref="a37489c6af0fd3ebcc26f2ad70499ab69" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GEmblem* Gio::Emblem::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>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a53ecca7bfb4c8b1e3ac4305a8087bf3e"></a><!-- doxytag: member="Gio::Emblem::wrap" ref="a53ecca7bfb4c8b1e3ac4305a8087bf3e" args="(GEmblem *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_1Emblem.html">Gio::Emblem</a> > wrap </td>
<td>(</td>
<td class="paramtype">GEmblem * </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/emblem.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 11:07:22 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>
