1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gtk::StockID Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1StockID.html">StockID</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#pro-attribs">Protected Attributes</a> |
51
<a href="#related">Related Functions</a> </div>
52
<div class="headertitle">
53
<h1>Gtk::StockID Class Reference</h1> </div>
55
<div class="contents">
56
<!-- doxytag: class="Gtk::StockID" -->
57
<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>
58
<div class="dynheader">
59
Collaboration diagram for Gtk::StockID:</div>
60
<div class="dyncontent">
61
<div class="center"><img src="classGtk_1_1StockID__coll__graph.png" border="0" usemap="#Gtk_1_1StockID_coll__map" alt="Collaboration graph"/></div>
62
<map name="Gtk_1_1StockID_coll__map" id="Gtk_1_1StockID_coll__map">
63
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html" title="Glib::ustring" alt="" coords="9,6,100,37"/></map>
64
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
66
<p><a href="classGtk_1_1StockID-members.html">List of all members.</a></p>
67
<table class="memberdecls">
68
<tr><td colspan="2"><h2><a name="pub-methods"></a>
69
Public Member Functions</h2></td></tr>
70
<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>
71
<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>
72
<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>
73
<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>
74
<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>
75
<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>
76
<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>
77
<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>
78
<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>
79
<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>
80
<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>
81
<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>
82
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the StockIDs are equal. <a href="#ae7fa41edd77f7ac111401edffaff315a"></a><br/></td></tr>
83
<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>
84
<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>
85
<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>
86
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if two StockIDs are equal. <a href="#a84896cf914a43b06f13358e8126d3e99"></a><br/></td></tr>
87
<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>
88
<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>
89
<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>
90
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string representation as a const gchar*. <a href="#a30fc4db0c04a2ba73d2e4ee62fd7816d"></a><br/></td></tr>
91
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
92
Protected Attributes</h2></td></tr>
93
<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>
94
<tr><td colspan="2"><h2><a name="related"></a>
95
Related Functions</h2></td></tr>
96
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
97
<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>
98
<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>
100
<hr/><a name="_details"></a><h2>Detailed Description</h2>
101
<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>
102
</div><hr/><h2>Constructor & Destructor Documentation</h2>
103
<a class="anchor" id="a396a25a3222d3a1b3090d6f1c8e6028e"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="a396a25a3222d3a1b3090d6f1c8e6028e" args="()" -->
104
<div class="memitem">
105
<div class="memproto">
106
<table class="memname">
108
<td class="memname">Gtk::StockID::StockID </td>
110
<td class="paramname"></td><td>)</td>
117
<p>Create an empty <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. </p>
121
<a class="anchor" id="aeff681c4d82aab583ee7a3463d5adee2"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="aeff681c4d82aab583ee7a3463d5adee2" args="(const BuiltinStockID &id)" -->
122
<div class="memitem">
123
<div class="memproto">
124
<table class="memname">
126
<td class="memname">Gtk::StockID::StockID </td>
128
<td class="paramtype">const <a class="el" href="structGtk_1_1BuiltinStockID.html">BuiltinStockID</a>& </td>
129
<td class="paramname"><em>id</em></td><td>)</td>
136
<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>
137
<p>See also Gtk::BuildinStockID. </p>
141
<a class="anchor" id="a544642b811eac9faef5ca7f3e78f5293"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="a544642b811eac9faef5ca7f3e78f5293" args="(const Glib::ustring &id)" -->
142
<div class="memitem">
143
<div class="memproto">
144
<table class="memname">
146
<td class="memname">Gtk::StockID::StockID </td>
148
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
149
<td class="paramname"><em>id</em></td><td>)</td>
150
<td><code> [explicit]</code></td>
156
<p>Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> from its string representation. </p>
157
<dl><dt><b>Parameters:</b></dt><dd>
158
<table class="params">
159
<tr><td class="paramname">id</td><td>string representation of the stock id. Usually something like "gtk-about". </td></tr>
166
<a class="anchor" id="aef532ae81966fa61d623037815b5240d"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="aef532ae81966fa61d623037815b5240d" args="(const char *id)" -->
167
<div class="memitem">
168
<div class="memproto">
169
<table class="memname">
171
<td class="memname">Gtk::StockID::StockID </td>
173
<td class="paramtype">const char * </td>
174
<td class="paramname"><em>id</em></td><td>)</td>
175
<td><code> [explicit]</code></td>
181
<p>Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> from its string representation. </p>
182
<dl><dt><b>Parameters:</b></dt><dd>
183
<table class="params">
184
<tr><td class="paramname">id</td><td>string representation of the stock id. Usually something like "gtk-about".</td></tr>
188
<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>
192
<a class="anchor" id="a97a8dc45322d2c661af7811f3bf747cb"></a><!-- doxytag: member="Gtk::StockID::~StockID" ref="a97a8dc45322d2c661af7811f3bf747cb" args="()" -->
193
<div class="memitem">
194
<div class="memproto">
195
<table class="memname">
197
<td class="memname">Gtk::StockID::~StockID </td>
199
<td class="paramname"></td><td>)</td>
208
<a class="anchor" id="a96b18fa2cc1d647527a5ff8165b54982"></a><!-- doxytag: member="Gtk::StockID::StockID" ref="a96b18fa2cc1d647527a5ff8165b54982" args="(const StockID &other)" -->
209
<div class="memitem">
210
<div class="memproto">
211
<table class="memname">
213
<td class="memname">Gtk::StockID::StockID </td>
215
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
216
<td class="paramname"><em>other</em></td><td>)</td>
223
<p>Create a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> as copy from another. </p>
224
<dl><dt><b>Parameters:</b></dt><dd>
225
<table class="params">
226
<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>
233
<hr/><h2>Member Function Documentation</h2>
234
<a class="anchor" id="a84896cf914a43b06f13358e8126d3e99"></a><!-- doxytag: member="Gtk::StockID::equal" ref="a84896cf914a43b06f13358e8126d3e99" args="(const StockID &rhs) const " -->
235
<div class="memitem">
236
<div class="memproto">
237
<table class="memname">
239
<td class="memname">bool Gtk::StockID::equal </td>
241
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
242
<td class="paramname"><em>rhs</em></td><td>)</td>
249
<p>Check if two StockIDs are equal. </p>
250
<dl><dt><b>Parameters:</b></dt><dd>
251
<table class="params">
252
<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>
256
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if both ids equal - <code>false</code> otherwise. </dd></dl>
260
<a class="anchor" id="a30fc4db0c04a2ba73d2e4ee62fd7816d"></a><!-- doxytag: member="Gtk::StockID::get_c_str" ref="a30fc4db0c04a2ba73d2e4ee62fd7816d" args="() const " -->
261
<div class="memitem">
262
<div class="memproto">
263
<table class="memname">
265
<td class="memname">const char* Gtk::StockID::get_c_str </td>
267
<td class="paramname"></td><td>)</td>
274
<p>Get the string representation as a const gchar*. </p>
275
<dl class="return"><dt><b>Returns:</b></dt><dd>string representation as const gchar*. </dd></dl>
279
<a class="anchor" id="a0c2ddabd2d77ff2a3de7becce0b08d30"></a><!-- doxytag: member="Gtk::StockID::get_string" ref="a0c2ddabd2d77ff2a3de7becce0b08d30" args="() const " -->
280
<div class="memitem">
281
<div class="memproto">
282
<table class="memname">
284
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::StockID::get_string </td>
286
<td class="paramname"></td><td>)</td>
293
<p>Get the string representation of the <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. </p>
294
<dl class="return"><dt><b>Returns:</b></dt><dd>something like "gtk-about". </dd></dl>
298
<a class="anchor" id="adee59ab22ace7829ad0fd2295d7e67ff"></a><!-- doxytag: member="Gtk::StockID::operator bool" ref="adee59ab22ace7829ad0fd2295d7e67ff" args="() const " -->
299
<div class="memitem">
300
<div class="memproto">
301
<table class="memname">
303
<td class="memname">Gtk::StockID::operator bool </td>
305
<td class="paramname"></td><td>)</td>
312
<p>Tests whether the <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> is not empty. </p>
316
<a class="anchor" id="ae7fa41edd77f7ac111401edffaff315a"></a><!-- doxytag: member="Gtk::StockID::operator=" ref="ae7fa41edd77f7ac111401edffaff315a" args="(const StockID &other)" -->
317
<div class="memitem">
318
<div class="memproto">
319
<table class="memname">
321
<td class="memname"><a class="el" href="classGtk_1_1StockID.html">StockID</a>& Gtk::StockID::operator= </td>
323
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
324
<td class="paramname"><em>other</em></td><td>)</td>
331
<p>Check if the StockIDs are equal. </p>
332
<dl><dt><b>Parameters:</b></dt><dd>
333
<table class="params">
334
<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>
341
<hr/><h2>Friends And Related Function Documentation</h2>
342
<a class="anchor" id="abecb9c3a29eea450232ef8649cc3dc37"></a><!-- doxytag: member="Gtk::StockID::operator!=" ref="abecb9c3a29eea450232ef8649cc3dc37" args="(const StockID &lhs, const StockID &rhs)" -->
343
<div class="memitem">
344
<div class="memproto">
345
<table class="memname">
347
<td class="memname">bool <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#gac4373547895ec9df9035719b38a2621a">operator!</a>= </td>
349
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
350
<td class="paramname"><em>lhs</em>, </td>
353
<td class="paramkey"></td>
355
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
356
<td class="paramname"><em>rhs</em> </td>
361
<td></td><td><code> [related]</code></td>
369
<a class="anchor" id="acc5dc4eb3c309a0896c0b98dd6eac844"></a><!-- doxytag: member="Gtk::StockID::operator==" ref="acc5dc4eb3c309a0896c0b98dd6eac844" args="(const StockID &lhs, const StockID &rhs)" -->
370
<div class="memitem">
371
<div class="memproto">
372
<table class="memname">
374
<td class="memname">bool operator== </td>
376
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
377
<td class="paramname"><em>lhs</em>, </td>
380
<td class="paramkey"></td>
382
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
383
<td class="paramname"><em>rhs</em> </td>
388
<td></td><td><code> [related]</code></td>
396
<hr/><h2>Member Data Documentation</h2>
397
<a class="anchor" id="a6b86e0c5726a913fb5d5634469760d92"></a><!-- doxytag: member="Gtk::StockID::id_" ref="a6b86e0c5726a913fb5d5634469760d92" args="" -->
398
<div class="memitem">
399
<div class="memproto">
400
<table class="memname">
402
<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>
410
<hr/>The documentation for this class was generated from the following file:<ul>
411
<li>gtkmm/stockid.h</li>
414
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:49 for gtkmm by 
415
<a href="http://www.doxygen.org/index.html">
416
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGtk_1_1StockID.html
