<!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::StockID 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_1StockID.html">StockID</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Gtk::StockID Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Gtk::StockID" -->
<p>See also <a class="el" href="structGtk_1_1BuiltinStockID.html" title="See the list of pre-defined stock items, in the Stock namespace.">Gtk::BuiltinStockID</a>. <a href="#_details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Gtk::StockID:</div>
<div class="dyncontent">
<div class="center"><img src="classGtk_1_1StockID__coll__graph.png" border="0" usemap="#Gtk_1_1StockID_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1StockID_coll__map" id="Gtk_1_1StockID_coll__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html" title="Glib::ustring" alt="" coords="7,5,105,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1StockID-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#a396a25a3222d3a1b3090d6f1c8e6028e">StockID</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. <a href="#a396a25a3222d3a1b3090d6f1c8e6028e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#aeff681c4d82aab583ee7a3463d5adee2">StockID</a> (const <a class="el" href="structGtk_1_1BuiltinStockID.html">BuiltinStockID</a>& id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> from one of the build-in stock ids. <a href="#aeff681c4d82aab583ee7a3463d5adee2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#a544642b811eac9faef5ca7f3e78f5293">StockID</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> from its string representation. <a href="#a544642b811eac9faef5ca7f3e78f5293"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#aef532ae81966fa61d623037815b5240d">StockID</a> (const char* id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> from its string representation. <a href="#aef532ae81966fa61d623037815b5240d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#a97a8dc45322d2c661af7811f3bf747cb">~StockID</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#a96b18fa2cc1d647527a5ff8165b54982">StockID</a> (const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> as copy from another. <a href="#a96b18fa2cc1d647527a5ff8165b54982"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#ae7fa41edd77f7ac111401edffaff315a">operator=</a> (const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the StockIDs are equal. <a href="#ae7fa41edd77f7ac111401edffaff315a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#adee59ab22ace7829ad0fd2295d7e67ff">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tests whether the <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> is not empty. <a href="#adee59ab22ace7829ad0fd2295d7e67ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#a84896cf914a43b06f13358e8126d3e99">equal</a> (const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if two StockIDs are equal. <a href="#a84896cf914a43b06f13358e8126d3e99"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#a0c2ddabd2d77ff2a3de7becce0b08d30">get_string</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string representation of the <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. <a href="#a0c2ddabd2d77ff2a3de7becce0b08d30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#a30fc4db0c04a2ba73d2e4ee62fd7816d">get_c_str</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string representation as a const gchar*. <a href="#a30fc4db0c04a2ba73d2e4ee62fd7816d"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#a6b86e0c5726a913fb5d5634469760d92">id_</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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#acc5dc4eb3c309a0896c0b98dd6eac844">operator==</a> (const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& lhs, const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1StockID.html#abecb9c3a29eea450232ef8649cc3dc37">operator!=</a> (const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& lhs, const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& rhs)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>See also <a class="el" href="structGtk_1_1BuiltinStockID.html" title="See the list of pre-defined stock items, in the Stock namespace.">Gtk::BuiltinStockID</a>. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a396a25a3222d3a1b3090d6f1c8e6028e"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="a396a25a3222d3a1b3090d6f1c8e6028e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::StockID::StockID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an empty <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. </p>
</div>
</div>
<a class="anchor" id="aeff681c4d82aab583ee7a3463d5adee2"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="aeff681c4d82aab583ee7a3463d5adee2" args="(const BuiltinStockID &id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::StockID::StockID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structGtk_1_1BuiltinStockID.html">BuiltinStockID</a>& </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> from one of the build-in stock ids. </p>
<p>See also Gtk::BuildinStockID. </p>
</div>
</div>
<a class="anchor" id="a544642b811eac9faef5ca7f3e78f5293"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="a544642b811eac9faef5ca7f3e78f5293" args="(const Glib::ustring &id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::StockID::StockID </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> from its string representation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>string representation of the stock id. Usually something like "gtk-about". </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aef532ae81966fa61d623037815b5240d"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="aef532ae81966fa61d623037815b5240d" args="(const char *id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::StockID::StockID </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> from its string representation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>string representation of the stock id. Usually something like "gtk-about".</td></tr>
</table>
</dd>
</dl>
<p>If id is 0 an empty <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> will be created. </p>
</div>
</div>
<a class="anchor" id="a97a8dc45322d2c661af7811f3bf747cb"></a><!-- doxytag: member="Gtk::StockID::~StockID" ref="a97a8dc45322d2c661af7811f3bf747cb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::StockID::~StockID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a96b18fa2cc1d647527a5ff8165b54982"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="a96b18fa2cc1d647527a5ff8165b54982" args="(const StockID &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::StockID::StockID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> as copy from another. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">other,:</td><td><a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a84896cf914a43b06f13358e8126d3e99"></a><!-- doxytag: member="Gtk::StockID::equal" ref="a84896cf914a43b06f13358e8126d3e99" args="(const StockID &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::StockID::equal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if two StockIDs are equal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">rhs</td><td>Another <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if both ids equal - <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a30fc4db0c04a2ba73d2e4ee62fd7816d"></a><!-- doxytag: member="Gtk::StockID::get_c_str" ref="a30fc4db0c04a2ba73d2e4ee62fd7816d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Gtk::StockID::get_c_str </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the string representation as a const gchar*. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>string representation as const gchar*. </dd></dl>
</div>
</div>
<a class="anchor" id="a0c2ddabd2d77ff2a3de7becce0b08d30"></a><!-- doxytag: member="Gtk::StockID::get_string" ref="a0c2ddabd2d77ff2a3de7becce0b08d30" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::StockID::get_string </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the string representation of the <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>something like "gtk-about". </dd></dl>
</div>
</div>
<a class="anchor" id="adee59ab22ace7829ad0fd2295d7e67ff"></a><!-- doxytag: member="Gtk::StockID::operator bool" ref="adee59ab22ace7829ad0fd2295d7e67ff" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::StockID::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tests whether the <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> is not empty. </p>
</div>
</div>
<a class="anchor" id="ae7fa41edd77f7ac111401edffaff315a"></a><!-- doxytag: member="Gtk::StockID::operator=" ref="ae7fa41edd77f7ac111401edffaff315a" args="(const StockID &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1StockID.html">StockID</a>& Gtk::StockID::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the StockIDs are equal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="abecb9c3a29eea450232ef8649cc3dc37"></a><!-- doxytag: member="Gtk::StockID::operator!=" ref="abecb9c3a29eea450232ef8649cc3dc37" args="(const StockID &lhs, const StockID &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01176.html#gac4373547895ec9df9035719b38a2621a">operator!</a>= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"><em>rhs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acc5dc4eb3c309a0896c0b98dd6eac844"></a><!-- doxytag: member="Gtk::StockID::operator==" ref="acc5dc4eb3c309a0896c0b98dd6eac844" args="(const StockID &lhs, const StockID &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"><em>rhs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a6b86e0c5726a913fb5d5634469760d92"></a><!-- doxytag: member="Gtk::StockID::id_" ref="a6b86e0c5726a913fb5d5634469760d92" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> <a class="el" href="classGtk_1_1StockID.html#a6b86e0c5726a913fb5d5634469760d92">Gtk::StockID::id_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/stockid.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>
