← Back to branch summary

~kklimonda/ubuntu/natty/glibmm2.4/update

« back to all changes in this revision

Viewing changes to docs/reference/html/classGio_1_1Icon.html

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-08-28 08:32:22 UTC
  • mfrom: (1.2.38 upstream)
  • Revision ID: james.westby@ubuntu.com-20090828083222-qr6jekfjlsz52rb7
Tags: 2.21.4.1-0ubuntu1
https://launchpad.net/bugs/419705
* New upstream release: (LP: #419705)
  2.21.4.1
  - Reenable hierarchy graphs for each class
  - Remove header and footer HTML fragments
  - Use shared mm-common Doxygen style sheet
  2.21.4
  - Transition to new mm-common build infrastructure
  - Correct the if condition in Gio::MemoryInputStream::add_data().
* debian/control.in:
  - Remove debian VCS links as they confuse debcheckout
* debian/libglibmm-2.4-dev.install:
  - Install files from /usr/share/glibmm-2.4/doctool

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/classGio_1_1Icon.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>glibmm 2.4: Gio::Icon Class Reference</title>
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 
3
<title>glibmm: Gio::Icon Class Reference</title>
 
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
 
</head>
6
 
<body bgcolor="#ffffff">
7
 
<table border="0" width="100%">
8
 
<tr>
9
 
    <td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
10
 
    <td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
11
 
</tr>
12
 
</table>
13
 
<center>
14
 
  <a class="qindex" href="http://www.gtkmm.org/documentation.shtml">Main Page</a> &nbsp;
15
 
  <a class="qindex" href="namespaces.html">glibmm Namespaces</a> &nbsp;
16
 
  <a href="../../../../gtkmm-2.4/docs/tutorial/html/index.html"> Book</a> &nbsp;
17
 
</center>
18
 
<hr width="100%"/>
19
 
 
20
 
<!-- begin main content -->
21
 
<div id="content">
22
 
<!-- Generated by Doxygen 1.5.9 -->
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.8 -->
 
8
<div class="navigation" id="top">
 
9
  <div class="tabs">
 
10
    <ul>
 
11
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
12
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
13
      <li><a href="modules.html"><span>Modules</span></a></li>
 
14
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
15
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
16
      <li><a href="examples.html"><span>Examples</span></a></li>
 
17
    </ul>
 
18
  </div>
 
19
  <div class="tabs">
 
20
    <ul>
 
21
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
22
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
 
23
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
24
    </ul>
 
25
  </div>
23
26
  <div class="navpath"><a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1Icon.html">Icon</a>
24
27
  </div>
 
28
</div>
25
29
<div class="contents">
26
 
<h1>Gio::Icon Class Reference</h1><!-- doxytag: class="Gio::Icon" --><!-- doxytag: inherits="Glib::Interface" -->This is a very minimal interface for icons.  
27
 
<a href="#_details">More...</a>
 
30
<h1>Gio::Icon Class Reference</h1><!-- doxytag: class="Gio::Icon" --><!-- doxytag: inherits="Glib::Interface" -->This is a very minimal interface for icons. <a href="#_details">More...</a>
 
31
<p>
 
32
Inherits <a class="el" href="classGlib_1_1Interface.html">Glib::Interface</a>.
 
33
<p>
 
34
Inherited by <a class="el" href="classGio_1_1Emblem.html">Gio::Emblem</a>, <a class="el" href="classGio_1_1EmblemedIcon.html">Gio::EmblemedIcon</a>, <a class="el" href="classGio_1_1LoadableIcon.html">Gio::LoadableIcon</a>, and <a class="el" href="classGio_1_1ThemedIcon.html">Gio::ThemedIcon</a>.
28
35
<p>
29
36
<div class="dynheader">
30
 
Inheritance diagram for Gio::Icon:</div>
 
37
Collaboration diagram for Gio::Icon:</div>
31
38
<div class="dynsection">
32
 
<p><center><img src="classGio_1_1Icon__inherit__graph.png" border="0" usemap="#Gio_1_1Icon__inherit__map" alt="Inheritance graph"></center>
33
 
<map name="Gio_1_1Icon__inherit__map">
34
 
<area shape="rect" href="classGio_1_1Emblem.html" title="An object for emblems." alt="" coords="5,315,101,344"><area shape="rect" href="classGio_1_1EmblemedIcon.html" title="Icons with Emblems." alt="" coords="125,315,261,344"><area shape="rect" href="classGio_1_1LoadableIcon.html" title="Extends the Icon interface and adds the ability to load icons from streams." alt="" coords="285,315,411,344"><area shape="rect" href="classGio_1_1ThemedIcon.html" title="Icon theming support ThemedIcon is an implementation of Gio::Icon that supports icon..." alt="" coords="435,315,555,344"><area shape="rect" href="classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="219,160,323,189"><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="211,83,331,112"><area shape="rect" href="classsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="217,5,324,35"><area shape="rect" href="classGio_1_1FileIcon.html" title="FileIcon specifies an icon by pointing to an image file to be used as icon." alt="" coords="300,392,396,421"></map>
 
39
<p><center><img src="classGio_1_1Icon__coll__graph.png" border="0" usemap="#Gio_1_1Icon__coll__map" alt="Collaboration graph"></center>
 
40
<map name="Gio_1_1Icon__coll__map">
 
41
<area shape="rect" href="classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="13,155,117,181"><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="5,80,125,107"></map>
35
42
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
36
43
 
37
44
<p>
38
45
<a href="classGio_1_1Icon-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
39
46
<tr><td></td></tr>
40
47
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
41
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#860156dd8f8c9143cce6fba134e5d7cb">~Icon</a> ()</td></tr>
42
 
 
43
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">GIcon*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#02ef784d9a07a205ce1d7daac39d2054">gobj</a> ()</td></tr>
44
 
 
45
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#02ef784d9a07a205ce1d7daac39d2054"></a><br></td></tr>
46
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GIcon*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#94b7e4b63ce6c1c0f05673dd8b4adf94">gobj</a> () const </td></tr>
47
 
 
48
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#94b7e4b63ce6c1c0f05673dd8b4adf94"></a><br></td></tr>
49
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">guint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#cbcfcaa91ff4d50f700267e2928a61ae">hash</a> () const </td></tr>
50
 
 
51
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets a hash for an icon.  <a href="#cbcfcaa91ff4d50f700267e2928a61ae"></a><br></td></tr>
52
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/namespacestd.html#a48">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#7b0d721c852d1e5b0f9cd875769fabd7">to_string</a> () const </td></tr>
53
 
 
54
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generates a textual representation of <em>icon</em> that can be used for serialization such as when passing <em>icon</em> to a different process or saving it to persistent storage.  <a href="#7b0d721c852d1e5b0f9cd875769fabd7"></a><br></td></tr>
55
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#90820057c0e8974d43d2597df18efb20">equal</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1Icon.html">Icon</a>&gt;&amp; other) const </td></tr>
 
48
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#860156dd8f8c9143cce6fba134e5d7cb">~Icon</a> ()</td></tr>
 
49
 
 
50
<tr><td class="memItemLeft" nowrap align="right" valign="top">GIcon*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#02ef784d9a07a205ce1d7daac39d2054">gobj</a> ()</td></tr>
 
51
 
 
52
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#02ef784d9a07a205ce1d7daac39d2054"></a><br></td></tr>
 
53
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GIcon*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#94b7e4b63ce6c1c0f05673dd8b4adf94">gobj</a> () const </td></tr>
 
54
 
 
55
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#94b7e4b63ce6c1c0f05673dd8b4adf94"></a><br></td></tr>
 
56
<tr><td class="memItemLeft" nowrap align="right" valign="top">guint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#cbcfcaa91ff4d50f700267e2928a61ae">hash</a> () const </td></tr>
 
57
 
 
58
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a hash for an icon. <a href="#cbcfcaa91ff4d50f700267e2928a61ae"></a><br></td></tr>
 
59
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00969.html#32db3d9898c44d3b3a578b560f7758cc">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#7b0d721c852d1e5b0f9cd875769fabd7">to_string</a> () const </td></tr>
 
60
 
 
61
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a textual representation of <em>icon</em> that can be used for serialization such as when passing <em>icon</em> to a different process or saving it to persistent storage. <a href="#7b0d721c852d1e5b0f9cd875769fabd7"></a><br></td></tr>
 
62
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#90820057c0e8974d43d2597df18efb20">equal</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Icon.html">Icon</a> &gt;&amp; other) const </td></tr>
56
63
 
57
64
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
58
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#bd37e490fdf4da67eb3bbe2561c16ee3">add_interface</a> (GType gtype_implementer)</td></tr>
 
65
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#bd37e490fdf4da67eb3bbe2561c16ee3">add_interface</a> (GType gtype_implementer)</td></tr>
59
66
 
60
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1Icon.html">Icon</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#8ae9b8e7b8159620eea7f9215cac83ab">create</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/namespacestd.html#a48">std::string</a>&amp; str)</td></tr>
 
67
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Icon.html">Icon</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#8ae9b8e7b8159620eea7f9215cac83ab">create</a> (const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00969.html#32db3d9898c44d3b3a578b560f7758cc">std::string</a>&amp; str)</td></tr>
61
68
 
62
69
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
63
70
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
64
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1Icon.html">Gio::Icon</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#9f6d4523888318e40c362de6eea23004">wrap</a> (GIcon* object, bool take_copy=false)</td></tr>
 
71
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Icon.html">Gio::Icon</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Icon.html#9f6d4523888318e40c362de6eea23004">wrap</a> (GIcon* object, bool take_copy=false)</td></tr>
65
72
 
66
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.  <a href="#9f6d4523888318e40c362de6eea23004"></a><br></td></tr>
 
73
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#9f6d4523888318e40c362de6eea23004"></a><br></td></tr>
67
74
</table>
68
75
<hr><a name="_details"></a><h2>Detailed Description</h2>
69
 
This is a very minimal interface for icons. 
70
 
<p>
 
76
This is a very minimal interface for icons. <p>
71
77
It provides functions for checking the equality of two icons and hashing of icons. Glib::Icon does not provide the actual pixmap for the icon as this is out of GIO's scope. However implementations of <a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Icon</a> may contain the name of an icon (see <a class="el" href="classGio_1_1ThemedIcon.html" title="Icon theming support ThemedIcon is an implementation of Gio::Icon that supports icon...">ThemedIcon</a>), or the path to an icon (see <a class="el" href="classGio_1_1LoadableIcon.html" title="Extends the Icon interface and adds the ability to load icons from streams.">LoadableIcon</a>).<p>
72
78
To obtain a hash of an <a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Icon</a> instance, see <a class="el" href="classGio_1_1Icon.html#cbcfcaa91ff4d50f700267e2928a61ae" title="Gets a hash for an icon.">hash()</a>.<p>
73
79
To check if two <a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Icon</a> instances are equal, see <a class="el" href="classGio_1_1Icon.html#90820057c0e8974d43d2597df18efb20">equal()</a>.<p>
74
 
<dl class="newin2p16s" compact><dt><b><a class="el" href="newin2p16s.html#_newin2p16s000036">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
 
80
<dl compact><dt><b><a class="el" href="since_2_16.html#_since_2_16000035">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
75
81
<hr><h2>Constructor &amp; Destructor Documentation</h2>
76
82
<a class="anchor" name="860156dd8f8c9143cce6fba134e5d7cb"></a><!-- doxytag: member="Gio::Icon::~Icon" ref="860156dd8f8c9143cce6fba134e5d7cb" args="()" -->
77
83
<div class="memitem">
78
84
<div class="memproto">
79
85
      <table class="memname">
80
86
        <tr>
81
 
          <td class="memname">virtual Gio::Icon::~Icon           </td>
 
87
          <td class="memname">virtual Gio::Icon::~Icon </td>
82
88
          <td>(</td>
83
 
          <td class="paramname">          </td>
84
 
          <td>&nbsp;)&nbsp;</td>
 
89
          <td class="paramname"> </td>
 
90
          <td>&#160;)&#160;</td>
85
91
          <td><code> [virtual]</code></td>
86
92
        </tr>
87
93
      </table>
98
104
<div class="memproto">
99
105
      <table class="memname">
100
106
        <tr>
101
 
          <td class="memname">static void Gio::Icon::add_interface           </td>
 
107
          <td class="memname">static void Gio::Icon::add_interface </td>
102
108
          <td>(</td>
103
 
          <td class="paramtype">GType&nbsp;</td>
104
 
          <td class="paramname"> <em>gtype_implementer</em>          </td>
105
 
          <td>&nbsp;)&nbsp;</td>
 
109
          <td class="paramtype">GType&#160;</td>
 
110
          <td class="paramname"> <em>gtype_implementer</em> </td>
 
111
          <td>&#160;)&#160;</td>
106
112
          <td><code> [static]</code></td>
107
113
        </tr>
108
114
      </table>
120
126
<div class="memproto">
121
127
      <table class="memname">
122
128
        <tr>
123
 
          <td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1Icon.html">Icon</a>&gt; Gio::Icon::create           </td>
 
129
          <td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1Icon.html">Icon</a>&gt; Gio::Icon::create </td>
124
130
          <td>(</td>
125
 
          <td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/namespacestd.html#a48">std::string</a> &amp;&nbsp;</td>
126
 
          <td class="paramname"> <em>str</em>          </td>
127
 
          <td>&nbsp;)&nbsp;</td>
 
131
          <td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00969.html#32db3d9898c44d3b3a578b560f7758cc">std::string</a> &amp;&#160;</td>
 
132
          <td class="paramname"> <em>str</em> </td>
 
133
          <td>&#160;)&#160;</td>
128
134
          <td><code> [static]</code></td>
129
135
        </tr>
130
136
      </table>
140
146
<div class="memproto">
141
147
      <table class="memname">
142
148
        <tr>
143
 
          <td class="memname">bool Gio::Icon::equal           </td>
 
149
          <td class="memname">bool Gio::Icon::equal </td>
144
150
          <td>(</td>
145
 
          <td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1Icon.html">Icon</a>&gt;&amp;&nbsp;</td>
146
 
          <td class="paramname"> <em>other</em>          </td>
147
 
          <td>&nbsp;)&nbsp;</td>
 
151
          <td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Icon.html">Icon</a> &gt;&amp;&#160;</td>
 
152
          <td class="paramname"> <em>other</em> </td>
 
153
          <td>&#160;)&#160;</td>
148
154
          <td> const</td>
149
155
        </tr>
150
156
      </table>
160
166
<div class="memproto">
161
167
      <table class="memname">
162
168
        <tr>
163
 
          <td class="memname">const GIcon* Gio::Icon::gobj           </td>
 
169
          <td class="memname">const GIcon* Gio::Icon::gobj </td>
164
170
          <td>(</td>
165
 
          <td class="paramname">          </td>
166
 
          <td>&nbsp;)&nbsp;</td>
 
171
          <td class="paramname"> </td>
 
172
          <td>&#160;)&#160;</td>
167
173
          <td> const<code> [inline]</code></td>
168
174
        </tr>
169
175
      </table>
171
177
<div class="memdoc">
172
178
 
173
179
<p>
174
 
Provides access to the underlying C GObject. 
175
 
<p>
 
180
Provides access to the underlying C GObject. <p>
176
181
 
177
182
<p>Reimplemented from <a class="el" href="classGlib_1_1Interface.html#70a443071a69d3372c2cdd7128a91ed1">Glib::Interface</a>.</p>
178
183
 
185
190
<div class="memproto">
186
191
      <table class="memname">
187
192
        <tr>
188
 
          <td class="memname">GIcon* Gio::Icon::gobj           </td>
 
193
          <td class="memname">GIcon* Gio::Icon::gobj </td>
189
194
          <td>(</td>
190
 
          <td class="paramname">          </td>
191
 
          <td>&nbsp;)&nbsp;</td>
 
195
          <td class="paramname"> </td>
 
196
          <td>&#160;)&#160;</td>
192
197
          <td><code> [inline]</code></td>
193
198
        </tr>
194
199
      </table>
196
201
<div class="memdoc">
197
202
 
198
203
<p>
199
 
Provides access to the underlying C GObject. 
200
 
<p>
 
204
Provides access to the underlying C GObject. <p>
201
205
 
202
206
<p>Reimplemented from <a class="el" href="classGlib_1_1Interface.html#969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.</p>
203
207
 
210
214
<div class="memproto">
211
215
      <table class="memname">
212
216
        <tr>
213
 
          <td class="memname">guint Gio::Icon::hash           </td>
 
217
          <td class="memname">guint Gio::Icon::hash </td>
214
218
          <td>(</td>
215
 
          <td class="paramname">          </td>
216
 
          <td>&nbsp;)&nbsp;</td>
 
219
          <td class="paramname"> </td>
 
220
          <td>&#160;)&#160;</td>
217
221
          <td> const</td>
218
222
        </tr>
219
223
      </table>
221
225
<div class="memdoc">
222
226
 
223
227
<p>
224
 
Gets a hash for an icon. 
225
 
<p>
 
228
Gets a hash for an icon. <p>
226
229
<dl compact><dt><b>Parameters:</b></dt><dd>
227
230
  <table border="0" cellspacing="2" cellpadding="0">
228
 
    <tr><td valign="top"></td><td valign="top"><em>icon</em>&nbsp;</td><td>gconstpointer to an icon object. </td></tr>
 
231
    <tr><td valign="top"></td><td valign="top"><em>icon</em>&#160;</td><td>gconstpointer to an icon object. </td></tr>
229
232
  </table>
230
233
</dl>
231
234
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <code>unsigned int</code> containing a hash for the <em>icon</em>, suitable for use in a HashTable or similar data structure. </dd></dl>
237
240
<div class="memproto">
238
241
      <table class="memname">
239
242
        <tr>
240
 
          <td class="memname"><a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/namespacestd.html#a48">std::string</a> Gio::Icon::to_string           </td>
 
243
          <td class="memname"><a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00969.html#32db3d9898c44d3b3a578b560f7758cc">std::string</a> Gio::Icon::to_string </td>
241
244
          <td>(</td>
242
 
          <td class="paramname">          </td>
243
 
          <td>&nbsp;)&nbsp;</td>
 
245
          <td class="paramname"> </td>
 
246
          <td>&#160;)&#160;</td>
244
247
          <td> const</td>
245
248
        </tr>
246
249
      </table>
248
251
<div class="memdoc">
249
252
 
250
253
<p>
251
 
Generates a textual representation of <em>icon</em> that can be used for serialization such as when passing <em>icon</em> to a different process or saving it to persistent storage. 
252
 
<p>
 
254
Generates a textual representation of <em>icon</em> that can be used for serialization such as when passing <em>icon</em> to a different process or saving it to persistent storage. <p>
253
255
Use g_icon_new_for_string() to get <em>icon</em> back from the returned string.<p>
254
256
The encoding of the returned string is proprietary to <a class="el" href="classGio_1_1Icon.html" title="This is a very minimal interface for icons.">Icon</a> except in the following two cases<p>
255
257
&lt;itemizedlist&gt; &lt;listitem&gt;<p>
257
259
&lt;/listitem&gt; &lt;listitem&gt;<p>
258
260
If <em>icon</em> is a <a class="el" href="classGio_1_1ThemedIcon.html" title="Icon theming support ThemedIcon is an implementation of Gio::Icon that supports icon...">ThemedIcon</a> with exactly one name, the encoding is simply the name (such as &lt;literal&gt;network-server&lt;/literal&gt;). <p>
259
261
&lt;/listitem&gt; &lt;/itemizedlist&gt; <dl class="return" compact><dt><b>Returns:</b></dt><dd>An allocated NUL-terminated UTF8 string or <code>0</code> if <em>icon</em> can't be serialized. Use Glib::free() to free.</dd></dl>
260
 
<dl class="newin2p20s" compact><dt><b><a class="el" href="newin2p20s.html#_newin2p20s000011">Since glibmm 2.20:</a></b></dt><dd></dd></dl>
 
262
<dl compact><dt><b><a class="el" href="since_2_20.html#_since_2_20000010">Since glibmm 2.20:</a></b></dt><dd></dd></dl>
261
263
 
262
264
</div>
263
265
</div><p>
267
269
<div class="memproto">
268
270
      <table class="memname">
269
271
        <tr>
270
 
          <td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1Icon.html">Gio::Icon</a>&gt; wrap           </td>
 
272
          <td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Icon.html">Gio::Icon</a> &gt; wrap </td>
271
273
          <td>(</td>
272
 
          <td class="paramtype">GIcon *&nbsp;</td>
 
274
          <td class="paramtype">GIcon *&#160;</td>
273
275
          <td class="paramname"> <em>object</em>, </td>
274
276
        </tr>
275
277
        <tr>
276
278
          <td class="paramkey"></td>
277
279
          <td></td>
278
 
          <td class="paramtype">bool&nbsp;</td>
279
 
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&nbsp;</td>
 
280
          <td class="paramtype">bool&#160;</td>
 
281
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&#160;</td>
280
282
        </tr>
281
283
        <tr>
282
284
          <td></td>
288
290
<div class="memdoc">
289
291
 
290
292
<p>
291
 
A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. 
292
 
<p>
 
293
A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <p>
293
294
<dl compact><dt><b>Parameters:</b></dt><dd>
294
295
  <table border="0" cellspacing="2" cellpadding="0">
295
 
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>The C instance. </td></tr>
296
 
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&nbsp;</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>
 
296
    <tr><td valign="top"></td><td valign="top"><em>object</em>&#160;</td><td>The C instance. </td></tr>
 
297
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&#160;</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>
297
298
  </table>
298
299
</dl>
299
300
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
301
302
</div>
302
303
</div><p>
303
304
<hr>The documentation for this class was generated from the following file:<ul>
304
 
<li><a class="el" href="icon_8h.html">icon.h</a></ul>
 
305
<li>giomm/icon.h</ul>
305
306
</div>
306
 
</div> <!-- end main content -->
307
 
 
308
 
<hr><address><small>
309
 
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
310
 
Doxygen</a> 1.5.9 &copy;&nbsp;1997-2001</small></address>
 
307
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 28 16:44:59 2009 for glibmm by&#160;
 
308
<a href="http://www.doxygen.org/index.html">
 
309
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
311
310
</body>
312
311
</html>