<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="GFileIcon">
<refmeta>
<refentrytitle role="top_of_page" id="GFileIcon.top_of_page">GFileIcon</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GIO Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GFileIcon</refname>
<refpurpose>Icons pointing to an image file</refpurpose>
</refnamediv>

<refsynopsisdiv id="GFileIcon.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;gio/gio.h&gt;

                    <link linkend="GFileIcon-struct">GFileIcon</link>;
<link linkend="GIcon">GIcon</link> *             <link linkend="g-file-icon-new">g_file_icon_new</link>                     (<link linkend="GFile">GFile</link> *file);
<link linkend="GFile">GFile</link> *             <link linkend="g-file-icon-get-file">g_file_icon_get_file</link>                (<link linkend="GFileIcon">GFileIcon</link> *icon);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GFileIcon.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----GFileIcon
</synopsis>
</refsect1>



<refsect1 id="GFileIcon.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GFileIcon implements
 <link linkend="GIcon">GIcon</link> and  <link linkend="GLoadableIcon">GLoadableIcon</link>.</para>
</refsect1>


<refsect1 id="GFileIcon.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GFileIcon--file">file</link>&quot;                     <link linkend="GFile">GFile</link>*                : Read / Write / Construct Only
</synopsis>
</refsect1>



<refsect1 id="GFileIcon.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GFileIcon"><type>GFileIcon</type></link> specifies an icon by pointing to an image file
to be used as icon.</para>
<para>
</para>
</refsect1>

<refsect1 id="GFileIcon.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GFileIcon-struct" role="struct">
<title>GFileIcon</title>
<indexterm zone="GFileIcon-struct"><primary sortas="FileIcon">GFileIcon</primary></indexterm><programlisting>typedef struct _GFileIcon GFileIcon;</programlisting>
<para>
Gets an icon for a <link linkend="GFile"><type>GFile</type></link>. Implements <link linkend="GLoadableIcon"><type>GLoadableIcon</type></link>.</para>
<para>
</para></refsect2>
<refsect2 id="g-file-icon-new" role="function">
<title>g_file_icon_new ()</title>
<indexterm zone="g-file-icon-new"><primary sortas="file_icon_new">g_file_icon_new</primary></indexterm><programlisting><link linkend="GIcon">GIcon</link> *             g_file_icon_new                     (<link linkend="GFile">GFile</link> *file);</programlisting>
<para>
Creates a new icon for a file.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>file</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GFile"><type>GFile</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GIcon"><type>GIcon</type></link> for the given <parameter>file</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g-file-icon-get-file" role="function">
<title>g_file_icon_get_file ()</title>
<indexterm zone="g-file-icon-get-file"><primary sortas="file_icon_get_file">g_file_icon_get_file</primary></indexterm><programlisting><link linkend="GFile">GFile</link> *             g_file_icon_get_file                (<link linkend="GFileIcon">GFileIcon</link> *icon);</programlisting>
<para>
Gets the <link linkend="GFile"><type>GFile</type></link> associated with the given <parameter>icon</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>icon</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GIcon"><type>GIcon</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GFile"><type>GFile</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GFileIcon.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GFileIcon--file" role="property"><title>The <literal>&quot;file&quot;</literal> property</title>
<indexterm zone="GFileIcon--file"><primary sortas="FileIcon:file">GFileIcon:file</primary></indexterm><programlisting>  &quot;file&quot;                     <link linkend="GFile">GFile</link>*                : Read / Write / Construct Only</programlisting>
<para>
The file containing the icon.</para>
<para>
</para></refsect2>
</refsect1>



<refsect1 id="GFileIcon.see-also">
<title>See Also</title>
#GIcon, <link linkend="GLoadableIcon"><type>GLoadableIcon</type></link>
</refsect1>

</refentry>
