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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QFileDialog Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QFileDialog Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1><p>The QFileDialog class provides a dialog that allow users to select files or directories. <a href="#details">More...</a></p>
<p>Inherits <a href="qdialog.html">QDialog</a>.</p><h3>Types</h3><ul><li><div class="fn" />enum <b><a href="qfiledialog.html#AcceptMode-enum">AcceptMode</a></b> { AcceptOpen, AcceptSave }</li><li><div class="fn" />enum <b><a href="qfiledialog.html#DialogLabel-enum">DialogLabel</a></b> { LookIn, FileName, FileType, Accept, Reject }</li><li><div class="fn" />enum <b><a href="qfiledialog.html#FileMode-enum">FileMode</a></b> { AnyFile, ExistingFile, Directory, ExistingFiles, DirectoryOnly }</li><li><div class="fn" />enum <b><a href="qfiledialog.html#Option-enum">Option</a></b> { ShowDirsOnly, DontResolveSymlinks, DontConfirmOverwrite, DontUseSheet, DontUseNativeDialog }</li><li><div class="fn" />class <b><a href="qfiledialog-options.html">Options</a></b></li><li><div class="fn" />enum <b><a href="qfiledialog.html#ViewMode-enum">ViewMode</a></b> { Detail, List }</li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qfiledialog.html#QFileDialog">__init__</a></b> (<i>self</i>, QWidget <i>parent</i>, Qt.WindowFlags <i>f</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#QFileDialog-2">__init__</a></b> (<i>self</i>, QWidget <i>parent</i> = None, QString <i>caption</i> = QString(), QString <i>directory</i> = QString(), QString <i>filter</i> = QString())</li><li><div class="fn" /><b><a href="qfiledialog.html#accept">accept</a></b> (<i>self</i>)</li><li><div class="fn" />AcceptMode <b><a href="qfiledialog.html#acceptMode">acceptMode</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qfiledialog.html#confirmOverwrite">confirmOverwrite</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qfiledialog.html#defaultSuffix">defaultSuffix</a></b> (<i>self</i>)</li><li><div class="fn" />QDir <b><a href="qfiledialog.html#directory">directory</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#done">done</a></b> (<i>self</i>, int <i>result</i>)</li><li><div class="fn" />FileMode <b><a href="qfiledialog.html#fileMode">fileMode</a></b> (<i>self</i>)</li><li><div class="fn" />QStringList <b><a href="qfiledialog.html#filters">filters</a></b> (<i>self</i>)</li><li><div class="fn" />QStringList <b><a href="qfiledialog.html#history">history</a></b> (<i>self</i>)</li><li><div class="fn" />QFileIconProvider <b><a href="qfiledialog.html#iconProvider">iconProvider</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qfiledialog.html#isReadOnly">isReadOnly</a></b> (<i>self</i>)</li><li><div class="fn" />QAbstractItemDelegate <b><a href="qfiledialog.html#itemDelegate">itemDelegate</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qfiledialog.html#labelText">labelText</a></b> (<i>self</i>, DialogLabel <i>label</i>)</li><li><div class="fn" />bool <b><a href="qfiledialog.html#resolveSymlinks">resolveSymlinks</a></b> (<i>self</i>)</li><li><div class="fn" />QStringList <b><a href="qfiledialog.html#selectedFiles">selectedFiles</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qfiledialog.html#selectedFilter">selectedFilter</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#selectFile">selectFile</a></b> (<i>self</i>, QString <i>filename</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#selectFilter">selectFilter</a></b> (<i>self</i>, QString <i>filter</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setAcceptMode">setAcceptMode</a></b> (<i>self</i>, AcceptMode <i>mode</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setConfirmOverwrite">setConfirmOverwrite</a></b> (<i>self</i>, bool <i>enabled</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setDefaultSuffix">setDefaultSuffix</a></b> (<i>self</i>, QString <i>suffix</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setDirectory">setDirectory</a></b> (<i>self</i>, QString <i>directory</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setDirectory-2">setDirectory</a></b> (<i>self</i>, QDir <i>adirectory</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setFileMode">setFileMode</a></b> (<i>self</i>, FileMode <i>mode</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setFilter">setFilter</a></b> (<i>self</i>, QString <i>filter</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setFilters">setFilters</a></b> (<i>self</i>, QStringList <i>filters</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setHistory">setHistory</a></b> (<i>self</i>, QStringList <i>paths</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setIconProvider">setIconProvider</a></b> (<i>self</i>, QFileIconProvider <i>provider</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setItemDelegate">setItemDelegate</a></b> (<i>self</i>, QAbstractItemDelegate <i>delegate</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setLabelText">setLabelText</a></b> (<i>self</i>, DialogLabel <i>label</i>, QString <i>text</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setReadOnly">setReadOnly</a></b> (<i>self</i>, bool <i>enabled</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setResolveSymlinks">setResolveSymlinks</a></b> (<i>self</i>, bool <i>enabled</i>)</li><li><div class="fn" /><b><a href="qfiledialog.html#setViewMode">setViewMode</a></b> (<i>self</i>, ViewMode <i>mode</i>)</li><li><div class="fn" />ViewMode <b><a href="qfiledialog.html#viewMode">viewMode</a></b> (<i>self</i>)</li></ul><h3>Static Methods</h3><ul><li><div class="fn" />QString <b><a href="qfiledialog.html#getExistingDirectory">getExistingDirectory</a></b> (QWidget <i>parent</i> = None, QString <i>caption</i> = QString(), QString <i>dir</i> = QString(), Options <i>options</i> = QFileDialog.ShowDirsOnly)</li><li><div class="fn" />QString <b><a href="qfiledialog.html#getOpenFileName">getOpenFileName</a></b> (QWidget <i>parent</i> = None, QString <i>caption</i> = QString(), QString <i>dir</i> = QString(), QString <i>filter</i> = QString(), QString <i>selectedFilter</i> = None, Options <i>options</i> = 0)</li><li><div class="fn" />QStringList <b><a href="qfiledialog.html#getOpenFileNames">getOpenFileNames</a></b> (QWidget <i>parent</i> = None, QString <i>caption</i> = QString(), QString <i>dir</i> = QString(), QString <i>filter</i> = QString(), QString <i>selectedFilter</i> = None, Options <i>options</i> = 0)</li><li><div class="fn" />QString <b><a href="qfiledialog.html#getSaveFileName">getSaveFileName</a></b> (QWidget <i>parent</i> = None, QString <i>caption</i> = QString(), QString <i>dir</i> = QString(), QString <i>filter</i> = QString(), QString <i>selectedFilter</i> = None, Options <i>options</i> = 0)</li></ul><h3>Qt Signals</h3><ul><li><div class="fn" />void <b><a href="qfiledialog.html#currentChanged">currentChanged</a></b> (const QString&)</li><li><div class="fn" />void <b><a href="qfiledialog.html#filesSelected">filesSelected</a></b> (const QStringList&)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QFileDialog class provides a dialog that allow users to select files or directories.</p>
<p>The QFileDialog class enables a user to traverse the file system in order to select one or many files or a directory.</p>
<p>The easiest way to create a QFileDialog is to use the static functions. On Windows, these static functions will call the native Windows file dialog, and on Mac OS X these static function will call the native Mac OS X file dialog.</p>
<pre>
QString s = QFileDialog.getOpenFileName(
this,
"Choose a file",
"/home",
"Images (*.png *.xpm *.jpg)");
</pre>
<p>In the above example, a modal QFileDialog is created using a static function. The dialog initially displays the contents of the "/home" directory, and displays files matching the patterns given in the string "Images (*.png *.xpm *.jpg)". The parent of the file dialog is set to <i>this</i>, and the dialog is named "open file dialog". The caption at the top of file dialog is set to "Choose a file" instead of the default.</p>
<p>If you want to use multiple filters, separate each one with <i>two</i> semicolons. For example:</p>
<pre>
"Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)"
</pre>
<p>You can create your own QFileDialog without using the static functions. By calling <a href="qfiledialog.html#fileMode-prop">setFileMode</a>(), you can specify what the user must select in the dialog:</p>
<pre>
QFileDialog *fd = new QFileDialog(this);
fd->setFileMode(QFileDialog.AnyFile);
</pre>
<p>In the above example, the mode of the file dialog is set to <a href="qfiledialog.html#FileMode-enum">AnyFile</a>, meaning that the user can select any file, or even specify a file that doesn't exist. This mode is useful for creating a "Save As" file dialog. Use <a href="qfiledialog.html#FileMode-enum">ExistingFile</a> if the user must select an existing file, or <a href="qfiledialog.html#FileMode-enum">Directory</a> if only a directory may be selected. See the <a href="qfiledialog.html#FileMode-enum">QFileDialog.FileMode</a> enum for the complete list of modes.</p>
<p>You can retrieve the dialog's mode with <a href="qfiledialog-qt3.html#mode">mode</a>(). Use <a href="qfiledialog.html#setFilter">setFilter</a>() to set the dialog's file filter. For example:</p>
<pre>
fd->setFilter( "Images (*.png *.xpm *.jpg)" );
</pre>
<p>In the above example, the filter is set to "Images (*.png *.xpm *.jpg)", this means that only files with the extension <tt>png</tt>, <tt>xpm</tt>, or <tt>jpg</tt> will be shown in the QFileDialog. You can apply several filters by using <a href="qfiledialog.html#setFilters">setFilters</a>(). Use <a href="qfiledialog.html#selectFilter">selectFilter</a>() to select one of the filters you've given as the file dialog's default filter.</p>
<p>The file dialog has two view modes: <a href="qfiledialog.html#ViewMode-enum">QFileDialog.List</a> and <a href="qfiledialog.html#ViewMode-enum">QFileDialog.Detail</a>. <a href="qfiledialog.html#ViewMode-enum">QFileDialog.List</a> presents the contents of the current directory as a list of file and directory names. <a href="qfiledialog.html#ViewMode-enum">QFileDialog.Detail</a> also displays a list of file and directory names, but provides additional information alongside each name, such as the file size and modification date. Set the mode with <a href="qfiledialog.html#viewMode-prop">setViewMode</a>().</p>
<pre>
fd->setViewMode(QFileDialog.Detail);
</pre>
<p>The last important function you will need to use when creating your own file dialog is <a href="qfiledialog.html#selectedFiles">selectedFiles</a>().</p>
<pre>
QStringList fileNames;
if (fileDialog->exec())
fileNames = fileDialog->selectedFiles();
</pre>
<p>In the above example, a modal file dialog is created and shown. If the user clicked OK, the file they selected is put in <tt>fileName</tt>.</p>
<p>The dialog's working directory can be set with <a href="qfiledialog.html#setDirectory">setDirectory</a>(). Each file in the current directory can be selected using the <a href="qfiledialog.html#selectFile">selectFile</a>() function.</p>
<p>The <a href="dialogs-standarddialogs.html">Standard Dialogs</a> example shows how to use QFileDialog as well as other built-in Qt dialogs.</p>
<hr /><h2>Type Documentation</h2><h3 class="fn"><a name="AcceptMode-enum" />QFileDialog.AcceptMode</h3><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.AcceptOpen</tt></td>
<td align="center" valign="top"><tt>0</tt></td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.AcceptSave</tt></td>
<td align="center" valign="top"><tt>1</tt></td>
</tr>
</table>
<br />
<br />
<h3 class="fn"><a name="DialogLabel-enum" />QFileDialog.DialogLabel</h3><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.LookIn</tt></td>
<td align="center" valign="top"><tt>0</tt></td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.FileName</tt></td>
<td align="center" valign="top"><tt>1</tt></td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.FileType</tt></td>
<td align="center" valign="top"><tt>2</tt></td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.Accept</tt></td>
<td align="center" valign="top"><tt>3</tt></td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.Reject</tt></td>
<td align="center" valign="top"><tt>4</tt></td>
</tr>
</table>
<br />
<br />
<h3 class="fn"><a name="FileMode-enum" />QFileDialog.FileMode</h3><p>This enum is used to indicate what the user may select in the file dialog; i.e. what the dialog will return if the user clicks OK.</p>
<table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr>
<th width="25%">Constant</th>
<th width="15%">Value</th>
<th width="60%">Description</th>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.AnyFile</tt></td>
<td align="center" valign="top"><tt>0</tt></td>
<td valign="top">The name of a file, whether it exists or not.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.ExistingFile</tt></td>
<td align="center" valign="top"><tt>1</tt></td>
<td valign="top">The name of a single existing file.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.Directory</tt></td>
<td align="center" valign="top"><tt>2</tt></td>
<td valign="top">The name of a directory. Both files and directories are displayed.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.DirectoryOnly</tt></td>
<td align="center" valign="top"><tt>4</tt></td>
<td valign="top">The name of a directory. The file dialog will only display directories.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.ExistingFiles</tt></td>
<td align="center" valign="top"><tt>3</tt></td>
<td valign="top">The names of zero or more existing files.</td>
</tr>
</table>
<br />
<br />
<p>See also <a href="qfiledialog.html#fileMode-prop">setFileMode</a>().</p>
<h3 class="fn"><a name="Option-enum" />QFileDialog.Option</h3><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr>
<th width="25%">Constant</th>
<th width="15%">Value</th>
<th width="60%">Description</th>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.ShowDirsOnly</tt></td>
<td align="center" valign="top"><tt>0x01</tt></td>
<td valign="top">Only show directories in the file dialog. By default both files and directories are shown.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.DontResolveSymlinks</tt></td>
<td align="center" valign="top"><tt>0x02</tt></td>
<td valign="top">Don't resolve symlinks in the file dialog. By default symlinks are resolved.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.DontConfirmOverwrite</tt></td>
<td align="center" valign="top"><tt>0x04</tt></td>
<td valign="top">Don't ask for confirmation if an existing file is selected. By default confirmation is requested.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.DontUseSheet</tt></td>
<td align="center" valign="top"><tt>0x08</tt></td>
<td valign="top">Don't make the native file dialog a sheet. By default on Mac OS X, the native file dialog is made a sheet if it has a parent that can take a sheet.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.DontUseNativeDialog</tt></td>
<td align="center" valign="top"><tt>0x10</tt></td>
<td valign="top">Don't use the native file dialog. By default on Mac OS X and Windows, the native file dialog is used.</td>
</tr>
</table>
<br />
<br />
<p>The Options type is a typedef for <a href="qflags.html">QFlags</a><Option>. It stores an OR combination of Option values.</p>
<h3 class="fn"><a name="ViewMode-enum" />QFileDialog.ViewMode</h3><p>This enum describes the view mode of the file dialog; i.e. what information about each file will be displayed.</p>
<table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr>
<th width="25%">Constant</th>
<th width="15%">Value</th>
<th width="60%">Description</th>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.Detail</tt></td>
<td align="center" valign="top"><tt>0</tt></td>
<td valign="top">Displays an icon, a name, and details for each item in the directory.</td>
</tr>
<tr>
<td valign="top"><tt>QFileDialog.List</tt></td>
<td align="center" valign="top"><tt>1</tt></td>
<td valign="top">Displays only an icon and a name for each item in the directory.</td>
</tr>
</table>
<br />
<br />
<p>See also <a href="qfiledialog.html#viewMode-prop">setViewMode</a>().</p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QFileDialog" />QFileDialog.__init__ (<i>self</i>, <a href="qwidget.html">QWidget</a> <i>parent</i>, <a href="qt-windowflags.html">Qt.WindowFlags</a> <i>f</i>)</h3><p>The <i>parent</i> argument, if not None, causes <i>self</i> to be owned by Qt instead of PyQt.</p><p>Constructs a file dialog with the given <i>parent</i> and widget <i>flags</i>.</p>
<h3 class="fn"><a name="QFileDialog-2" />QFileDialog.__init__ (<i>self</i>, <a href="qwidget.html">QWidget</a> <i>parent</i> = None, <a href="qstring.html">QString</a> <i>caption</i> = QString(), <a href="qstring.html">QString</a> <i>directory</i> = QString(), <a href="qstring.html">QString</a> <i>filter</i> = QString())</h3><p>The <i>parent</i> argument, if not None, causes <i>self</i> to be owned by Qt instead of PyQt.</p><p>Constructs a file dialog with the given <i>parent</i> and <i>caption</i> that initially displays the contents of the specified <i>directory</i>. The contents of the directory are filtered before being shown in the dialog, using a semicolon-separated list of filters specified by <i>filter</i>.</p>
<h3 class="fn"><a name="accept" />QFileDialog.accept (<i>self</i>)</h3><h3 class="fn"><a name="acceptMode" /><a href="qfiledialog.html#AcceptMode-enum">AcceptMode</a> QFileDialog.acceptMode (<i>self</i>)</h3><h3 class="fn"><a name="confirmOverwrite" />bool QFileDialog.confirmOverwrite (<i>self</i>)</h3><h3 class="fn"><a name="defaultSuffix" /><a href="qstring.html">QString</a> QFileDialog.defaultSuffix (<i>self</i>)</h3><h3 class="fn"><a name="directory" /><a href="qdir.html">QDir</a> QFileDialog.directory (<i>self</i>)</h3><p>Returns the directory currently being displayed in the dialog.</p>
<p>See also <a href="qfiledialog.html#setDirectory">setDirectory</a>().</p>
<h3 class="fn"><a name="done" />QFileDialog.done (<i>self</i>, int <i>result</i>)</h3><h3 class="fn"><a name="fileMode" /><a href="qfiledialog.html#FileMode-enum">FileMode</a> QFileDialog.fileMode (<i>self</i>)</h3><h3 class="fn"><a name="filters" /><a href="qstringlist.html">QStringList</a> QFileDialog.filters (<i>self</i>)</h3><p>Returns the file type filters that are in operation on this file dialog.</p>
<p>See also <a href="qfiledialog.html#setFilters">setFilters</a>().</p>
<h3 class="fn"><a name="getExistingDirectory" /><a href="qstring.html">QString</a> QFileDialog.getExistingDirectory (<a href="qwidget.html">QWidget</a> <i>parent</i> = None, <a href="qstring.html">QString</a> <i>caption</i> = QString(), <a href="qstring.html">QString</a> <i>dir</i> = QString(), <a href="qfiledialog-options.html">Options</a> <i>options</i> = QFileDialog.ShowDirsOnly)</h3><p>This is a convenience static function that will return an existing directory selected by the user.</p>
<pre>
QString s = QFileDialog.getExistingDirectory(
this,
"Choose a directory",
"/home",
QFileDialog.ShowDirsOnly | QFileDialog.DontResolveSymlinks);
</pre>
<p>This function creates a modal file dialog with the given <i>parent</i> widget. If the parent is not 0, the dialog will be shown centered over the parent widget.</p>
<p>The dialog's working directory is set to <i>dir</i>, and the caption is set to <i>caption</i>. Either of these may be an empty string in which case the current directory and a default caption will be used respectively. The <i>options</i> argument holds various options about how to run the dialog, see the <a href="qfiledialog.html#Option-enum">QFileDialog.Option</a> enum for more information on the flags you can pass.</p>
<p>Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if <tt>/usr/tmp</tt> is a symlink to <tt>/var/tmp</tt>, the file dialog will change to <tt>/var/tmp</tt> after entering <tt>/usr/tmp</tt>. If <i>options</i> includes <a href="qfiledialog.html#Option-enum">DontResolveSymlinks</a>, the file dialog will treat symlinks as regular directories.</p>
<p>Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers, and if parent is not 0 then it will position the dialog just under the parent's title bar.</p>
<p>See also <a href="qfiledialog.html#getOpenFileName">getOpenFileName</a>(), <a href="qfiledialog.html#getOpenFileNames">getOpenFileNames</a>(), and <a href="qfiledialog.html#getSaveFileName">getSaveFileName</a>().</p>
<h3 class="fn"><a name="getOpenFileName" /><a href="qstring.html">QString</a> QFileDialog.getOpenFileName (<a href="qwidget.html">QWidget</a> <i>parent</i> = None, <a href="qstring.html">QString</a> <i>caption</i> = QString(), <a href="qstring.html">QString</a> <i>dir</i> = QString(), <a href="qstring.html">QString</a> <i>filter</i> = QString(), <a href="qstring.html">QString</a> <i>selectedFilter</i> = None, <a href="qfiledialog-options.html">Options</a> <i>options</i> = 0)</h3><p>This is a convenience static function that returns an existing file selected by the user. If the user presses Cancel, it returns a null string.</p>
<pre>
QString s = QFileDialog.getOpenFileName(
this,
"Choose a file to open",
"/home",
"Images (*.png *.xpm *.jpg)");
</pre>
<p>The function creates a modal file dialog with the given <i>parent</i> widget. If the parent is not 0, the dialog will be shown centered over the parent widget.</p>
<p>The file dialog's working directory will be set to <i>dir</i>. If <i>dir</i> includes a file name, the file will be selected. Only files that match the given <i>filter</i> are shown. The filter selected is set to <i>selectedFilter</i>. The parameters <i>dir</i>, <i>selectedFilter</i>, and <i>filter</i> may be empty strings. The <i>options</i> argument holds various options about how to run the dialog, see the <a href="qfiledialog.html#Option-enum">QFileDialog.Option</a> enum for more information on the flags you can pass.</p>
<p>The dialog's caption is set to <i>caption</i>. If <i>caption</i> is not specified then a default caption will be used.</p>
<p>Under Windows and Mac OS X, this static function will use the native file dialog and not a <a href="qfiledialog.html">QFileDialog</a>.</p>
<p>Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers, and if parent is not 0 then it will position the dialog just under the parent's title bar.</p>
<p>Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if <tt>/usr/tmp</tt> is a symlink to <tt>/var/tmp</tt>, the file dialog will change to <tt>/var/tmp</tt> after entering <tt>/usr/tmp</tt>. If <i>options</i> includes <a href="qfiledialog.html#Option-enum">DontResolveSymlinks</a>, the file dialog will treat symlinks as regular directories.</p>
<p>See also <a href="qfiledialog.html#getOpenFileNames">getOpenFileNames</a>(), <a href="qfiledialog.html#getSaveFileName">getSaveFileName</a>(), and <a href="qfiledialog.html#getExistingDirectory">getExistingDirectory</a>().</p>
<h3 class="fn"><a name="getOpenFileNames" /><a href="qstringlist.html">QStringList</a> QFileDialog.getOpenFileNames (<a href="qwidget.html">QWidget</a> <i>parent</i> = None, <a href="qstring.html">QString</a> <i>caption</i> = QString(), <a href="qstring.html">QString</a> <i>dir</i> = QString(), <a href="qstring.html">QString</a> <i>filter</i> = QString(), <a href="qstring.html">QString</a> <i>selectedFilter</i> = None, <a href="qfiledialog-options.html">Options</a> <i>options</i> = 0)</h3><p>This is a convenience static function that will return one or more existing files selected by the user.</p>
<pre>
QStringList files = QFileDialog.getOpenFileNames(
this,
"Select one or more files to open",
"/home",
"Images (*.png *.xpm *.jpg)");
</pre>
<p>This function creates a modal file dialog with the given <i>parent</i> widget. If the parent is not 0, the dialog will be shown centered over the parent widget.</p>
<p>The file dialog's working directory will be set to <i>dir</i>. If <i>dir</i> includes a file name, the file will be selected. The filter is set to <i>filter</i> so that only those files which match the filter are shown. The filter selected is set to <i>selectedFilter</i>. The parameters <i>dir</i>, <i>selectedFilter</i> and <i>filter</i> may be empty strings.</p>
<p>The dialog's caption is set to <i>caption</i>. If <i>caption</i> is not specified then a default caption will be used.</p>
<p>Under Windows and Mac OS X, this static function will use the native file dialog and not a <a href="qfiledialog.html">QFileDialog</a>.</p>
<p>Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers, and if parent is not 0 then it will position the dialog just under the parent's title bar.</p>
<p>Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if <tt>/usr/tmp</tt> is a symlink to <tt>/var/tmp</tt>, the file dialog will change to <tt>/var/tmp</tt> after entering <tt>/usr/tmp</tt>. The <i>options</i> argument holds various options about how to run the dialog, see the <a href="qfiledialog.html#Option-enum">QFileDialog.Option</a> enum for more information on the flags you can pass.</p>
<p>Note that if you want to iterate over the list of files, you should iterate over a copy. For example:</p>
<pre>
QStringList list = files;
QStringList.Iterator it = list.begin();
while(it != list.end()) {
myProcessing(*it);
++it;
}
</pre>
<p>See also <a href="qfiledialog.html#getOpenFileName">getOpenFileName</a>(), <a href="qfiledialog.html#getSaveFileName">getSaveFileName</a>(), and <a href="qfiledialog.html#getExistingDirectory">getExistingDirectory</a>().</p>
<h3 class="fn"><a name="getSaveFileName" /><a href="qstring.html">QString</a> QFileDialog.getSaveFileName (<a href="qwidget.html">QWidget</a> <i>parent</i> = None, <a href="qstring.html">QString</a> <i>caption</i> = QString(), <a href="qstring.html">QString</a> <i>dir</i> = QString(), <a href="qstring.html">QString</a> <i>filter</i> = QString(), <a href="qstring.html">QString</a> <i>selectedFilter</i> = None, <a href="qfiledialog-options.html">Options</a> <i>options</i> = 0)</h3><p>This is a convenience static function that will return a file name selected by the user. The file does not have to exist.</p>
<p>It creates a modal file dialog with the given <i>parent</i> widget. If the parent is not 0, the dialog will be shown centered over the parent widget.</p>
<pre>
QString s = QFileDialog.getSaveFileName(
this,
"Choose a filename to save under",
"/home",
"Images (*.png *.xpm *.jpg)");
</pre>
<p>The file dialog's working directory will be set to <i>dir</i>. If <i>dir</i> includes a file name, the file will be selected. Only files that match the <i>filter</i> are shown. The filter selected is set to <i>selectedFilter</i>. The parameters <i>dir</i>, <i>selectedFilter</i>, and <i>filter</i> may be empty strings. The <i>options</i> argument holds various options about how to run the dialog, see the <a href="qfiledialog.html#Option-enum">QFileDialog.Option</a> enum for more information on the flags you can pass.</p>
<p>The dialog's caption is set to <i>caption</i>. If <i>caption</i> is not specified then a default caption will be used.</p>
<p>Under Windows and Mac OS X, this static function will use the native file dialog and not a <a href="qfiledialog.html">QFileDialog</a>.</p>
<p>Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers, and if parent is not 0 then it will position the dialog just under the parent's title bar. On Mac OS X, the filter argument is ignored.</p>
<p>Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if <tt>/usr/tmp</tt> is a symlink to <tt>/var/tmp</tt>, the file dialog will change to <tt>/var/tmp</tt> after entering <tt>/usr/tmp</tt>. If <i>options</i> includes <a href="qfiledialog.html#Option-enum">DontResolveSymlinks</a>, the file dialog will treat symlinks as regular directories.</p>
<p>See also <a href="qfiledialog.html#getOpenFileName">getOpenFileName</a>(), <a href="qfiledialog.html#getOpenFileNames">getOpenFileNames</a>(), and <a href="qfiledialog.html#getExistingDirectory">getExistingDirectory</a>().</p>
<h3 class="fn"><a name="history" /><a href="qstringlist.html">QStringList</a> QFileDialog.history (<i>self</i>)</h3><p>returns the browsing history of the filedialog as a list of paths.</p>
<p>See also <a href="qfiledialog.html#setHistory">setHistory</a>().</p>
<h3 class="fn"><a name="iconProvider" /><a href="qfileiconprovider.html">QFileIconProvider</a> QFileDialog.iconProvider (<i>self</i>)</h3><p>returns the icon provider used by the filedialog.</p>
<p>See also <a href="qfiledialog.html#setIconProvider">setIconProvider</a>().</p>
<h3 class="fn"><a name="isReadOnly" />bool QFileDialog.isReadOnly (<i>self</i>)</h3><h3 class="fn"><a name="itemDelegate" /><a href="qabstractitemdelegate.html">QAbstractItemDelegate</a> QFileDialog.itemDelegate (<i>self</i>)</h3><p>returns the item delegate used to render the items in the views in the filedialog</p>
<p>See also <a href="qfiledialog.html#setItemDelegate">setItemDelegate</a>().</p>
<h3 class="fn"><a name="labelText" /><a href="qstring.html">QString</a> QFileDialog.labelText (<i>self</i>, <a href="qfiledialog.html#DialogLabel-enum">DialogLabel</a> <i>label</i>)</h3><p>returns the text shown in the filedialog in the specified <i>label</i></p>
<p>See also <a href="qfiledialog.html#setLabelText">setLabelText</a>().</p>
<h3 class="fn"><a name="resolveSymlinks" />bool QFileDialog.resolveSymlinks (<i>self</i>)</h3><h3 class="fn"><a name="selectedFiles" /><a href="qstringlist.html">QStringList</a> QFileDialog.selectedFiles (<i>self</i>)</h3><p>Returns a list of strings containing the absolute paths of the selected files in the dialog. If no files are selected, or the mode is not <a href="qfiledialog.html#FileMode-enum">ExistingFiles</a>, selectedFiles() is an empty string list.</p>
<p>See also <a href="qfiledialog.html#selectedFilter">selectedFilter</a>().</p>
<h3 class="fn"><a name="selectedFilter" /><a href="qstring.html">QString</a> QFileDialog.selectedFilter (<i>self</i>)</h3><p>Returns the filter that the user selected in the file dialog.</p>
<p>See also <a href="qfiledialog.html#selectedFiles">selectedFiles</a>().</p>
<h3 class="fn"><a name="selectFile" />QFileDialog.selectFile (<i>self</i>, <a href="qstring.html">QString</a> <i>filename</i>)</h3><p>Selects the given <i>filename</i> in both the file dialog.</p>
<h3 class="fn"><a name="selectFilter" />QFileDialog.selectFilter (<i>self</i>, <a href="qstring.html">QString</a> <i>filter</i>)</h3><p>Sets the current file type <i>filter</i>. Multiple filters can be passed in <i>filter</i> by separating them with semicolons or spaces.</p>
<p>See also <a href="qfiledialog.html#setFilter">setFilter</a>() and <a href="qfiledialog.html#setFilters">setFilters</a>().</p>
<h3 class="fn"><a name="setAcceptMode" />QFileDialog.setAcceptMode (<i>self</i>, <a href="qfiledialog.html#AcceptMode-enum">AcceptMode</a> <i>mode</i>)</h3><h3 class="fn"><a name="setConfirmOverwrite" />QFileDialog.setConfirmOverwrite (<i>self</i>, bool <i>enabled</i>)</h3><h3 class="fn"><a name="setDefaultSuffix" />QFileDialog.setDefaultSuffix (<i>self</i>, <a href="qstring.html">QString</a> <i>suffix</i>)</h3><h3 class="fn"><a name="setDirectory" />QFileDialog.setDirectory (<i>self</i>, <a href="qstring.html">QString</a> <i>directory</i>)</h3><p>Sets the file dialog's current <i>directory</i>.</p>
<p>See also <a href="qfiledialog.html#directory">directory</a>().</p>
<h3 class="fn"><a name="setDirectory-2" />QFileDialog.setDirectory (<i>self</i>, <a href="qdir.html">QDir</a> <i>adirectory</i>)</h3><p>This is an overloaded member function, provided for convenience.</p>
<h3 class="fn"><a name="setFileMode" />QFileDialog.setFileMode (<i>self</i>, <a href="qfiledialog.html#FileMode-enum">FileMode</a> <i>mode</i>)</h3><h3 class="fn"><a name="setFilter" />QFileDialog.setFilter (<i>self</i>, <a href="qstring.html">QString</a> <i>filter</i>)</h3><p>Sets the filter used in the file dialog to the given <i>filter</i>.</p>
<p>If <i>filter</i> contains a pair of parentheses containing one or more of <b>anything*something</b>, separated by spaces or by semicolons then only the text contained in the parentheses is used as the filter. This means that these calls are all equivalent:</p>
<pre>
fd->setFilter("All C++ files (*.cpp *.cc *.C *.cxx *.c++)");
fd->setFilter("*.cpp *.cc *.C *.cxx *.c++");
fd->setFilter("All C++ files (*.cpp;*.cc;*.C;*.cxx;*.c++)");
fd->setFilter("*.cpp;*.cc;*.C;*.cxx;*.c++");
</pre>
<p>See also <a href="qfiledialog.html#setFilters">setFilters</a>().</p>
<h3 class="fn"><a name="setFilters" />QFileDialog.setFilters (<i>self</i>, <a href="qstringlist.html">QStringList</a> <i>filters</i>)</h3><p>Sets the <i>filters</i> used in the file dialog.</p>
<pre>
QStringList types;
types << "Image files (*.png *.xpm *.jpg)"
<< "Text files (*.txt)"
<< "Any files (*)";
QFileDialog fd = new QFileDialog( this );
fd->setFilters( types );
fd->show();
</pre>
<p>See also <a href="qfiledialog.html#filters">filters</a>().</p>
<h3 class="fn"><a name="setHistory" />QFileDialog.setHistory (<i>self</i>, <a href="qstringlist.html">QStringList</a> <i>paths</i>)</h3><p>Sets the browsing history of the filedialog to contain the given <i>paths</i>.</p>
<p>See also <a href="qfiledialog.html#history">history</a>().</p>
<h3 class="fn"><a name="setIconProvider" />QFileDialog.setIconProvider (<i>self</i>, <a href="qfileiconprovider.html">QFileIconProvider</a> <i>provider</i>)</h3><p>set the icon provider used by the filedialog to the specified <i>provider</i></p>
<p>See also <a href="qfiledialog.html#iconProvider">iconProvider</a>().</p>
<h3 class="fn"><a name="setItemDelegate" />QFileDialog.setItemDelegate (<i>self</i>, <a href="qabstractitemdelegate.html">QAbstractItemDelegate</a> <i>delegate</i>)</h3><p>set the item delegate used to render the items in the views in the filedialog to the specified <i>delegate</i></p>
<p>See also <a href="qfiledialog.html#itemDelegate">itemDelegate</a>().</p>
<h3 class="fn"><a name="setLabelText" />QFileDialog.setLabelText (<i>self</i>, <a href="qfiledialog.html#DialogLabel-enum">DialogLabel</a> <i>label</i>, <a href="qstring.html">QString</a> <i>text</i>)</h3><p>set the <i>text</i> shown in the filedialog in the specified <i>label</i></p>
<p>See also <a href="qfiledialog.html#labelText">labelText</a>().</p>
<h3 class="fn"><a name="setReadOnly" />QFileDialog.setReadOnly (<i>self</i>, bool <i>enabled</i>)</h3><h3 class="fn"><a name="setResolveSymlinks" />QFileDialog.setResolveSymlinks (<i>self</i>, bool <i>enabled</i>)</h3><h3 class="fn"><a name="setViewMode" />QFileDialog.setViewMode (<i>self</i>, <a href="qfiledialog.html#ViewMode-enum">ViewMode</a> <i>mode</i>)</h3><h3 class="fn"><a name="viewMode" /><a href="qfiledialog.html#ViewMode-enum">ViewMode</a> QFileDialog.viewMode (<i>self</i>)</h3><hr /><h2>Qt Signal Documentation</h2><h3 class="fn"><a name="currentChanged" />void currentChanged (const QString&)</h3><p>When the current file changes, this signal is emitted with the new file name as the <i>path</i> parameter.</p>
<p>See also <a href="qfiledialog.html#filesSelected">filesSelected</a>().</p>
<h3 class="fn"><a name="filesSelected" />void filesSelected (const QStringList&)</h3><p>When the selection changes, this signal is emitted with the (possibly empty) list of <i>selected</i> files.</p>
<p>See also <a href="qfiledialog.html#currentChanged">currentChanged</a>().</p>
<address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td width="25%">PyQt 4.0.1 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.trolltech.com">Trolltech AS</a> 2006</td><td align="right" width="25%">Qt 4.1.4</td></tr></table></div></address></body></html>
|