KFileDialog Class Reference
#include <kfiledialog.h>
Inheritance diagram for KFileDialog:

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 77 of file kfiledialog.h.
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 | |
static QString | getOpenFileName (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static QString | getOpenFileNameWId (const QString &startDir, const QString &filter, WId parent_id, const QString &caption) |
static QStringList | getOpenFileNames (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static KURL | getOpenURL (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static KURL::List | getOpenURLs (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static QString | getSaveFileName (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static QString | getSaveFileNameWId (const QString &dir, const QString &filter, WId parent_id, const QString &caption) |
static KURL | getSaveURL (const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static QString | getExistingDirectory (const QString &startDir=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static KURL | getExistingURL (const QString &startDir=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static KURL | getImageOpenURL (const QString &startDir=QString::null, QWidget *parent=0, const QString &caption=QString::null) |
static KURL | getStartURL (const QString &startDir, QString &recentDirClass) |
static 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) |
void | toggleBookmarks (bool show) |
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 | |
static KURL * | lastDirectory |
Member Enumeration Documentation
|
Defines some default behavior of the filedialog.
E.g. in mode
Definition at line 94 of file kfiledialog.h. |
Constructor & Destructor Documentation
|
Constructs a file dialog.
Definition at line 169 of file kfiledialog.cpp. |
|
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 176 of file kfiledialog.cpp. |
|
Destructs the file dialog.
Definition at line 184 of file kfiledialog.cpp. |
Member Function Documentation
|
Definition at line 2197 of file kfiledialog.cpp. |
|
Definition at line 1583 of file kfiledialog.cpp. |
|
Definition at line 1796 of file kfiledialog.cpp. |
|
Clears any mime- or namefilter. Does not reload the directory. Definition at line 271 of file kfiledialog.cpp. |
|
Returns the current filter as entered by the user or one of the predefined set via setFilter().
Definition at line 234 of file kfiledialog.cpp. |
|
Returns the filename extension associated with the currentFilter(). QString::null is returned if an extension is not available or if operationMode() != Saving.
Definition at line 1903 of file kfiledialog.cpp. |
|
Returns the mimetype for the desired output format. This is only valid if setFilterMimeType() has been called previously.
Definition at line 293 of file kfiledialog.cpp. |
|
The mimetype for the desired output format. This is only valid if setMimeFilter() has been called previously.
Definition at line 282 of file kfiledialog.cpp. |
|
Definition at line 1288 of file kfiledialog.cpp. |
|
Emitted when the user highlights a file.
|
|
Emitted when the user selects a file. It is only emitted in single- selection mode. The best way to get notified about selected file(s) is to connect to the okClicked() signal inherited from KDialogBase and call selectedFile(), selectedFiles(), selectedURL() or selectedURLs(). |
|
Emitted when the filter changed, i.e. the user entered an own filter or chose one of the predefined set via setFilter().
|
|
Returns the absolute version of the URL specified in locationEdit.
Definition at line 310 of file kfiledialog.cpp. |
|
Creates a modal file dialog and returns the selected directory or an empty string if none was chosen.
Definition at line 1405 of file kfiledialog.cpp. |
|
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 1398 of file kfiledialog.cpp. |
|
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 1422 of file kfiledialog.cpp. |
|
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 1312 of file kfiledialog.cpp. |
|
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 1352 of file kfiledialog.cpp. |
|
Use this version only if you have no QWidget available as parent widget. This can be the case if the parent widget is a widget in another process or if the parent widget is a non-Qt widget. For example, in a GTK program.
Definition at line 1328 of file kfiledialog.cpp. |
|
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 1368 of file kfiledialog.cpp. |
|
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 1382 of file kfiledialog.cpp. |
|
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 1588 of file kfiledialog.cpp. |
|
This function accepts the window id of the parent window, instead of QWidget*. It should be used only when necessary.
Definition at line 1609 of file kfiledialog.cpp. |
|
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 1638 of file kfiledialog.cpp. |
|
This method implements the logic to determine the user's default directory to be listed. E.g. the documents direcory, home directory or a recently used directory.
Definition at line 2299 of file kfiledialog.cpp. |
|
Perform basic initialization tasks. Called by constructors.
Definition at line 811 of file kfiledialog.cpp. |
|
rebuild geometry management.
Definition at line 1064 of file kfiledialog.cpp. |
|
Definition at line 1822 of file kfiledialog.cpp. |
|
Reimplemented to animate the cancel button.
Definition at line 2202 of file kfiledialog.cpp. |
|
Returns the mode of the filedialog.
Definition at line 1687 of file kfiledialog.cpp. |
|
called when an item is highlighted/selected in multiselection mode. handles setting the locationEdit. Definition at line 741 of file kfiledialog.cpp. |
|
Definition at line 1791 of file kfiledialog.cpp. |
|
Definition at line 1844 of file kfiledialog.cpp. |
|
Definition at line 1285 of file kfiledialog.cpp. |
|
Definition at line 2284 of file kfiledialog.cpp. |
|
Reads configuration and applies it (size, recent directories, . ..) Definition at line 1693 of file kfiledialog.cpp. |
|
Reads the recent used files and inserts them into the location combobox.
Definition at line 1766 of file kfiledialog.cpp. |
|
Saves the entries from the location combobox.
Definition at line 1781 of file kfiledialog.cpp. |
|
Returns the full path of the selected file in the local filesystem. (Local files only) Definition at line 1541 of file kfiledialog.cpp. |
|
Returns a list of all selected local files.
Definition at line 1557 of file kfiledialog.cpp. |
|
Definition at line 1440 of file kfiledialog.cpp. |
|
Definition at line 1448 of file kfiledialog.cpp. |
|
Emitted when the user hilights one or more files in multiselection mode. Note: fileHighlighted() or fileSelected() are not emitted in multiselection mode. You may use selectedItems() to ask for the current highlighted items.
|
|
Sets the filter to be used to
You can set more filters for the user to select separated by '
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"); 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):
kfile->setFilter( "image/png text/html text/plain" ); kfile->setFilter( "*.cue|CUE\\/BIN Files (*.cue)" );
Definition at line 205 of file kfiledialog.cpp. |
|
Sets the filter up to specify the output type.
Definition at line 240 of file kfiledialog.cpp. |
|
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 1817 of file kfiledialog.cpp. |
|
Sets the text to be displayed in front of the selection. The default is "Location". Most useful if you want to make clear what the location is used for. Definition at line 200 of file kfiledialog.cpp. |
|
Sets the filter up to specify the output type.
Definition at line 254 of file kfiledialog.cpp. |
|
Sets the mode of the dialog. The mode is defined as (in kfile.h): enum Mode {
File = 1,
Directory = 2,
Files = 4,
ExistingOnly = 8,
LocalOnly = 16
};
KFile::Mode mode = static_cast<KFile::Mode>( KFile::Files | KFile::ExistingOnly | KFile::LocalOnly ); setMode( mode ); Definition at line 1682 of file kfiledialog.cpp. |
|
Convenient overload of the other setMode(unsigned int) method.
Definition at line 1669 of file kfiledialog.cpp. |
|
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 1827 of file kfiledialog.cpp. |
|
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 304 of file kfiledialog.cpp. |
|
Ownership is transferred to KFileDialog. You need to create the preview-widget with "new", i.e. on the heap. Definition at line 298 of file kfiledialog.cpp. |
|
Sets the file name to preselect to This takes absolute URLs and relative file names. Definition at line 1213 of file kfiledialog.cpp. |
|
Sets the directory to view.
Definition at line 1152 of file kfiledialog.cpp. |
|
Definition at line 1801 of file kfiledialog.cpp. |
|
Definition at line 2249 of file kfiledialog.cpp. |
|
Definition at line 2213 of file kfiledialog.cpp. |
|
Parses the string "line" for files. If line doesn't contain any ", the whole line will be interpreted as one file. If the number of " is odd, an empty list will be returned. Otherwise, all items enclosed in " " will be returned as correct urls. Definition at line 1495 of file kfiledialog.cpp. |
|
Returns a pointer to the toolbar. You can use this to insert custom items into it, e.g.: yourAction = new KAction( i18n("Your Action"), 0, this, SLOT( yourSlot() ), this, "action name" ); yourAction->plug( kfileDialog->toolBar() ); Definition at line 722 of file kfiledialog.h. |
|
Definition at line 1204 of file kfiledialog.cpp. |
|
Updates the currentFilterExtension and the availability of the Automatically Select Extension Checkbox (visible if operationMode() == Saving and enabled if an extension _will_ be associated with the currentFilter(), _after_ this call). You should call this after filterWidget->setCurrentItem().
Definition at line 1908 of file kfiledialog.cpp. |
|
Definition at line 1307 of file kfiledialog.cpp. |
|
Saves the current configuration.
Definition at line 1744 of file kfiledialog.cpp. |
The documentation for this class was generated from the following files: