class KFileDialog

Public Types

• enum OperationMode { Other = 0, Opening, Saving }

Public Methods

•  KFileDialog (const QString& startDir, const QString& filter, QWidget *parent, const char *name, bool modal)
•  ~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)
• KMimeType::Ptr  currentFilterMimeType ()
• void  setMimeFilter ( const QStringList& types, const QString& defaultType = QString::null )
• QString  currentMimeFilter () const
• void  clearFilter ()
• void  setPreviewWidget (const QWidget *w)
• void  setPreviewWidget (const KPreviewWidgetBase *w)
• void  setMode ( KFile::Mode m )
• void  setMode ( unsigned int m )
• KFile::Mode  mode () const
• void  setLocationLabel (const QString& text)
• KToolBar * toolBar () const
• QPushButton * okButton () const
• QPushButton * cancelButton () const

Signals

• void  fileSelected (const QString&)
• void  fileHighlighted (const QString&)
• void  selectionChanged ()
• void  filterChanged ( const QString& filter )

Public Static Methods

• static QString  getOpenFileName (const QString& startDir= QString::null, const QString& filter= QString::null, QWidget *parent= 0, const QString& caption = QString::null)
• 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 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  getImageOpenURL ( const QString& startDir = QString::null, QWidget *parent = 0, const QString& caption = QString::null )

Protected Methods

• void  addDirEntry (KFileViewItem *entry, bool disableUpdating)
• virtual void  initGUI ()
• void  multiSelectionChanged ()
• virtual void  readConfig ( KConfig *, const QString& group = QString::null )
• virtual void  saveConfig ( KConfig *, const QString& group = QString::null )
• virtual void  readRecentFiles ( KConfig * )
• virtual void  saveRecentFiles ( KConfig * )
• KURL::List  tokenize (const QString& line) const
• KURL::List&  parseSelectedURLs () const

Protected Slots

• void  urlEntered ( const KURL& )
• void  pathComboActivated ( const KURL& url )
• void  pathComboReturnPressed ( const QString& url )
• void  locationActivated ( const QString& url )
• void  toolbarCallback (int)
• void  toolbarPressedCallback (int)
• void  slotFilterChanged ()
• void  pathComboChanged ( const QString& )
• void  fileHighlighted (const KFileViewItem *i)
• void  fileSelected (const KFileViewItem *i)
• void  slotStatResult (KIO::Job* job)
• void  slotLoadingFinished ()
• void  dirCompletion ( const QString& )
• void  fileCompletion ( const QString& )
• virtual void  updateStatusLine (int dirs, int files)
• virtual void  slotOk ()
• virtual void  accept ()
• virtual void  slotCancel ()
• void  addToBookmarks ()
• void  bookmarksChanged ()
• void  fillBookmarkMenu ( KFileBookmark *parent, QPopupMenu *menu, int &id )
• void  addToRecentDocuments ()

Protected Members

• KToolBar *toolbar
• static KURL *lastDirectory
• QPopupMenu *bookmarksMenu
• KURLComboBox *locationEdit
• KFileFilter *filterWidget
• KFileBookmarkManager *bookmarks
• QStringList history
• KFileDialogPrivate *d
• KDirOperator *ops
• bool autoDirectoryFollowing

Detailed Description

Provide a user (and developer) friendly way to select files and directories.

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.

Defines some default behavior of the filedialog. E.g. in mode Opening and Saving, the selected files/urls will be added to the "recent documents" list. The Saving mode also implies setKeepLocation() being set.

Other means that no default actions are performed.

See also: setOperationMode, operationMode

Construct a file dialog.

• The URL of the directory to start in.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
filter	A shell glob or a mime-type-filter that specifies which files to display. See setFilter() for details on how to use this argument.
acceptURLs	If set to false, KFileDialog will just accept files on the local filesystem.

Destruct the file dialog.

[const]

Returns: The selected fully qualified filename.

[const]

Returns: The list of selected URLs.

[const]

Returns: the currently shown directory.

[const]

Retrieve the full path of the selected file in the local filesystem. (Local files only)

[const]

Retrieve a list of all selected local files.

Set the directory to view.

Parameters:

url	URL to show.
clearforward	Indicates whether the forward queue should be cleared.

Set the file name to preselect to name

This takes absolute URLs and relative file names.

Sets the operational mode of the filedialog to Saving, Opening or Other. 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 default mode is Other.

Call this method right after instantiating KFileDialog.

See also: operationMode, OperationMode

[const]

Returns: the current operation mode, Opening, Saving or Other. Default is Other.

See also: operationMode, OperationMode

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.

[const]

Returns: whether the contents of the location edit are kept when changing directories.

Set the filter to be used to filter.

You can set more filters for the user to select seperated by '\n'. Every filter entry is defined through namefilter|text to diplay. If no | is found in the expression, just the namefilter is shown. Examples:

 kfile->setFilter("*.cpp|C++ Source Files\n*.h|Header files");
 kfile->setFilter("*.cpp");
 kfile->setFilter("*.cpp|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 a '/', a mimetype-filter is assumed. You can specify multiple mimetypes like this (separated with space):

 kfile->setFilter( "image/png text/html text/plain" );

See also: filterChanged, setMimeFilter

[const]

Retrieve the current filter as entered by the user or one of the predefined set via setFilter().

Parameters:

filter

Contains the new filter (only the extension part, not the explanation), for example, "*.cpp" or "*.cpp *.cc".

See also: setFilter(), filterChanged()

Set the filter up to specify the output type.

Do not use in conjunction with setFilter()

Parameters:

label	the label to use instead of "Filter:"
types	a list of mimetypes that can be used as output format
defaultType	the default mimetype to use as output format.

The mimetype for the desired output format.

This is only valid if setFilterMimeType() has been called previously.

See also: setFilterMimeType()

Set the filter up to specify the output type.

Do not use in conjunction with setFilter()

Parameters:

types	a list of mimetypes that can be used as output format
defaultType	the default mimetype to use as output format, if any. If defaultType is set, it will be set as the current item. Otherwise, a first item showing all the mimetypes will be created. Typically, defaultType should be empty for loading and set for saving.

[const]

The mimetype for the desired output format.

This is only valid if setMimeFilter() has been called previously.

See also: setMimeFilter()

Clears any mime- or namefilter. Does not reload the directory.

Add a preview widget and enter the preview mode.

In this mode the dialog is split and the right part contains your widget. This widget has to inherit QWidget and it has to implement a slot showPreview(const KURL &); which is called every time the file changes. You may want to look at koffice/lib/kofficecore/koFilterManager.cc for some hints :)

Ownership is transferred to KFileDialog. You need to create the preview-widget with "new", i.e. on the heap.

Add a preview widget and enter 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.

Parameters:

w	The widget to be used for the preview.

[static]

Create 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.

• The URL of the directory to start in.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
filter	This is a space seperated list of shell globs.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

[static]

Create a modal file dialog and return the selected filenames or an empty list if none was chosen.

Note that with this method the user must select an existing filename.

• The URL of the directory to start in.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
filter	This is a space seperated list of shell globs.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

[static]

Create a modal file dialog and return the selected URL or an empty string if none was chosen.

Note that with this method the user must select an existing URL.

• The URL of the directory to start in.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
filter	This is a space seperated list of shell globs.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

[static]

Create a modal file dialog and return the selected URLs or an empty list if none was chosen.

Note that with this method the user must select an existing filename.

• The URL of the directory to start in.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
filter	This is a space seperated list of shell globs.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

[static]

Create a modal file dialog and return the selected filename or an empty string if none was chosen.

Note that with this method the user need not select an existing filename.

• The URL of the directory to start in.
• a relative path or a filename determining the directory to start in and the file to be selected.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
filter	This is a space seperated list of shell globs.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

[static]

Create 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.

• The URL of the directory to start in.
• a relative path or a filename determining the directory to start in and the file to be selected.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
filter	This is a space seperated list of shell globs.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

[static]

Create a modal file dialog and returns the selected directory or an empty string if none was chosen.

Note that with this method the user need not select an existing directory.

• The URL of the directory to start in.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

[static]

Create a modal file dialog with an image previewer and returns the selected url or an empty string if none was chosen.

• The URL of the directory to start in.
• QString::null to start in the current working directory, or the last directory where a file has been selected.
• ':' to start in the directory last used by a filedialog in the same application that specified the same keyword.
• '::

Parameters:

startDir	This can either be
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

[virtual]

Set 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
                    };

You can OR the values, e.g.

 KFile::Mode mode = static_cast<KFile::Mode>( KFile::Files |
                                              KFile::ExistingOnly |
                                              KFile::LocalOnly );
 setMode( mode );

[const]

Retrieve the mode of the filedialog.

See also: setMode()

Set 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.

[const]

Retrieve 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() );

[const]

Returns: a pointer to the OK-Button in the filedialog. You may use it e.g. to set a custom text to it.

[const]

Returns: a pointer to the Cancel-Button in the filedialog. You may use it e.g. to set a custom text to it.

[signal]

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().

[signal]

Emitted when the user highlights a file.

[signal]

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.

See also: fileSelected

[signal]

Emitted when the filter changed, i.e. the user entered an own filter or chose one of the predefined set via setFilter().

Parameters:

filter

contains the new filter (only the extension part, not the explanation), i.e. "*.cpp" or "*.cpp *.cc".

See also: setFilter(), currentFilter()

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

adds a entry of the current directory. If disableUpdating is set to true, it will care about clever updating

[protected virtual]

rebuild geometry managment.

[protected]

called when an item is highlighted/selected in multiselection mode. handles setting the locationEdit.

[protected virtual]

Reads configuration and applies it (size, recent directories, ...)

[protected virtual]

Saves the current configuration

[protected virtual]

Reads the recent used files and inserts them into the location combobox

[protected virtual]

Saves the entries from the location combobox.

[protected const]

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.

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots virtual slot]

[protected slots virtual slot]

Reimplemented from KDialogBase.

[protected slots virtual slot]

[protected slots virtual slot]

Reimplemented from KDialogBase.

[protected slots slot]

Add the current location to the global bookmarks list

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected]

[protected]

[protected]

[protected const]

• Author: Richard J. Moore , Carsten Pfeiffer
• Generated: dfaure on kde.faure.org on Thu Jan 17 22:17:38 2002, using kdoc 2.0a53.