docs/reference/gio/html/GIcon.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GIcon</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="icons.html" title="Icons">
   9 <link rel="prev" href="icons.html" title="Icons">
  10 <link rel="next" href="GFileIcon.html" title="GFileIcon">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="icons.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="icons.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GFileIcon.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GIcon.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GIcon.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GIcon.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GIcon.prerequisites" class="shortcut">Prerequisites</a>
  31                    |
  32                   <a href="#GIcon.derived-interfaces" class="shortcut">Known Derived Interfaces</a>
  33                    |
  34                   <a href="#GIcon.implementations" class="shortcut">Known Implementations</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="GIcon"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="GIcon.top_of_page"></a>GIcon</span></h2>
  42 <p>GIcon — Interface for icons</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="GIcon.synopsis"></a><h2>Synopsis</h2>
  48 <pre class="synopsis">
  49 #include &lt;gio/gio.h&gt;
  50
  51                     <a class="link" href="GIcon.html#GIcon-struct" title="GIcon">GIcon</a>;
  52 struct              <a class="link" href="GIcon.html#GIconIface" title="struct GIconIface">GIconIface</a>;
  53 <a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GIcon.html#g-icon-hash" title="g_icon_hash ()">g_icon_hash</a>                         (<em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> icon</code></em>);
  54 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GIcon.html#g-icon-equal" title="g_icon_equal ()">g_icon_equal</a>                        (<em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon1</code></em>,
  55                                                          <em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon2</code></em>);
  56 <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="GIcon.html#g-icon-to-string" title="g_icon_to_string ()">g_icon_to_string</a>                    (<em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon</code></em>);
  57 <a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> *             <a class="link" href="GIcon.html#g-icon-new-for-string" title="g_icon_new_for_string ()">g_icon_new_for_string</a>               (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
  58                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="GIcon.object-hierarchy"></a><h2>Object Hierarchy</h2>
  63 <pre class="synopsis">
  64   GInterface
  65    +----GIcon
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="GIcon.prerequisites"></a><h2>Prerequisites</h2>
  70 <p>
  71 GIcon requires
  72  <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
  73 </div>
  74 <div class="refsect1">
  75 <a name="GIcon.derived-interfaces"></a><h2>Known Derived Interfaces</h2>
  76 <p>
  77 GIcon is required by
  78  <a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a>.</p>
  79 </div>
  80 <div class="refsect1">
  81 <a name="GIcon.implementations"></a><h2>Known Implementations</h2>
  82 <p>
  83 GIcon is implemented by
  84  <a class="link" href="GEmblem.html" title="GEmblem">GEmblem</a>,  <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon">GEmblemedIcon</a>,  <a class="link" href="GFileIcon.html" title="GFileIcon">GFileIcon</a> and  <a class="link" href="GThemedIcon.html" title="GThemedIcon">GThemedIcon</a>.</p>
  85 </div>
  86 <div class="refsect1">
  87 <a name="GIcon.description"></a><h2>Description</h2>
  88 <p>
  89 <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> is a very minimal interface for icons. It provides functions
  90 for checking the equality of two icons, hashing of icons and
  91 serializing an icon to and from strings.
  92 </p>
  93 <p>
  94 <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> does not provide the actual pixmap for the icon as this is out
  95 of GIO's scope, however implementations of <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> may contain the name
  96 of an icon (see <a class="link" href="GThemedIcon.html" title="GThemedIcon"><span class="type">GThemedIcon</span></a>), or the path to an icon (see <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a>).
  97 </p>
  98 <p>
  99 To obtain a hash of a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>, see <a class="link" href="GIcon.html#g-icon-hash" title="g_icon_hash ()"><code class="function">g_icon_hash()</code></a>.
 100 </p>
 101 <p>
 102 To check if two <a href="GIcon.html"><span class="type">GIcons</span></a> are equal, see <a class="link" href="GIcon.html#g-icon-equal" title="g_icon_equal ()"><code class="function">g_icon_equal()</code></a>.
 103 </p>
 104 <p>
 105 For serializing a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>, use <a class="link" href="GIcon.html#g-icon-to-string" title="g_icon_to_string ()"><code class="function">g_icon_to_string()</code></a> and
 106 <a class="link" href="GIcon.html#g-icon-new-for-string" title="g_icon_new_for_string ()"><code class="function">g_icon_new_for_string()</code></a>.
 107 </p>
 108 <p>
 109 If your application or library provides one or more <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>
 110 implementations you need to ensure that each <a href="./../gobject/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> is registered
 111 with the type system prior to calling <a class="link" href="GIcon.html#g-icon-new-for-string" title="g_icon_new_for_string ()"><code class="function">g_icon_new_for_string()</code></a>.
 112 </p>
 113 </div>
 114 <div class="refsect1">
 115 <a name="GIcon.details"></a><h2>Details</h2>
 116 <div class="refsect2">
 117 <a name="GIcon-struct"></a><h3>GIcon</h3>
 118 <pre class="programlisting">typedef struct _GIcon GIcon;</pre>
 119 <p>
 120 An abstract type that specifies an icon.
 121 </p>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="GIconIface"></a><h3>struct GIconIface</h3>
 126 <pre class="programlisting">struct GIconIface {
 127   GTypeInterface g_iface;
 128
 129   /* Virtual Table */
 130
 131   guint       (* hash)        (GIcon   *icon);
 132   gboolean    (* equal)       (GIcon   *icon1,
 133                                GIcon   *icon2);
 134   gboolean    (* to_tokens)   (GIcon   *icon,
 135                                GPtrArray *tokens,
 136                                gint    *out_version);
 137   GIcon *     (* from_tokens) (gchar  **tokens,
 138                                gint     num_tokens,
 139                                gint     version,
 140                                GError **error);
 141 };
 142 </pre>
 143 <p>
 144 GIconIface is used to implement GIcon types for various
 145 different systems. See <a class="link" href="GThemedIcon.html" title="GThemedIcon"><span class="type">GThemedIcon</span></a> and <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a> for
 146 examples of how to implement this interface.
 147 </p>
 148 <div class="variablelist"><table border="0">
 149 <col align="left" valign="top">
 150 <tbody>
 151 <tr>
 152 <td><p><span class="term"><a href="./../gobject/gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GIconIface.g-iface"></a>g_iface</code></em>;</span></p></td>
 153 <td>The parent interface.</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"><em class="structfield"><code><a name="GIconIface.hash"></a>hash</code></em> ()</span></p></td>
 157 <td>A hash for a given <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>.</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"><em class="structfield"><code><a name="GIconIface.equal"></a>equal</code></em> ()</span></p></td>
 161 <td>Checks if two <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>s are equal.</td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><em class="structfield"><code><a name="GIconIface.to-tokens"></a>to_tokens</code></em> ()</span></p></td>
 165 <td>Serializes a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> into tokens. The tokens must not
 166 contain any whitespace. Don't implement if the <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> can't be
 167 serialized (Since 2.20).</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"><em class="structfield"><code><a name="GIconIface.from-tokens"></a>from_tokens</code></em> ()</span></p></td>
 171 <td>Constructs a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> from tokens. Set the <a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> if
 172 the tokens are malformed. Don't implement if the <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> can't be
 173 serialized (Since 2.20).</td>
 174 </tr>
 175 </tbody>
 176 </table></div>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="g-icon-hash"></a><h3>g_icon_hash ()</h3>
 181 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               g_icon_hash                         (<em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> icon</code></em>);</pre>
 182 <p>
 183 Gets a hash for an icon.
 184 </p>
 185 <p>
 186 Virtual: hash
 187 </p>
 188 <div class="variablelist"><table border="0">
 189 <col align="left" valign="top">
 190 <tbody>
 191 <tr>
 192 <td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 193 <td>
 194 <a href="./../glib/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> to an icon object.</td>
 195 </tr>
 196 <tr>
 197 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 198 <td>a <a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> containing a hash for the <em class="parameter"><code>icon</code></em>, suitable for
 199 use in a <a href="./../glib/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> or similar data structure.</td>
 200 </tr>
 201 </tbody>
 202 </table></div>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="g-icon-equal"></a><h3>g_icon_equal ()</h3>
 207 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_icon_equal                        (<em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon1</code></em>,
 208                                                          <em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon2</code></em>);</pre>
 209 <p>
 210 Checks if two icons are equal.
 211 </p>
 212 <div class="variablelist"><table border="0">
 213 <col align="left" valign="top">
 214 <tbody>
 215 <tr>
 216 <td><p><span class="term"><em class="parameter"><code>icon1</code></em> :</span></p></td>
 217 <td>pointer to the first <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 218 </td>
 219 </tr>
 220 <tr>
 221 <td><p><span class="term"><em class="parameter"><code>icon2</code></em> :</span></p></td>
 222 <td>pointer to the second <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 223 </td>
 224 </tr>
 225 <tr>
 226 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 227 <td>
 228 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>icon1</code></em> is equal to <em class="parameter"><code>icon2</code></em>. <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 229 </tr>
 230 </tbody>
 231 </table></div>
 232 </div>
 233 <hr>
 234 <div class="refsect2">
 235 <a name="g-icon-to-string"></a><h3>g_icon_to_string ()</h3>
 236 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             g_icon_to_string                    (<em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon</code></em>);</pre>
 237 <p>
 238 Generates a textual representation of <em class="parameter"><code>icon</code></em> that can be used for
 239 serialization such as when passing <em class="parameter"><code>icon</code></em> to a different process or
 240 saving it to persistent storage. Use <a class="link" href="GIcon.html#g-icon-new-for-string" title="g_icon_new_for_string ()"><code class="function">g_icon_new_for_string()</code></a> to
 241 get <em class="parameter"><code>icon</code></em> back from the returned string.
 242 </p>
 243 <p>
 244 The encoding of the returned string is proprietary to <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> except
 245 in the following two cases
 246 </p>
 247 <p>
 248 </p>
 249 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 250 <li class="listitem"><p>
 251     If <em class="parameter"><code>icon</code></em> is a <a class="link" href="GFileIcon.html" title="GFileIcon"><span class="type">GFileIcon</span></a>, the returned string is a native path
 252     (such as <code class="literal">/path/to/my icon.png</code>) without escaping
 253     if the <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> for <em class="parameter"><code>icon</code></em> is a native file.  If the file is not
 254     native, the returned string is the result of <a class="link" href="GFile.html#g-file-get-uri" title="g_file_get_uri ()"><code class="function">g_file_get_uri()</code></a>
 255     (such as <code class="literal">sftp://path/to/my%20icon.png</code>).
 256 </p></li>
 257 <li class="listitem"><p>
 258    If <em class="parameter"><code>icon</code></em> is a <a class="link" href="GThemedIcon.html" title="GThemedIcon"><span class="type">GThemedIcon</span></a> with exactly one name, the encoding is
 259    simply the name (such as <code class="literal">network-server</code>).
 260 </p></li>
 261 </ul></div>
 262 <p>
 263 </p>
 264 <p>
 265 Virtual: to_tokens
 266 </p>
 267 <div class="variablelist"><table border="0">
 268 <col align="left" valign="top">
 269 <tbody>
 270 <tr>
 271 <td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 272 <td>a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>.</td>
 273 </tr>
 274 <tr>
 275 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 276 <td>An allocated NUL-terminated UTF8 string or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>icon</code></em> can't
 277 be serialized. Use <a href="./../glib/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> to free.</td>
 278 </tr>
 279 </tbody>
 280 </table></div>
 281 <p class="since">Since 2.20</p>
 282 </div>
 283 <hr>
 284 <div class="refsect2">
 285 <a name="g-icon-new-for-string"></a><h3>g_icon_new_for_string ()</h3>
 286 <pre class="programlisting"><a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> *             g_icon_new_for_string               (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
 287                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 288 <p>
 289 Generate a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> instance from <em class="parameter"><code>str</code></em>. This function can fail if
 290 <em class="parameter"><code>str</code></em> is not valid - see <a class="link" href="GIcon.html#g-icon-to-string" title="g_icon_to_string ()"><code class="function">g_icon_to_string()</code></a> for discussion.
 291 </p>
 292 <p>
 293 If your application or library provides one or more <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>
 294 implementations you need to ensure that each <a href="./../gobject/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> is registered
 295 with the type system prior to calling <a class="link" href="GIcon.html#g-icon-new-for-string" title="g_icon_new_for_string ()"><code class="function">g_icon_new_for_string()</code></a>.
 296 </p>
 297 <div class="variablelist"><table border="0">
 298 <col align="left" valign="top">
 299 <tbody>
 300 <tr>
 301 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 302 <td>A string obtained via <a class="link" href="GIcon.html#g-icon-to-string" title="g_icon_to_string ()"><code class="function">g_icon_to_string()</code></a>.</td>
 303 </tr>
 304 <tr>
 305 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 306 <td>Return location for error.</td>
 307 </tr>
 308 <tr>
 309 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 310 <td>An object implementing the <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>
 311 interface or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>error</code></em> is set. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 312 </td>
 313 </tr>
 314 </tbody>
 315 </table></div>
 316 <p class="since">Since 2.20</p>
 317 </div>
 318 </div>
 319 </div>
 320 <div class="footer">
 321 <hr>
 322           Generated by GTK-Doc V1.18</div>
 323 </body>
 324 </html>