docs/reference/gio/html/GFileIcon.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>GFileIcon</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   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="GIcon.html" title="GIcon">
  10 <link rel="next" href="GLoadableIcon.html" title="GLoadableIcon">
  11 <meta name="generator" content="GTK-Doc V1.13 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 <link rel="part" href="pt01.html" title="Part I. GIO Overview">
  14 <link rel="chapter" href="ch01.html" title="Introduction">
  15 <link rel="chapter" href="ch02.html" title="Compiling GIO applications">
  16 <link rel="chapter" href="ch03.html" title="Running GIO applications">
  17 <link rel="chapter" href="extending-gio.html" title="Extending GIO">
  18 <link rel="part" href="pt02.html" title="Part II. API Reference">
  19 <link rel="chapter" href="file_ops.html" title="File Operations">
  20 <link rel="chapter" href="file_mon.html" title="File System Monitoring">
  21 <link rel="chapter" href="async.html" title="Asynchronous I/O">
  22 <link rel="chapter" href="conversion.html" title="Data conversion">
  23 <link rel="chapter" href="streaming.html" title="Streaming I/O">
  24 <link rel="chapter" href="types.html" title="File types and applications">
  25 <link rel="chapter" href="volume_mon.html" title="Volumes and Drives">
  26 <link rel="chapter" href="icons.html" title="Icons">
  27 <link rel="chapter" href="failable_initialization.html" title="Failable Initialization">
  28 <link rel="chapter" href="networking.html" title="Lowlevel platform-independent network support">
  29 <link rel="chapter" href="resolver.html" title="DNS resolution">
  30 <link rel="chapter" href="highlevel-socket.html" title="Highlevel network functionallity">
  31 <link rel="chapter" href="utils.html" title="Utilities">
  32 <link rel="chapter" href="extending.html" title="Extending GIO">
  33 <link rel="part" href="migrating.html" title="Part III. Migrating to GIO">
  34 <link rel="chapter" href="ch19.html" title="Migrating from POSIX to GIO">
  35 <link rel="chapter" href="ch20.html" title="Migrating from GnomeVFS to GIO">
  36 <link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
  37 <link rel="index" href="api-index-full.html" title="Index">
  38 <link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
  39 <link rel="index" href="api-index-2-18.html" title="Index of new symbols in 2.18">
  40 <link rel="index" href="api-index-2-20.html" title="Index of new symbols in 2.20">
  41 <link rel="index" href="api-index-2-22.html" title="Index of new symbols in 2.22">
  42 <link rel="index" href="api-index-2-24.html" title="Index of new symbols in 2.24">
  43 </head>
  44 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  45 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  46 <tr valign="middle">
  47 <td><a accesskey="p" href="GIcon.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  48 <td><a accesskey="u" href="icons.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  49 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  50 <th width="100%" align="center">GIO Reference Manual</th>
  51 <td><a accesskey="n" href="GLoadableIcon.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  52 </tr>
  53 <tr><td colspan="5" class="shortcuts">
  54 <a href="#GFileIcon.synopsis" class="shortcut">Top</a>
  55                    |
  56                   <a href="#GFileIcon.description" class="shortcut">Description</a>
  57                    |
  58                   <a href="#GFileIcon.object-hierarchy" class="shortcut">Object Hierarchy</a>
  59                    |
  60                   <a href="#GFileIcon.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  61                    |
  62                   <a href="#GFileIcon.properties" class="shortcut">Properties</a>
  63 </td></tr>
  64 </table>
  65 <div class="refentry" title="GFileIcon">
  66 <a name="GFileIcon"></a><div class="titlepage"></div>
  67 <div class="refnamediv"><table width="100%"><tr>
  68 <td valign="top">
  69 <h2><span class="refentrytitle"><a name="GFileIcon.top_of_page"></a>GFileIcon</span></h2>
  70 <p>GFileIcon — Icons pointing to an image file</p>
  71 </td>
  72 <td valign="top" align="right"></td>
  73 </tr></table></div>
  74 <div class="refsynopsisdiv" title="Synopsis">
  75 <a name="GFileIcon.synopsis"></a><h2>Synopsis</h2>
  76 <pre class="synopsis">
  77 #include &lt;gio/gio.h&gt;
  78
  79                     <a class="link" href="GFileIcon.html#GFileIcon-struct" title="GFileIcon">GFileIcon</a>;
  80 <a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> *             <a class="link" href="GFileIcon.html#g-file-icon-new" title="g_file_icon_new ()">g_file_icon_new</a>                     (<a class="link" href="GFile.html" title="GFile"><span class="returnvalue">GFile</span></a> *file);
  81 <a class="link" href="GFile.html" title="GFile"><span class="returnvalue">GFile</span></a> *             <a class="link" href="GFileIcon.html#g-file-icon-get-file" title="g_file_icon_get_file ()">g_file_icon_get_file</a>                (<a class="link" href="GFileIcon.html" title="GFileIcon"><span class="returnvalue">GFileIcon</span></a> *icon);
  82 </pre>
  83 </div>
  84 <div class="refsect1" title="Object Hierarchy">
  85 <a name="GFileIcon.object-hierarchy"></a><h2>Object Hierarchy</h2>
  86 <pre class="synopsis">
  87   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  88    +----GFileIcon
  89 </pre>
  90 </div>
  91 <div class="refsect1" title="Implemented Interfaces">
  92 <a name="GFileIcon.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  93 <p>
  94 GFileIcon implements
  95  <a class="link" href="GIcon.html" title="GIcon">GIcon</a> and  <a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a>.</p>
  96 </div>
  97 <div class="refsect1" title="Properties">
  98 <a name="GFileIcon.properties"></a><h2>Properties</h2>
  99 <pre class="synopsis">
 100   "<a class="link" href="GFileIcon.html#GFileIcon--file" title='The "file" property'>file</a>"                     <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>*                : Read / Write / Construct Only
 101 </pre>
 102 </div>
 103 <div class="refsect1" title="Description">
 104 <a name="GFileIcon.description"></a><h2>Description</h2>
 105 <p>
 106 <a class="link" href="GFileIcon.html" title="GFileIcon"><span class="type">GFileIcon</span></a> specifies an icon by pointing to an image file
 107 to be used as icon.</p>
 108 </div>
 109 <div class="refsect1" title="Details">
 110 <a name="GFileIcon.details"></a><h2>Details</h2>
 111 <div class="refsect2" title="GFileIcon">
 112 <a name="GFileIcon-struct"></a><h3>GFileIcon</h3>
 113 <pre class="programlisting">typedef struct _GFileIcon GFileIcon;</pre>
 114 <p>
 115 Gets an icon for a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>. Implements <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a>.</p>
 116 </div>
 117 <hr>
 118 <div class="refsect2" title="g_file_icon_new ()">
 119 <a name="g-file-icon-new"></a><h3>g_file_icon_new ()</h3>
 120 <pre class="programlisting"><a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> *             g_file_icon_new                     (<a class="link" href="GFile.html" title="GFile"><span class="returnvalue">GFile</span></a> *file);</pre>
 121 <p>
 122 Creates a new icon for a file.</p>
 123 <div class="variablelist"><table border="0">
 124 <col align="left" valign="top">
 125 <tbody>
 126 <tr>
 127 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
 128 <td> a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>.
 129 </td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 133 <td> a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> for the given <em class="parameter"><code>file</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.
 134 </td>
 135 </tr>
 136 </tbody>
 137 </table></div>
 138 </div>
 139 <hr>
 140 <div class="refsect2" title="g_file_icon_get_file ()">
 141 <a name="g-file-icon-get-file"></a><h3>g_file_icon_get_file ()</h3>
 142 <pre class="programlisting"><a class="link" href="GFile.html" title="GFile"><span class="returnvalue">GFile</span></a> *             g_file_icon_get_file                (<a class="link" href="GFileIcon.html" title="GFileIcon"><span class="returnvalue">GFileIcon</span></a> *icon);</pre>
 143 <p>
 144 Gets the <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> associated with the given <em class="parameter"><code>icon</code></em>.</p>
 145 <div class="variablelist"><table border="0">
 146 <col align="left" valign="top">
 147 <tbody>
 148 <tr>
 149 <td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 150 <td> a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>.
 151 </td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 155 <td> a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 156 </td>
 157 </tr>
 158 </tbody>
 159 </table></div>
 160 </div>
 161 </div>
 162 <div class="refsect1" title="Property Details">
 163 <a name="GFileIcon.property-details"></a><h2>Property Details</h2>
 164 <div class="refsect2" title='The "file" property'>
 165 <a name="GFileIcon--file"></a><h3>The <code class="literal">"file"</code> property</h3>
 166 <pre class="programlisting">  "file"                     <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>*                : Read / Write / Construct Only</pre>
 167 <p>
 168 The file containing the icon.</p>
 169 </div>
 170 </div>
 171 <div class="refsect1" title="See Also">
 172 <a name="GFileIcon.see-also"></a><h2>See Also</h2>
 173 <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>, <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a>
 174 </div>
 175 </div>
 176 <div class="footer">
 177 <hr>
 178           Generated by GTK-Doc V1.13</div>
 179 </body>
 180 </html>