KFileDialog Class Reference
Provides a user (and developer) friendly way to select files and directories. A file selection dialog. More...
#include <kfiledialog.h>
Inheritance diagram for KFileDialog:


Public Types | |
| enum | OperationMode { Other = 0, Opening, Saving } |
Signals | |
| void | fileSelected (const QString &) |
| void | fileHighlighted (const QString &) |
| void | selectionChanged () |
| void | filterChanged (const QString &filter) |
Public Member Functions | |
| KFileDialog (const QString &startDir, const QString &filter, QWidget *parent, const char *name, bool modal) | |
| KFileDialog (const QString &startDir, const QString &filter, QWidget *parent, const char *name, bool modal, QWidget *widget) | |
| ~KFileDialog () | |
| KURL | selectedURL () const |
| KURL::List | selectedURLs () const |
| KURL | baseURL () const |
| QString | selectedFile () const |
| QStringList | selectedFiles () const |
| void | setURL (const KURL &url, bool clearforward=true) |
| void | setSelection (const QString &name) |
| void | setOperationMode (KFileDialog::OperationMode) |
| OperationMode | operationMode () const |
| void | setKeepLocation (bool keep) |
| bool | keepsLocation () const |
| void | setFilter (const QString &filter) |
| QString | currentFilter () const |
| void | setFilterMimeType (const QString &label, const KMimeType::List &types, const KMimeType::Ptr &defaultType) KDE_DEPRECATED |
| KMimeType::Ptr | currentFilterMimeType () |
| void | setMimeFilter (const QStringList &types, const QString &defaultType=QString::null) |
| QString | currentMimeFilter () const |
| void | clearFilter () |
| void | setPreviewWidget (const QWidget *w) KDE_DEPRECATED |
| void | setPreviewWidget (const KPreviewWidgetBase *w) |
| virtual void | show () |
| void | setMode (KFile::Mode m) |
| void | setMode (unsigned int m) |
| KFile::Mode | mode () const |
| void | setLocationLabel (const QString &text) |
| KToolBar * | toolBar () const |
| KPushButton * | okButton () const |
| KPushButton * | cancelButton () const |
| KURLBar * | speedBar () |
| KActionCollection * | actionCollection () const |
| int | pathComboIndex () |
Static Public Member Functions | |
| QString | getOpenFileName (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| QStringList | getOpenFileNames (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| KURL | getOpenURL (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| KURL::List | getOpenURLs (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| QString | getSaveFileName (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| KURL | getSaveURL (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| QString | getExistingDirectory (const QString &startDir=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| KURL | getExistingURL (const QString &startDir=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| KURL | getImageOpenURL (const QString &startDir=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
| KURL | getStartURL (const QString &startDir, QString &recentDirClass) |
| void | setStartDir (const KURL &directory) |
Protected Slots | |
| void | urlEntered (const KURL &) |
| void | enterURL (const KURL &url) |
| void | enterURL (const QString &url) |
| void | locationActivated (const QString &url) |
| void | toolbarCallback (int) |
| void | pathComboChanged (const QString &) |
| void | dirCompletion (const QString &) |
| void | slotFilterChanged () |
| void | fileHighlighted (const KFileItem *i) |
| void | fileSelected (const KFileItem *i) |
| void | slotStatResult (KIO::Job *job) |
| void | slotLoadingFinished () |
| void | fileCompletion (const QString &) |
| void | toggleSpeedbar (bool) |
| virtual void | updateStatusLine (int dirs, int files) |
| virtual void | slotOk () |
| virtual void | accept () |
| virtual void | slotCancel () |
| void | slotAutoSelectExtClicked () |
| void | addToRecentDocuments () |
| void | initSpeedbar () |
Protected Member Functions | |
| virtual void | keyPressEvent (QKeyEvent *e) |
| void | init (const QString &startDir, const QString &filter, QWidget *widget) |
| virtual void | initGUI () |
| void | multiSelectionChanged () |
| virtual void | readConfig (KConfig *, const QString &group=QString::null) |
| virtual void | writeConfig (KConfig *, const QString &group=QString::null) |
| virtual void | readRecentFiles (KConfig *) |
| virtual void | saveRecentFiles (KConfig *) |
| KURL::List | tokenize (const QString &line) const |
| KURL | getCompleteURL (const QString &) |
| QString | currentFilterExtension () |
| void | updateAutoSelectExtension () |
| KURL::List & | parseSelectedURLs () const |
| virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
| KToolBar * | toolbar |
| KURLComboBox * | locationEdit |
| KFileFilterCombo * | filterWidget |
| KDirOperator * | ops |
| bool | autoDirectoryFollowing |
Static Protected Attributes | |
| KURL * | lastDirectory |
Detailed Description
Provides a user (and developer) friendly way to select files and directories. A file selection dialog.The widget can be used as a drop in replacement for the QFileDialog widget, but has greater functionality and a nicer GUI.
You will usually want to use one of the static methods getOpenFileName(), getSaveFileName(), getOpenURL() or for multiple files getOpenFileNames() or getOpenURLs().
The dialog has been designed to allow applications to customise it by subclassing. It uses geometry management to ensure that subclasses can easily add children that will be incorporated into the layout.
KDE File Dialog
- Author:
- Richard J. Moore <rich@kde.org>, Carsten Pfeiffer <pfeiffer@kde.org>
Definition at line 78 of file kfiledialog.h.
Member Enumeration Documentation
|
|
Defines some default behavior of the filedialog.
E.g. in mode
Definition at line 95 of file kfiledialog.h. Referenced by operationMode(). |
Constructor & Destructor Documentation
|
||||||||||||||||||||||||
|
Constructs a file dialog.
Definition at line 165 of file kfiledialog.cpp. References init(). |
|
||||||||||||||||||||||||||||
|
Constructs a file dialog. The parameters here are identical to the first constructor except for the addition of a QWidget parameter. Historical note: The original version of KFileDialog did not have this extra parameter. It was added later, and, in order to maintain binary compatibility, it was placed in a new constructor instead of added to the original one.
Definition at line 172 of file kfiledialog.cpp. References init(). |
|
|
Destructs the file dialog.
Definition at line 180 of file kfiledialog.cpp. References KGlobal::config(), and KConfigBase::sync(). |
Member Function Documentation
|
|
Definition at line 1399 of file kfiledialog.cpp. References QDialog::result(). Referenced by getImageOpenURL(), getOpenURL(), KEncodingFileDialog::getOpenURLAndEncoding(), getSaveURL(), KEncodingFileDialog::getSaveURLAndEncoding(), and KURLRequester::slotOpenDialog(). |
|
|
Definition at line 1407 of file kfiledialog.cpp. References QValueList< KURL >::append(), KDirOperator::mode(), and QDialog::result(). Referenced by getOpenURLs(), and KEncodingFileDialog::getOpenURLsAndEncoding(). |
|
|
Definition at line 1534 of file kfiledialog.cpp. References KDirOperator::url(). |
|
|
Returns the full path of the selected file in the local filesystem. (Local files only) Definition at line 1500 of file kfiledialog.cpp. References QDialog::result(). Referenced by getOpenFileName(), KEncodingFileDialog::getOpenFileNameAndEncoding(), getSaveFileName(), and KEncodingFileDialog::getSaveFileNameAndEncoding(). |
|
|
Returns a list of all selected local files.
Definition at line 1510 of file kfiledialog.cpp. References QValueList< KURL >::begin(), QValueList< KURL >::end(), KDirOperator::mode(), and QDialog::result(). Referenced by getOpenFileNames(), and KEncodingFileDialog::getOpenFileNamesAndEncoding(). |
|
||||||||||||
|
Sets the directory to view.
Definition at line 1149 of file kfiledialog.cpp. References KDirOperator::setURL(). Referenced by setSelection(). |
|
|
Sets the file name to preselect to This takes absolute URLs and relative file names. Definition at line 1210 of file kfiledialog.cpp. References QFile::exists(), KURL::fileName(), QString::findRev(), getCompleteURL(), KFileItem::isDir(), QString::isEmpty(), KURL::isLocalFile(), KURL::isValid(), kdDebug(), kdWarning(), QString::left(), QComboBox::lineEdit(), KURL::path(), setURL(), KProtocolInfo::supportsListing(), KDirOperator::url(), and KURL::url(). Referenced by getSaveFileName(), KEncodingFileDialog::getSaveFileNameAndEncoding(), getSaveURL(), KEncodingFileDialog::getSaveURLAndEncoding(), init(), and KURLRequester::slotOpenDialog(). |
|
|
Sets the operational mode of the filedialog to 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( KFileDialog::Saving ); sets setKeepLocation for example.
The mode
The default mode is Call this method right after instantiating KFileDialog.
Definition at line 1740 of file kfiledialog.cpp. References updateAutoSelectExtension(). Referenced by getImageOpenURL(), getOpenFileName(), getOpenFileNames(), getOpenURL(), getOpenURLs(), getSaveFileName(), getSaveURL(), and KEncodingFileDialog::KEncodingFileDialog(). |
|
|
Definition at line 1750 of file kfiledialog.cpp. References OperationMode. Referenced by updateAutoSelectExtension(). |
|
|
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. This is implicitly set when operationMode() is KFileDialog::Saving 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. Definition at line 1730 of file kfiledialog.cpp. |
|
|
Definition at line 1735 of file kfiledialog.cpp. |
|
|
Sets the filter to be used to
You can set more filters for the user to select separated by '
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. 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):
Definition at line 201 of file kfiledialog.cpp. References KDirOperator::clearFilter(), QString::find(), setMimeFilter(), KDirOperator::setNameFilter(), QStringList::split(), and updateAutoSelectExtension(). Referenced by KURLRequester::fileDialog(), init(), and KURLRequester::setFilter(). |
|
|
Returns the current filter as entered by the user or one of the predefined set via setFilter().
Definition at line 230 of file kfiledialog.cpp. Referenced by updateAutoSelectExtension(). |
|
||||||||||||||||
|
Sets the filter up to specify the output type.
Definition at line 236 of file kfiledialog.cpp. References setMimeFilter(). |
|
|
Returns the mimetype for the desired output format. This is only valid if setFilterMimeType() has been called previously.
Definition at line 289 of file kfiledialog.cpp. References currentMimeFilter(), and KMimeType::mimeType(). |
|
||||||||||||
|
Sets the filter up to specify the output type.
Definition at line 250 of file kfiledialog.cpp. References KDirOperator::clearFilter(), QString::isEmpty(), KDirOperator::setMimeFilter(), QStringList::split(), and updateAutoSelectExtension(). Referenced by setFilter(), and setFilterMimeType(). |
|
|
The mimetype for the desired output format. This is only valid if setMimeFilter() has been called previously.
Definition at line 278 of file kfiledialog.cpp. Referenced by currentFilterMimeType(). |
|
|
Clears any mime- or namefilter. Does not reload the directory. Definition at line 267 of file kfiledialog.cpp. References KDirOperator::clearFilter(), and updateAutoSelectExtension(). |
|
|
Ownership is transferred to KFileDialog. You need to create the preview-widget with "new", i.e. on the heap. Definition at line 294 of file kfiledialog.cpp. References KDirOperator::clearHistory(), and KDirOperator::setPreviewWidget(). Referenced by getImageOpenURL(). |
|
|
Adds a preview widget and enters the preview mode. In this mode the dialog is split and the right part contains your preview widget. Ownership is transferred to KFileDialog. You need to create the preview-widget with "new", i.e. on the heap.
Definition at line 300 of file kfiledialog.cpp. References KDirOperator::clearHistory(), and KDirOperator::setPreviewWidget(). |
|
||||||||||||||||||||
|
Creates a modal file dialog and return the selected filename or an empty string if none was chosen. Note that with this method the user must select an existing filename.
Definition at line 1300 of file kfiledialog.cpp. References KDirOperator::clearHistory(), QDialog::exec(), QString::isNull(), ops, selectedFile(), KDialog::setCaption(), setMode(), and setOperationMode(). |
|
||||||||||||||||||||
|
Creates a modal file dialog and returns the selected filenames or an empty list if none was chosen. Note that with this method the user must select an existing filename.
Definition at line 1316 of file kfiledialog.cpp. References KDirOperator::clearHistory(), QDialog::exec(), QString::isNull(), ops, selectedFiles(), KDialog::setCaption(), setMode(), and setOperationMode(). |
|
||||||||||||||||||||
|
Creates a modal file dialog and returns the selected URL or an empty string if none was chosen. Note that with this method the user must select an existing URL.
Definition at line 1332 of file kfiledialog.cpp. References KDirOperator::clearHistory(), QDialog::exec(), QString::isNull(), ops, selectedURL(), KDialog::setCaption(), setMode(), and setOperationMode(). |
|
||||||||||||||||||||
|
Creates a modal file dialog and returns the selected URLs or an empty list if none was chosen. Note that with this method the user must select an existing filename.
Definition at line 1346 of file kfiledialog.cpp. References KDirOperator::clearHistory(), QDialog::exec(), QString::isNull(), ops, selectedURLs(), KDialog::setCaption(), setMode(), and setOperationMode(). |
|
||||||||||||||||||||
|
Creates a modal file dialog and returns the selected filename or an empty string if none was chosen. Note that with this method the user need not select an existing filename.
Definition at line 1539 of file kfiledialog.cpp. References KRecentDocument::add(), QString::at(), QDialog::exec(), QString::isEmpty(), QString::isNull(), selectedFile(), KDialog::setCaption(), setOperationMode(), and setSelection(). |
|
||||||||||||||||||||
|
Creates a modal file dialog and returns the selected filename or an empty string if none was chosen. Note that with this method the user need not select an existing filename.
Definition at line 1560 of file kfiledialog.cpp. References KRecentDocument::add(), QString::at(), QDialog::exec(), QString::isNull(), KURL::isValid(), selectedURL(), KDialog::setCaption(), setOperationMode(), and setSelection(). |
|
||||||||||||||||
|
Creates a modal file dialog and returns the selected directory or an empty string if none was chosen.
Definition at line 1369 of file kfiledialog.cpp. References KURL::isValid(), KURL::path(), and KDirSelectDialog::selectDirectory(). |
|
||||||||||||||||
|
Creates a modal file dialog and returns the selected directory or an empty string if none was chosen. Contrary to getExistingDirectory(), this method allows the selection of a remote directory.
Definition at line 1362 of file kfiledialog.cpp. References KDirSelectDialog::selectDirectory(). |
|
||||||||||||||||
|
Creates a modal file dialog with an image previewer and returns the selected url or an empty string if none was chosen.
Definition at line 1381 of file kfiledialog.cpp. References QDialog::exec(), QString::isNull(), QStringList::join(), KImageIO::mimeTypes(), selectedURL(), KDialog::setCaption(), setMode(), setOperationMode(), and setPreviewWidget(). |
|
|
Convenient overload of the other setMode(unsigned int) method.
Definition at line 1591 of file kfiledialog.cpp. References KDirOperator::dirOnlyMode(), KDirOperator::setMode(), and updateAutoSelectExtension(). Referenced by KURLRequester::fileDialog(), getImageOpenURL(), getOpenFileName(), KEncodingFileDialog::getOpenFileNameAndEncoding(), getOpenFileNames(), KEncodingFileDialog::getOpenFileNamesAndEncoding(), getOpenURL(), KEncodingFileDialog::getOpenURLAndEncoding(), getOpenURLs(), KEncodingFileDialog::getOpenURLsAndEncoding(), KURLRequester::setMode(), and setMode(). |
|
|
Sets the mode of the dialog. The mode is defined as (in kfile.h): You can OR the values, e.g.
Definition at line 1604 of file kfiledialog.cpp. References setMode(). |
