blob: d4a443b3608313c689fc398746d9188aebae90ab (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-giofileicon">
<refnamediv>
<refname>gio.FileIcon</refname>
<refpurpose>Icons pointing to an image file.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.FileIcon</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<ooclass><classname><link linkend="class-gioicon">gio.Icon</link></classname></ooclass>
<ooclass><classname><link linkend="class-gioloadableicon">gio.LoadableIcon</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-giofileicon">gio.FileIcon</link></methodname>
<methodparam><parameter role="keyword">file</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giofileicon--get-file">get_file</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-giofileicon">gio.FileIcon</link>
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
The <link linkend="class-giofileicon"><classname>gio.FileIcon</classname></link>
specifies an icon by pointing to an image file to be used as icon.
</para>
</refsect1>
<refsect1 id="constructor-giofileicon">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gio.FileIcon</methodname>
<methodparam><parameter role="keyword">file</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>file</parameter> :</term>
<listitem><simpara>a
<link linkend="class-giofile"><classname>gio.File</classname></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new
<link linkend="class-giofileicon"><classname>gio.FileIcon</classname></link>
for the given file, or <literal>None</literal> on error.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new icon for a file.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-giofileicon--get-file">
<title>gio.FileIcon.get_file</title>
<programlisting><methodsynopsis language="python">
<methodname>get_file</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a
<link linkend="class-giofile"><classname>gio.File</classname></link>
or <literal>None</literal>.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_file</methodname>() method gets the
<link linkend="class-giofile"><classname>gio.File</classname></link>
associated with the given icon.
</para>
</refsect2>
</refsect1>
</refentry>
|
