mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 19:02:51 +00:00
1356 lines
50 KiB
HTML
1356 lines
50 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
|
|
|
<head>
|
|
<title>KFileWidget</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta http-equiv="Content-Style-Type" content="text/css" />
|
|
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
|
|
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
|
|
</head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="header">
|
|
<div id="header_top">
|
|
<div>
|
|
<div>
|
|
<img alt ="" src="../common/top-kde.jpg"/>
|
|
KDE 4.9 PyKDE API Reference
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="header_bottom">
|
|
<div id="location">
|
|
<ul>
|
|
<li>KDE's Python API</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="menu">
|
|
<ul>
|
|
<li><a href="../modules.html">Overview</a></li>
|
|
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
|
|
<li><a href="http://kde.org/family/">Sitemap</a></li>
|
|
<li><a href="http://kde.org/contact/">Contact Us</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="body_wrapper">
|
|
<div id="body">
|
|
<div id="right">
|
|
<div class="content">
|
|
<div id="main">
|
|
<div class="clearer"> </div>
|
|
|
|
<h1>KFileWidget Class Reference</h1>
|
|
<code>from PyKDE4.kio import *</code>
|
|
<p>
|
|
Inherits: QWidget → QObject,<a href="../kio/KAbstractFileWidget.html">KAbstractFileWidget</a><br />
|
|
|
|
|
|
<h2>Detailed Description</h2>
|
|
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#accepted">accepted</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fileHighlighted">fileHighlighted</a> (QString a0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fileHighlighted">fileHighlighted</a> (<a href="../kdecore/KUrl.html">KUrl</a> a0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fileSelected">fileSelected</a> (QString a0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fileSelected">fileSelected</a> (<a href="../kdecore/KUrl.html">KUrl</a> a0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#filterChanged">filterChanged</a> (QString filter)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectionChanged">selectionChanged</a> ()</td></tr>
|
|
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KFileWidget">__init__</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> startDir, QWidget parent)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#accept">accept</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KActionCollection.html">KActionCollection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#actionCollection">actionCollection</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#baseUrl">baseUrl</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KPushButton.html">KPushButton</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#cancelButton">cancelButton</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearFilter">clearFilter</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentFilter">currentFilter</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<KMimeType> </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentFilterMimeType">currentFilterMimeType</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentMimeFilter">currentMimeFilter</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KDirOperator.html">KDirOperator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dirOperator">dirOperator</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#eventFilter">eventFilter</a> (self, QObject watched, QEvent event)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KFileFilterCombo.html">KFileFilterCombo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#filterWidget">filterWidget</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#keepsLocation">keepsLocation</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KUrlComboBox.html">KUrlComboBox</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#locationEdit">locationEdit</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KFile.html">KFile.Modes</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mode">mode</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KPushButton.html">KPushButton</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#okButton">okButton</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KAbstractFileWidget.html#OperationMode">KAbstractFileWidget.OperationMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#operationMode">operationMode</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#readConfig">readConfig</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> group)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resizeEvent">resizeEvent</a> (self, QResizeEvent event)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedFile">selectedFile</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedFiles">selectedFiles</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedUrl">selectedUrl</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.List.html">KUrl.List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedUrls">selectedUrls</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCustomWidget">setCustomWidget</a> (self, QWidget widget)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCustomWidget">setCustomWidget</a> (self, QString text, QWidget widget)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFilter">setFilter</a> (self, QString filter)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setKeepLocation">setKeepLocation</a> (self, bool keep)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setLocationLabel">setLocationLabel</a> (self, QString text)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMimeFilter">setMimeFilter</a> (self, QStringList types, QString defaultType=QString())</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMode">setMode</a> (self, <a href="../kio/KFile.html">KFile.Modes</a> m)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setOperationMode">setOperationMode</a> (self, <a href="../kio/KAbstractFileWidget.html#OperationMode">KAbstractFileWidget.OperationMode</a> a0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPreviewWidget">setPreviewWidget</a> (self, <a href="../kio/KPreviewWidgetBase.html">KPreviewWidgetBase</a> w)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSelection">setSelection</a> (self, QString name)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setUrl">setUrl</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, bool clearforward=1)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#showEvent">showEvent</a> (self, QShowEvent event)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotCancel">slotCancel</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotOk">slotOk</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KToolBar.html">KToolBar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#toolBar">toolBar</a> (self)</td></tr>
|
|
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#getStartUrl">getStartUrl</a> (<a href="../kdecore/KUrl.html">KUrl</a> startDir, QString recentDirClass)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#getStartUrl">getStartUrl</a> (<a href="../kdecore/KUrl.html">KUrl</a> startDir, QString recentDirClass, QString fileName)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setStartDir">setStartDir</a> (<a href="../kdecore/KUrl.html">KUrl</a> directory)</td></tr>
|
|
</table>
|
|
<hr><h2>Signal Documentation</h2><a class="anchor" name="accepted"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> accepted</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted by slotOk() (directly or asynchronously) once everything has
|
|
been done. Should be used by the caller to call accept().
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("accepted()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="fileHighlighted"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> fileHighlighted</td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>a0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>@deprecated, connect to fileSelected(const KUrl&) instead
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("fileHighlighted(const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="fileHighlighted"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> fileHighlighted</td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
|
|
<td class="paramname"><em>a0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>@deprecated, connect to fileSelected(const KUrl&) instead
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("fileHighlighted(const KUrl&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="fileSelected"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> fileSelected</td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>a0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>@deprecated, connect to fileSelected(const KUrl&) instead
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("fileSelected(const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="fileSelected"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> fileSelected</td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
|
|
<td class="paramname"><em>a0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>@deprecated, connect to fileSelected(const KUrl&) instead
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("fileSelected(const KUrl&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="filterChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> filterChanged</td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>filter</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted when the filter changed, i.e. the user entered an own filter
|
|
or chose one of the predefined set via setFilter().
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>filter</em> </td><td> contains the new filter (only the extension part,
|
|
not the explanation), i.e. "*.cpp" or "*.cpp *.cc".
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> setFilter()
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> currentFilter()
|
|
</dd></dl>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("filterChanged(const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="selectionChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> selectionChanged</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted when the user hilights one or more files in multiselection mode.
|
|
</p>
|
|
<p>
|
|
Note: fileHighlighted() or fileSelected() are <b>not</b>
|
|
emitted in multiselection mode. You may use selectedItems() to
|
|
ask for the current highlighted items.
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> fileSelected
|
|
</dd></dl>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("selectionChanged()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KFileWidget"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">__init__</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
|
|
<td class="paramname"><em>startDir</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>parent</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Constructs a file selector widget.
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>startDir</em> </td><td> This can either be:
|
|
</td></tr> </table></dl>
|
|
<p> <li> An empty URL (KUrl()) to start in the current working directory, </li>
|
|
or the last directory where a file has been selected.
|
|
<li> The path or URL of a starting directory. </li>
|
|
<li> An initial file name to select, with the starting directory being </li>
|
|
the current working directory or the last directory where a file
|
|
has been selected.
|
|
<li> The path or URL of a file, specifying both the starting directory and </li>
|
|
an initially selected file name.
|
|
<li> A URL of the form kfiledialog:&lt;keyword&gt; to start in the </li>
|
|
directory last used by a filedialog in the same application that
|
|
specified the same keyword.
|
|
<li> A URL of the form kfiledialog:&lt;keyword&gt;/&lt;filename&gt; </li>
|
|
to start in the directory last used by a filedialog in the same
|
|
application that specified the same keyword, and to initially
|
|
select the specified filename.
|
|
<li> A URL of the form kfiledialog:&lt;keyword&gt;?global to start </li>
|
|
in the directory last used by a filedialog in any application that
|
|
specified the same keyword.
|
|
<li> A URL of the form kfiledialog:&lt;keyword&gt;/&lt;filename&gt;?global </li>
|
|
to start in the directory last used by a filedialog in any
|
|
application that specified the same keyword, and to initially
|
|
select the specified filename.
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>parent</em> </td><td> The parent widget of this widget
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="accept"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> accept</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"></div></div><a class="anchor" name="actionCollection"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KActionCollection.html">KActionCollection</a> actionCollection</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the action collection, holding all the used
|
|
KActions.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="baseUrl"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> baseUrl</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the currently shown directory.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="cancelButton"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KPushButton.html">KPushButton</a> cancelButton</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the Cancel-Button in the filedialog.
|
|
Note that the button is hidden and unconnected when using KFileWidget alone;
|
|
KFileDialog shows it and connects to it.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="clearFilter"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> clearFilter</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Clears any mime- or namefilter. Does not reload the directory.
|
|
</p></div></div><a class="anchor" name="currentFilter"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString currentFilter</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns the current filter as entered by the user or one of the
|
|
predefined set via setFilter().
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setFilter()
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> filterChanged()
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="currentFilterMimeType"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">KSharedPtr<KMimeType> currentFilterMimeType</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns the mimetype for the desired output format.
|
|
</p>
|
|
<p>
|
|
This is only valid if setFilterMimeType() has been called
|
|
previously.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setFilterMimeType()
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="currentMimeFilter"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString currentMimeFilter</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>The mimetype for the desired output format.
|
|
</p>
|
|
<p>
|
|
This is only valid if setMimeFilter() has been called
|
|
previously.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setMimeFilter()
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="dirOperator"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kio/KDirOperator.html">KDirOperator</a> dirOperator</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the KDirOperator used to navigate the filesystem
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="eventFilter"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool eventFilter</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QObject </td>
|
|
<td class="paramname"><em>watched</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QEvent </td>
|
|
<td class="paramname"><em>event</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"></div></div><a class="anchor" name="filterWidget"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kio/KFileFilterCombo.html">KFileFilterCombo</a> filterWidget</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the combobox that contains the filters
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="keepsLocation"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool keepsLocation</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> whether the contents of the location edit are kept when
|
|
changing directories.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="locationEdit"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kio/KUrlComboBox.html">KUrlComboBox</a> locationEdit</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the combobox used to type the filename or full location of the file.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="mode"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kio/KFile.html">KFile.Modes</a> mode</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns the mode of the filedialog.
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setMode()
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="okButton"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KPushButton.html">KPushButton</a> okButton</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the OK-Button in the filedialog.
|
|
Note that the button is hidden and unconnected when using KFileWidget alone;
|
|
KFileDialog shows it and connects to it.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="operationMode"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kio/KAbstractFileWidget.html#OperationMode">KAbstractFileWidget.OperationMode</a> operationMode</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the current operation mode, Opening, Saving or Other. Default
|
|
is Other.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> operationMode
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KFileWidget.OperationMode
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="readConfig"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> readConfig</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
|
|
<td class="paramname"><em>group</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>reads the configuration for this widget from the given config group
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>group</em> </td><td> the KConfigGroup to read from
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="resizeEvent"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> resizeEvent</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QResizeEvent </td>
|
|
<td class="paramname"><em>event</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"></div></div><a class="anchor" name="selectedFile"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString selectedFile</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns the full path of the selected file in the local filesystem.
|
|
(Local files only)
|
|
</p></div></div><a class="anchor" name="selectedFiles"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QStringList selectedFiles</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns a list of all selected local files.
|
|
</p></div></div><a class="anchor" name="selectedUrl"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> selectedUrl</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> The selected fully qualified filename.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="selectedUrls"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdecore/KUrl.List.html">KUrl.List</a> selectedUrls</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> The list of selected URLs.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setCustomWidget"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setCustomWidget</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets a custom widget that should be added below the location and the filter
|
|
editors.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>text</em> </td><td> Label of the custom widget, which is displayed below the labels
|
|
"Location:" and "Filter:".
|
|
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> Any kind of widget, but preferable a combo box or a line editor
|
|
to be compliant with the location and filter layout.
|
|
When creating this widget, you don't need to specify a parent,
|
|
since the widget's parent will be set automatically by KFileWidget.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setCustomWidget"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setCustomWidget</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>text</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets a custom widget that should be added below the location and the filter
|
|
editors.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>text</em> </td><td> Label of the custom widget, which is displayed below the labels
|
|
"Location:" and "Filter:".
|
|
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> Any kind of widget, but preferable a combo box or a line editor
|
|
to be compliant with the location and filter layout.
|
|
When creating this widget, you don't need to specify a parent,
|
|
since the widget's parent will be set automatically by KFileWidget.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setFilter"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setFilter</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>filter</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets the filter to be used to <b>filter.</b>
|
|
</p>
|
|
<p>
|
|
You can set more
|
|
filters for the user to select separated by '\n'. Every
|
|
filter entry is defined through namefilter|text to display.
|
|
If no | is found in the expression, just the namefilter is
|
|
shown. Examples:
|
|
</p>
|
|
<p>
|
|
<pre class="fragment">
|
|
kfile->setFilter("*.cpp|C++ Source Files\n*.h|Header files");
|
|
kfile->setFilter("*.cpp");
|
|
kfile->setFilter("*.cpp|Sources (*.cpp)");
|
|
kfile->setFilter("*.cpp|" + i18n("Sources (*.cpp)"));
|
|
kfile->setFilter("*.cpp *.cc *.C|C++ Source Files\n*.h *.H|Header files");
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
Note: The text to display is not parsed in any way. So, if you
|
|
want to show the suffix to select by a specific filter, you must
|
|
repeat it.
|
|
</p>
|
|
<p>
|
|
If the filter contains an unescaped '/', a mimetype-filter is assumed.
|
|
If you would like a '/' visible in your filter it can be escaped with
|
|
a '\'. You can specify multiple mimetypes like this (separated with
|
|
space):
|
|
</p>
|
|
<p>
|
|
<pre class="fragment">
|
|
kfile->setFilter( "image/png text/html text/plain" );
|
|
kfile->setFilter( "*.cue|CUE\\/BIN Files (*.cue)" );
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> filterChanged
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setMimeFilter
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setKeepLocation"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setKeepLocation</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>keep</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets whether the filename/url should be kept when changing directories.
|
|
This is for example useful when having a predefined filename where
|
|
the full path for that file is searched.
|
|
</p>
|
|
<p>
|
|
This is implicitly set when operationMode() is KFileWidget.Saving
|
|
</p>
|
|
<p>
|
|
getSaveFileName() and getSaveUrl() set this to true by default, so that
|
|
you can type in the filename and change the directory without having
|
|
to type the name again.
|
|
</p></div></div><a class="anchor" name="setLocationLabel"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setLocationLabel</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>text</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets the text to be displayed in front of the selection.
|
|
</p>
|
|
<p>
|
|
The default is "Location".
|
|
Most useful if you want to make clear what
|
|
the location is used for.
|
|
</p></div></div><a class="anchor" name="setMimeFilter"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setMimeFilter</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QStringList </td>
|
|
<td class="paramname"><em>types</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>defaultType=QString()</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets the filter up to specify the output type.
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>types</em> </td><td> a list of mimetypes that can be used as output format
|
|
|
|
<tr><td></td><td valign="top"><em>defaultType</em> </td><td> the default mimetype to use as output format, if any.
|
|
If <b>defaultType</b> is set, it will be set as the current item.
|
|
Otherwise, a first item showing all the mimetypes will be created.
|
|
Typically, <b>defaultType</b> should be empty for loading and set for saving.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> Do not use in conjunction with setFilter()
|
|
</p></div></div><a class="anchor" name="setMode"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setMode</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kio/KFile.html">KFile.Modes</a> </td>
|
|
<td class="paramname"><em>m</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets the mode of the dialog.
|
|
</p>
|
|
<p>
|
|
The mode is defined as (in kfile.h):
|
|
<pre class="fragment">
|
|
enum Mode {
|
|
File = 1,
|
|
Directory = 2,
|
|
Files = 4,
|
|
ExistingOnly = 8,
|
|
LocalOnly = 16
|
|
};
|
|
</pre>
|
|
You can OR the values, e.g.
|
|
<pre class="fragment">
|
|
KFile.Modes mode = KFile.Files |
|
|
KFile.ExistingOnly |
|
|
KFile.LocalOnly );
|
|
setMode( mode );
|
|
</pre>
|
|
</p></div></div><a class="anchor" name="setOperationMode"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setOperationMode</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kio/KAbstractFileWidget.html#OperationMode">KAbstractFileWidget.OperationMode</a> </td>
|
|
<td class="paramname"><em>a0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets the operational mode of the filedialog to <b>Saving,</b> <b>Opening</b>
|
|
or <b>Other.</b> This will set some flags that are specific to loading
|
|
or saving files. E.g. setKeepLocation() makes mostly sense for
|
|
a save-as dialog. So setOperationMode( KFileWidget.Saving ); sets
|
|
setKeepLocation for example.
|
|
</p>
|
|
<p>
|
|
The mode <b>Saving,</b> together with a default filter set via
|
|
setMimeFilter() will make the filter combobox read-only.
|
|
</p>
|
|
<p>
|
|
The default mode is <b>Opening.</b>
|
|
</p>
|
|
<p>
|
|
Call this method right after instantiating KFileWidget.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> operationMode
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KFileWidget.OperationMode
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setPreviewWidget"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setPreviewWidget</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kio/KPreviewWidgetBase.html">KPreviewWidgetBase</a> </td>
|
|
<td class="paramname"><em>w</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Adds a preview widget and enters the preview mode.
|
|
</p>
|
|
<p>
|
|
In this mode the dialog is split and the right part contains your
|
|
preview widget.
|
|
</p>
|
|
<p>
|
|
Ownership is transferred to KFileWidget. You need to create the
|
|
preview-widget with "new", i.e. on the heap.
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>w</em> </td><td> The widget to be used for the preview.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setSelection"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setSelection</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>name</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets the file name to preselect to <b>name</b>
|
|
</p>
|
|
<p>
|
|
This takes absolute URLs and relative file names.
|
|
</p></div></div><a class="anchor" name="setUrl"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setUrl</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
|
|
<td class="paramname"><em>url</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>clearforward=1</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets the directory to view.
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>url</em> </td><td> URL to show.
|
|
|
|
<tr><td></td><td valign="top"><em>clearforward</em> </td><td> Indicates whether the forward queue
|
|
should be cleared.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="showEvent"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> showEvent</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QShowEvent </td>
|
|
<td class="paramname"><em>event</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"></div></div><a class="anchor" name="slotCancel"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> slotCancel</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"></div></div><a class="anchor" name="slotOk"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> slotOk</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Called when clicking ok (when this widget is used in KFileDialog)
|
|
Might or might not call accept().
|
|
</p></div></div><a class="anchor" name="toolBar"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KToolBar.html">KToolBar</a> toolBar</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns a pointer to the toolbar.
|
|
</p>
|
|
<p>
|
|
You can use this to insert custom
|
|
items into it, e.g.:
|
|
<pre class="fragment">
|
|
yourAction = new KAction( i18n("Your Action"), 0,
|
|
this, SLOT( yourSlot() ),
|
|
this, "action name" );
|
|
yourAction->plug( kfileDialog->toolBar() );
|
|
</pre>
|
|
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="getStartUrl"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> getStartUrl</td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
|
|
<td class="paramname"><em>startDir</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>recentDirClass</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Similar to getStartUrl(const KUrl& startDir,QString& recentDirClass),
|
|
but allows both the recent start directory keyword and a suggested file name
|
|
to be returned.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>startDir</em> </td><td> A URL specifying the initial directory and/or filename,
|
|
or using the kfiledialog: syntax to specify a
|
|
last used location.
|
|
Refer to the KFileWidget.KFileWidget()
|
|
documentation for the kfiledialog: URL syntax.
|
|
|
|
<tr><td></td><td valign="top"><em>recentDirClass</em> </td><td> If the kfiledialog: syntax is used, this
|
|
will return the string to be passed to KRecentDirs.dir() and
|
|
KRecentDirs.add().
|
|
|
|
<tr><td></td><td valign="top"><em>fileName</em> </td><td> The suggested file name, if specified as part of the
|
|
<b>StartDir</b> URL.
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The URL that should be listed by default (e.g. by KFileDialog or
|
|
KDirSelectDialog).
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> KFileWidget.KFileWidget()
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="getStartUrl"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> getStartUrl</td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
|
|
<td class="paramname"><em>startDir</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>recentDirClass</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>fileName</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Similar to getStartUrl(const KUrl& startDir,QString& recentDirClass),
|
|
but allows both the recent start directory keyword and a suggested file name
|
|
to be returned.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>startDir</em> </td><td> A URL specifying the initial directory and/or filename,
|
|
or using the kfiledialog: syntax to specify a
|
|
last used location.
|
|
Refer to the KFileWidget.KFileWidget()
|
|
documentation for the kfiledialog: URL syntax.
|
|
|
|
<tr><td></td><td valign="top"><em>recentDirClass</em> </td><td> If the kfiledialog: syntax is used, this
|
|
will return the string to be passed to KRecentDirs.dir() and
|
|
KRecentDirs.add().
|
|
|
|
<tr><td></td><td valign="top"><em>fileName</em> </td><td> The suggested file name, if specified as part of the
|
|
<b>StartDir</b> URL.
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The URL that should be listed by default (e.g. by KFileDialog or
|
|
KDirSelectDialog).
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> KFileWidget.KFileWidget()
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setStartDir"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setStartDir</td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
|
|
<td class="paramname"><em>directory</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
|
|
Used by KDirSelectDialog to share the dialog's start directory.
|
|
</dd></dl>
|
|
</p></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="left">
|
|
|
|
<div class="menu_box">
|
|
<div class="nav_list">
|
|
<ul>
|
|
<li><a href="../allclasses.html">Full Index</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<a name="cp-menu" /><div class="menutitle"><div>
|
|
<h2 id="cp-menu-project">Modules</h2>
|
|
</div></div>
|
|
<div class="nav_list">
|
|
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
|
|
<li><a href="../dnssd/index.html">dnssd</a></li>
|
|
<li><a href="../kdecore/index.html">kdecore</a></li>
|
|
<li><a href="../kdeui/index.html">kdeui</a></li>
|
|
<li><a href="../khtml/index.html">khtml</a></li>
|
|
<li><a href="../kio/index.html">kio</a></li>
|
|
<li><a href="../knewstuff/index.html">knewstuff</a></li>
|
|
<li><a href="../kparts/index.html">kparts</a></li>
|
|
<li><a href="../kutils/index.html">kutils</a></li>
|
|
<li><a href="../nepomuk/index.html">nepomuk</a></li>
|
|
<li><a href="../phonon/index.html">phonon</a></li>
|
|
<li><a href="../plasma/index.html">plasma</a></li>
|
|
<li><a href="../polkitqt/index.html">polkitqt</a></li>
|
|
<li><a href="../solid/index.html">solid</a></li>
|
|
<li><a href="../soprano/index.html">soprano</a></li>
|
|
</ul></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="clearer"/>
|
|
</div>
|
|
|
|
<div id="end_body"></div>
|
|
</div>
|
|
<div id="footer"><div id="footer_text">
|
|
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
|
|
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
|
|
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
|
|
</div></div>
|
|
</body>
|
|
</html>
|