File: class-gtkfilechooserdialog.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 8,304 kB
  • ctags: 3,741
  • sloc: makefile: 38
file content (32 lines) | stat: -rw-r--r-- 8,983 bytes parent folder | download
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
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.FileChooserDialog</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="previous" href="class-gtkfilechooserbutton.html" title="gtk.FileChooserButton"><link rel="next" href="class-gtkfilechooserwidget.html" title="gtk.FileChooserWidget"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.FileChooserDialog</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkfilechooserbutton.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtkfilechooserwidget.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkfilechooserdialog"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.FileChooserDialog</h2><p>gtk.FileChooserDialog &#8212; a file chooser
    dialog, suitable for "File/Open" or "File/Save" commands(new in PyGTK
    2.4)</p></div><div class="refsect1" lang="en"><a name="id3419908"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.FileChooserDialog</span></span>(<span class="ooclass"><span class="classname"><a href="class-gtkdialog.html" title="gtk.Dialog">gtk.Dialog</a></span></span>, <span class="ooclass"><span class="classname"><a href="class-gtkfilechooser.html" title="gtk.FileChooser">gtk.FileChooser</a></span></span>):
<code class="constructorsynopsis">    <span class="methodname"><a href="class-gtkfilechooserdialog.html#constructor-gtkfilechooserdialog" title="Constructor">gtk.FileChooserDialog</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>title</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>parent</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>action</tt></b></span><span class="initializer">=gtk.FILE_CHOOSER_ACTION_OPEN</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>buttons</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>backend</tt></b></span><span class="initializer">=None</span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3419993"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
  +-- <a href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
    +-- <a href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
      +-- <a href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
        +-- <a href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
          +-- <a href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a>
            +-- <a href="class-gtkdialog.html" title="gtk.Dialog">gtk.Dialog</a>
              +-- <a href="class-gtkfilechooserdialog.html" title="gtk.FileChooserDialog">gtk.FileChooserDialog</a> (implements <a href="class-gtkfilechooser.html" title="gtk.FileChooser">gtk.FileChooser</a>)
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3420049"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This widget is available in PyGTK 2.4 and above.</p></div><p><a href="class-gtkfilechooserdialog.html" title="gtk.FileChooserDialog"><tt class="classname">gtk.FileChooserDialog</tt></a>
is a dialog box suitable for use with "File/Open" or "File/Save as"
commands. This widget works by putting a <a href="class-gtkfilechooserwidget.html" title="gtk.FileChooserWidget"><tt class="classname">gtk.FileChooserWidget</tt></a>
inside a <a href="class-gtkdialog.html" title="gtk.Dialog"><tt class="classname">gtk.Dialog</tt></a>. It
implements the <a href="class-gtkfilechooser.html" title="gtk.FileChooser"><tt class="classname">gtk.FileChooser</tt></a>
interface, so you can use all of the <a href="class-gtkfilechooser.html" title="gtk.FileChooser"><tt class="classname">gtk.FileChooser</tt></a>
methods, signals and properties on the file chooser dialog as well as those
for <a href="class-gtkdialog.html" title="gtk.Dialog"><tt class="classname">gtk.Dialog</tt></a>.</p><p>Note that <a href="class-gtkfilechooserdialog.html" title="gtk.FileChooserDialog"><tt class="classname">gtk.FileChooserDialog</tt></a>
does not have any methods of its own. Instead, you should use the methods
and signals that work on a <a href="class-gtkfilechooser.html" title="gtk.FileChooser"><tt class="classname">gtk.FileChooser</tt></a>.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkfilechooserdialog"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.FileChooserDialog</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>title</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>parent</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>action</tt></b></span><span class="initializer">=gtk.FILE_CHOOSER_ACTION_OPEN</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>buttons</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>backend</tt></b></span><span class="initializer">=None</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>title</tt></b>:</span></td><td>The title of the dialog</td></tr><tr><td><span class="term"><b class="parameter"><tt>parent</tt></b>:</span></td><td>The transient parent of the dialog, or <tt class="literal">None</tt></td></tr><tr><td><span class="term"><b class="parameter"><tt>action</tt></b>:</span></td><td>The open or save mode for the dialog - one of:
<tt class="literal">gtk.FILE_CHOOSER_ACTION_OPEN</tt>,
<tt class="literal">gtk.FILE_CHOOSER_ACTION_SAVE</tt>,
<tt class="literal">gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</tt> or
<tt class="literal">gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER</tt>.</td></tr><tr><td><span class="term"><b class="parameter"><tt>buttons</tt></b>:</span></td><td>a tuple containing button label-response id pairs
	or <tt class="literal">None</tt></td></tr><tr><td><span class="term"><b class="parameter"><tt>backend</tt></b>:</span></td><td>The name of the specific filesystem backend to
use.</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="class-gtkfilechooserdialog.html" title="gtk.FileChooserDialog"><tt class="classname">gtk.FileChooserDialog</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new <a href="class-gtkfilechooserdialog.html" title="gtk.FileChooserDialog"><tt class="classname">gtk.FileChooserDialog</tt></a>. The
constructor can be invoked with the optional parameters:
<i class="parameter"><tt>title</tt></i>, <i class="parameter"><tt>parent</tt></i>,
<i class="parameter"><tt>action</tt></i>, <i class="parameter"><tt>buttons</tt></i> and
<i class="parameter"><tt>backend</tt></i>. This constructor is analogous to the
<a href="class-gtkdialog.html#constructor-gtkdialog" title="Constructor">gtk.Dialog</a>() constructor.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkfilechooserbutton.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gtkfilechooserwidget.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.FileChooserButton</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.FileChooserWidget</td></tr></table></div></body></html>