blob: b55e69ebcd193ffa16986e51ba03bafb1ebdd8a1 (
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
<?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-gtkfilechooserwidget">
<refnamediv>
<refname>gtk.FileChooserWidget</refname> <refpurpose>a file chooser
widget that can be embedded in other widgets(new in PyGTK
2.4)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.FileChooserWidget</classname></ooclass>
<ooclass><classname><link linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
<ooclass><classname><link linkend="class-gtkfilechooser">gtk.FileChooser</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkfilechooserwidget">gtk.FileChooserWidget</link></methodname>
<methodparam><parameter role="keyword">action</parameter><initializer><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></initializer></methodparam>
<methodparam><parameter role="keyword">backend</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbox">gtk.Box</link>
+-- <link linkend="class-gtkvbox">gtk.VBox</link>
+-- <link linkend="class-gtkfilechooserwidget">gtk.FileChooserWidget</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
<link linkend="class-gtkfilechooser">gtk.FileChooser</link>
</para>
</refsect1>
<refsect1 id="properties-gtkfilechooserwidget">
<title>gtk.FileChooserWidget Properties</title>
<para><link linkend="properties-gtkfilechooser">gtk.FileChooser Properties</link></para>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
</refsect1>
<refsect1 id="style-properties-gtkfilechooserwidget">
<title>gtk.FileChooserWidget Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
</refsect1>
<refsect1 id="child-properties-gtkfilechooserwidget">
<title>gtk.FileChooserWidget Child Properties</title>
<para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtkfilechooserwidget">
<title>gtk.FileChooserWidget Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkfilechooser">gtk.FileChooser Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<note>
<para>This widget is available in PyGTK 2.4 and above.</para>
</note>
<para>The <link
linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
is a widget suitable for selecting files. It is the main building block
of a <link
linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. Most
applications will only need to use the latter; you can use <link
linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
as part of a larger window if you have special needs.</para>
<para>Note that <link
linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
does not have any methods, signals or properties of its own. Instead,
you should use the methods, signals and properties of the <link
linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para>
</refsect1>
<refsect1 id="constructor-gtkfilechooserwidget">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.FileChooserWidget</methodname>
<methodparam><parameter role="keyword">action</parameter><initializer><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></initializer></methodparam>
<methodparam><parameter role="keyword">backend</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">action</parameter> :</term>
<listitem><simpara>The open or save mode for the
widget or <literal>None</literal>.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">backend</parameter> :</term>
<listitem><simpara>The name of the specific filesystem backend to
use or <literal>None</literal>.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.4 and above.</para>
</note>
<para>Creates a new <link
linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>.
This is a file chooser widget that can be embedded in custom windows, and it
is the same widget that is used by <link
linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>.</para>
</refsect1>
</refentry>
|
