← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/gfileicon.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-23 19:25:52 UTC
  • mfrom: (3.4.9 experimental)
  • Revision ID: james.westby@ubuntu.com-20100323192552-istna8c33bw6harh
Tags: 2.23.6-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gfileicon.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
5
 
<!ENTITY version SYSTEM "version.xml">
6
 
]>
7
 
<refentry id="GFileIcon">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="GFileIcon.top_of_page">GFileIcon</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>GIO Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>GFileIcon</refname>
16
 
<refpurpose>Icons pointing to an image file</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="GFileIcon.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
 
24
 
#include &lt;gio/gio.h&gt;
25
 
 
26
 
                    <link linkend="GFileIcon-struct">GFileIcon</link>;
27
 
<link linkend="GIcon">GIcon</link> *             <link linkend="g-file-icon-new">g_file_icon_new</link>                     (<link linkend="GFile">GFile</link> *file);
28
 
<link linkend="GFile">GFile</link> *             <link linkend="g-file-icon-get-file">g_file_icon_get_file</link>                (<link linkend="GFileIcon">GFileIcon</link> *icon);
29
 
</synopsis>
30
 
</refsynopsisdiv>
31
 
 
32
 
<refsect1 id="GFileIcon.object-hierarchy" role="object_hierarchy">
33
 
<title role="object_hierarchy.title">Object Hierarchy</title>
34
 
<synopsis>
35
 
  <link linkend="GObject">GObject</link>
36
 
   +----GFileIcon
37
 
</synopsis>
38
 
</refsect1>
39
 
 
40
 
 
41
 
 
42
 
<refsect1 id="GFileIcon.implemented-interfaces" role="impl_interfaces">
43
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
44
 
<para>
45
 
GFileIcon implements
46
 
 <link linkend="GIcon">GIcon</link> and  <link linkend="GLoadableIcon">GLoadableIcon</link>.</para>
47
 
</refsect1>
48
 
 
49
 
 
50
 
<refsect1 id="GFileIcon.properties" role="properties">
51
 
<title role="properties.title">Properties</title>
52
 
<synopsis>
53
 
  &quot;<link linkend="GFileIcon--file">file</link>&quot;                     <link linkend="GFile">GFile</link>*                : Read / Write / Construct Only
54
 
</synopsis>
55
 
</refsect1>
56
 
 
57
 
 
58
 
 
59
 
<refsect1 id="GFileIcon.description" role="desc">
60
 
<title role="desc.title">Description</title>
61
 
<para>
62
 
<link linkend="GFileIcon"><type>GFileIcon</type></link> specifies an icon by pointing to an image file
63
 
to be used as icon.</para>
64
 
<para>
65
 
</para>
66
 
</refsect1>
67
 
 
68
 
<refsect1 id="GFileIcon.details" role="details">
69
 
<title role="details.title">Details</title>
70
 
<refsect2 id="GFileIcon-struct" role="struct">
71
 
<title>GFileIcon</title>
72
 
<indexterm zone="GFileIcon-struct"><primary sortas="FileIcon">GFileIcon</primary></indexterm><programlisting>typedef struct _GFileIcon GFileIcon;</programlisting>
73
 
<para>
74
 
Gets an icon for a <link linkend="GFile"><type>GFile</type></link>. Implements <link linkend="GLoadableIcon"><type>GLoadableIcon</type></link>.</para>
75
 
<para>
76
 
</para></refsect2>
77
 
<refsect2 id="g-file-icon-new" role="function">
78
 
<title>g_file_icon_new ()</title>
79
 
<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>
80
 
<para>
81
 
Creates a new icon for a file.</para>
82
 
<para>
83
 
</para><variablelist role="params">
84
 
<varlistentry><term><parameter>file</parameter>&#160;:</term>
85
 
<listitem><simpara> a <link linkend="GFile"><type>GFile</type></link>.
86
 
</simpara></listitem></varlistentry>
87
 
<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.
88
 
</simpara></listitem></varlistentry>
89
 
</variablelist></refsect2>
90
 
<refsect2 id="g-file-icon-get-file" role="function">
91
 
<title>g_file_icon_get_file ()</title>
92
 
<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>
93
 
<para>
94
 
Gets the <link linkend="GFile"><type>GFile</type></link> associated with the given <parameter>icon</parameter>.</para>
95
 
<para>
96
 
</para><variablelist role="params">
97
 
<varlistentry><term><parameter>icon</parameter>&#160;:</term>
98
 
<listitem><simpara> a <link linkend="GIcon"><type>GIcon</type></link>.
99
 
</simpara></listitem></varlistentry>
100
 
<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>.
101
 
</simpara></listitem></varlistentry>
102
 
</variablelist></refsect2>
103
 
 
104
 
</refsect1>
105
 
<refsect1 id="GFileIcon.property-details" role="property_details">
106
 
<title role="property_details.title">Property Details</title>
107
 
<refsect2 id="GFileIcon--file" role="property"><title>The <literal>&quot;file&quot;</literal> property</title>
108
 
<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>
109
 
<para>
110
 
The file containing the icon.</para>
111
 
<para>
112
 
</para></refsect2>
113
 
</refsect1>
114
 
 
115
 
 
116
 
 
117
 
<refsect1 id="GFileIcon.see-also">
118
 
<title>See Also</title>
119
 
#GIcon, <link linkend="GLoadableIcon"><type>GLoadableIcon</type></link>
120
 
</refsect1>
121
 
 
122
 
</refentry>