File: pygtk-gtkfilechooserdialog.xml

package info (click to toggle)
pygtk 2.24.0-5.1
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 26,760 kB
  • ctags: 8,260
  • sloc: xml: 182,079; sh: 10,297; python: 10,161; ansic: 2,861; makefile: 1,358
file content (178 lines) | stat: -rw-r--r-- 8,473 bytes parent folder | download | duplicates (5)
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<?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-gtkfilechooserdialog">
  <refnamediv>
    <refname>gtk.FileChooserDialog</refname> <refpurpose>a file chooser
    dialog, suitable for "File/Open" or "File/Save" commands(new in PyGTK
    2.4)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.FileChooserDialog</classname></ooclass>
      <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
      <ooclass><classname><link linkend="class-gtkfilechooser">gtk.FileChooser</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link linkend="constructor-gtkfilechooserdialog">gtk.FileChooserDialog</link></methodname>
	<methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">action</parameter><initializer><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></initializer></methodparam>
	<methodparam><parameter role="keyword">buttons</parameter><initializer>None</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-gtkbin">gtk.Bin</link>
          +-- <link linkend="class-gtkwindow">gtk.Window</link>
            +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
              +-- <link linkend="class-gtkfilechooserdialog">gtk.FileChooserDialog</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
            <link linkend="class-gtkfilechooser">gtk.FileChooser</link>
		</para>
	</refsect1>


  <refsect1 id="properties-gtkfilechooserdialog">
    <title>gtk.FileChooserDialog 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-gtkwindow">gtk.Window Properties</link></para>
    <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkfilechooserdialog">
    <title>gtk.FileChooserDialog Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkfilechooserdialog">
    <title>gtk.FileChooserDialog 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-gtkwindow">gtk.Window Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog 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><link
    linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
    is a dialog box suitable for use with "File/Open" or "File/Save as"
    commands. This widget works by putting a <link
    linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
    inside a <link
    linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>. It
    implements the <link
    linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
    interface, so you can use all of the <link
    linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
    methods, signals and properties on the file chooser dialog as well as
    those for <link
    linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>.</para>

    <para>Note that <link
    linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
    does not have any methods of its own. Instead, you should use the
    methods and signals that work on a <link
    linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para>

  </refsect1>

  <refsect1 id="constructor-gtkfilechooserdialog">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.FileChooserDialog</methodname>
	<methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">action</parameter><initializer><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></initializer></methodparam>
	<methodparam><parameter role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">backend</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><parameter role="keyword">title</parameter>&nbsp;:</term>
	<listitem><simpara>The title of the dialog</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">parent</parameter>&nbsp;:</term>
	<listitem><simpara>The transient parent of the dialog, or <literal>None</literal></simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">action</parameter>&nbsp;:</term>
	<listitem>
	  <simpara>The open or save mode for the dialog - one of:
<literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal>,
<literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal>,
<literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal> or
<literal>gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER</literal>.</simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">buttons</parameter>&nbsp;:</term>
	<listitem><simpara>a tuple containing button label-response id pairs
	or <literal>None</literal></simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">backend</parameter>&nbsp;:</term>
	<listitem><simpara>The name of the specific filesystem backend to
use.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</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-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. The
constructor can be invoked with the optional parameters:
<parameter>title</parameter>, <parameter>parent</parameter>,
<parameter>action</parameter>, <parameter>buttons</parameter> and
<parameter>backend</parameter>. This constructor is analogous to the
<link linkend="constructor-gtkdialog">gtk.Dialog</link>() constructor.</para>

  </refsect1>

</refentry>