• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kio/kfile
 

kio/kfile

Public Types | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
KFileDialog Class Reference

#include <kfiledialog.h>

Inheritance diagram for KFileDialog:
KEncodingFileDialog

Public Types

enum  OperationMode { Other = 0, Opening, Saving }

Signals

void fileSelected (const TQString &)
void fileHighlighted (const TQString &)
void selectionChanged ()
void filterChanged (const TQString &filter)

Public Member Functions

 KFileDialog (const TQString &startDir, const TQString &filter, TQWidget *parent, const char *name, bool modal)
 KFileDialog (const TQString &startDir, const TQString &filter, TQWidget *parent, const char *name, bool modal, TQWidget *widget)
 ~KFileDialog ()
KURL selectedURL () const
KURL::List selectedURLs () const
KURL baseURL () const
TQString selectedFile () const
TQStringList selectedFiles () const
void setURL (const KURL &url, bool clearforward=true)
void setSelection (const TQString &name)
void setOperationMode (KFileDialog::OperationMode)
OperationMode operationMode () const
void setKeepLocation (bool keep)
bool keepsLocation () const
void setFilter (const TQString &filter)
TQString currentFilter () const
void setFilterMimeType (const TQString &label, const KMimeType::List &types, const KMimeType::Ptr &defaultType) KDE_DEPRECATED
KMimeType::Ptr currentFilterMimeType ()
void setMimeFilter (const TQStringList &types, const TQString &defaultType=TQString::null)
TQString currentMimeFilter () const
void clearFilter ()
void setPreviewWidget (const TQWidget *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 TQString &text)
KToolBar * toolBar () const
KPushButton * okButton () const
KPushButton * cancelButton () const
KURLBar * speedBar ()
KActionCollection * actionCollection () const
int pathComboIndex ()

Static Public Member Functions

static TQString getOpenFileName (const TQString &startDir=TQString::null, const TQString &filter=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static TQString getOpenFileNameWId (const TQString &startDir, const TQString &filter, WId parent_id, const TQString &caption)
static TQStringList getOpenFileNames (const TQString &startDir=TQString::null, const TQString &filter=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static KURL getOpenURL (const TQString &startDir=TQString::null, const TQString &filter=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static KURL::List getOpenURLs (const TQString &startDir=TQString::null, const TQString &filter=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static TQString getSaveFileName (const TQString &startDir=TQString::null, const TQString &filter=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static TQString getSaveFileNameWId (const TQString &dir, const TQString &filter, WId parent_id, const TQString &caption)
static KURL getSaveURL (const TQString &startDir=TQString::null, const TQString &filter=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static TQString getExistingDirectory (const TQString &startDir=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static KURL getExistingURL (const TQString &startDir=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static KURL getImageOpenURL (const TQString &startDir=TQString::null, TQWidget *parent=0, const TQString &caption=TQString::null)
static KURL getStartURL (const TQString &startDir, TQString &recentDirClass)
static void setStartDir (const KURL &directory)

Protected Slots

void urlEntered (const KURL &)
void enterURL (const KURL &url)
void enterURL (const TQString &url)
void locationActivated (const TQString &url)
void toolbarCallback (int)
void pathComboChanged (const TQString &)
void dirCompletion (const TQString &)
void slotFilterChanged ()
void fileHighlighted (const KFileItem *i)
void fileSelected (const KFileItem *i)
void slotStatResult (KIO::Job *job)
void slotLoadingFinished ()
void fileCompletion (const TQString &)
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 (TQKeyEvent *e)
void init (const TQString &startDir, const TQString &filter, TQWidget *widget)
virtual void initGUI ()
void multiSelectionChanged ()
virtual void readConfig (KConfig *, const TQString &group=TQString::null)
virtual void writeConfig (KConfig *, const TQString &group=TQString::null)
virtual void readRecentFiles (KConfig *)
virtual void saveRecentFiles (KConfig *)
KURL::List tokenize (const TQString &line) const
KURL getCompleteURL (const TQString &)
TQString 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

Detailed Description

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

The widget can be used as a drop in replacement for the TQFileDialog 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.

kfiledialog.png
KDE File Dialog

A file selection dialog.

Author
Richard J. Moore rich@.nosp@m.kde..nosp@m.org, Carsten Pfeiffer pfeif.nosp@m.fer@.nosp@m.kde.o.nosp@m.rg

Definition at line 77 of file kfiledialog.h.

Member Enumeration Documentation

enum KFileDialog::OperationMode

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

Definition at line 94 of file kfiledialog.h.

Constructor & Destructor Documentation

KFileDialog::KFileDialog ( const TQString &  startDir,
const TQString &  filter,
TQWidget *  parent,
const char *  name,
bool  modal 
)

Constructs a file dialog.

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
filterA shell glob or a mime-type-filter that specifies which files to display.
parentThe parent widget of this dialog
nameThe name of this object
modalWhether to create a modal dialog or not See setFilter() for details on how to use this argument.

Definition at line 169 of file kfiledialog.cpp.

KFileDialog::KFileDialog ( const TQString &  startDir,
const TQString &  filter,
TQWidget *  parent,
const char *  name,
bool  modal,
TQWidget *  widget 
)

Constructs a file dialog.

The parameters here are identical to the first constructor except for the addition of a TQWidget 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.

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
filterA shell glob or a mime-type-filter that specifies which files to display. See setFilter() for details on how to use this argument.
widgetA widget, or a widget of widgets, for displaying custom data in the dialog. This can be used, for example, to display a check box with the caption "Open as read-only". When creating this widget, you don't need to specify a parent, since the widget's parent will be set automatically by KFileDialog.
parentThe parent widget of this dialog
nameThe name of this object
modalWhether to create a modal dialog or not
Since
3.1

Definition at line 176 of file kfiledialog.cpp.

KFileDialog::~KFileDialog ( )

Destructs the file dialog.

Definition at line 184 of file kfiledialog.cpp.

Member Function Documentation

KActionCollection * KFileDialog::actionCollection ( ) const
Returns
a pointer to the action collection, holding all the used KActions.

Definition at line 2203 of file kfiledialog.cpp.

KURL KFileDialog::baseURL ( ) const
Returns
the currently shown directory.

Definition at line 1589 of file kfiledialog.cpp.

KPushButton * KFileDialog::cancelButton ( ) const
Returns
a pointer to the Cancel-Button in the filedialog. You may use it e.g. to set a custom text to it.

Definition at line 1802 of file kfiledialog.cpp.

void KFileDialog::clearFilter ( )

Clears any mime- or namefilter.

Does not reload the directory.

Definition at line 271 of file kfiledialog.cpp.

TQString KFileDialog::currentFilter ( ) const

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

See Also
setFilter()
filterChanged()

Definition at line 234 of file kfiledialog.cpp.

TQString KFileDialog::currentFilterExtension ( void  )
protected

Returns the filename extension associated with the currentFilter().

TQString::null is returned if an extension is not available or if operationMode() != Saving.

Since
3.2

Definition at line 1909 of file kfiledialog.cpp.

KMimeType::Ptr KFileDialog::currentFilterMimeType ( )

Returns the mimetype for the desired output format.

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

See Also
setFilterMimeType()

Definition at line 293 of file kfiledialog.cpp.

TQString KFileDialog::currentMimeFilter ( ) const

The mimetype for the desired output format.

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

See Also
setMimeFilter()

Definition at line 282 of file kfiledialog.cpp.

void KFileDialog::dirCompletion ( const TQString &  )
protectedslot
Deprecated:

Definition at line 1294 of file kfiledialog.cpp.

void KFileDialog::fileHighlighted ( const TQString &  )
signal

Emitted when the user highlights a file.

void KFileDialog::fileSelected ( const TQString &  )
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().

void KFileDialog::filterChanged ( const TQString &  filter)
signal

Emitted when the filter changed, i.e.

the user entered an own filter or chose one of the predefined set via setFilter().

Parameters
filtercontains the new filter (only the extension part, not the explanation), i.e. "*.cpp" or "*.cpp *.cc".
See Also
setFilter()
currentFilter()
KURL KFileDialog::getCompleteURL ( const TQString &  _url)
protected

Returns the absolute version of the URL specified in locationEdit.

Since
3.2

Definition at line 310 of file kfiledialog.cpp.

TQString KFileDialog::getExistingDirectory ( const TQString &  startDir = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.

Definition at line 1411 of file kfiledialog.cpp.

KURL KFileDialog::getExistingURL ( const TQString &  startDir = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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.

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.
Since
3.1

Definition at line 1404 of file kfiledialog.cpp.

KURL KFileDialog::getImageOpenURL ( const TQString &  startDir = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.

Definition at line 1428 of file kfiledialog.cpp.

TQString KFileDialog::getOpenFileName ( const TQString &  startDir = TQString::null,
const TQString &  filter = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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.

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
filterThis is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.

Definition at line 1318 of file kfiledialog.cpp.

TQStringList KFileDialog::getOpenFileNames ( const TQString &  startDir = TQString::null,
const TQString &  filter = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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.

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
filterThis is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.

Definition at line 1358 of file kfiledialog.cpp.

TQString KFileDialog::getOpenFileNameWId ( const TQString &  startDir,
const TQString &  filter,
WId  parent_id,
const TQString &  caption 
)
static

Use this version only if you have no TQWidget 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.

Since
3.4

Definition at line 1334 of file kfiledialog.cpp.

KURL KFileDialog::getOpenURL ( const TQString &  startDir = TQString::null,
const TQString &  filter = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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.

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
filterThis is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.

Definition at line 1374 of file kfiledialog.cpp.

KURL::List KFileDialog::getOpenURLs ( const TQString &  startDir = TQString::null,
const TQString &  filter = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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.

Parameters
startDirThis can either be
  • The URL of the directory to start in.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
filterThis is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.

Definition at line 1388 of file kfiledialog.cpp.

TQString KFileDialog::getSaveFileName ( const TQString &  startDir = TQString::null,
const TQString &  filter = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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.

Parameters
startDirThis can either be
  • 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.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
filterThis is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.

Definition at line 1594 of file kfiledialog.cpp.

TQString KFileDialog::getSaveFileNameWId ( const TQString &  dir,
const TQString &  filter,
WId  parent_id,
const TQString &  caption 
)
static

This function accepts the window id of the parent window, instead of TQWidget*.

It should be used only when necessary.

Since
3.4

Definition at line 1615 of file kfiledialog.cpp.

KURL KFileDialog::getSaveURL ( const TQString &  startDir = TQString::null,
const TQString &  filter = TQString::null,
TQWidget *  parent = 0,
const TQString &  caption = TQString::null 
)
static

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.

Parameters
startDirThis can either be
  • 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.
  • TQString::null to start in the current working directory, or the last directory where a file has been selected.
  • ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
filterThis is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
parentThe widget the dialog will be centered on initially.
captionThe name of the dialog widget.

Definition at line 1644 of file kfiledialog.cpp.

KURL KFileDialog::getStartURL ( const TQString &  startDir,
TQString &  recentDirClass 
)
static

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.

Parameters
startDirA url/directory, to be used. May use the ':' and '::' syntax as documented in the KFileDialog() constructor.
recentDirClassIf the ':' or '::' syntax is used, recentDirClass will contain the string to be used later for KRecentDir::dir()
Returns
The URL that should be listed by default (e.g. by KFileDialog or KDirSelectDialog).
Since
3.1

Definition at line 2305 of file kfiledialog.cpp.

void KFileDialog::init ( const TQString &  startDir,
const TQString &  filter,
TQWidget *  widget 
)
protected

Perform basic initialization tasks.

Called by constructors.

Since
3.1

Definition at line 815 of file kfiledialog.cpp.

void KFileDialog::initGUI ( )
protectedvirtual

rebuild geometry management.

Definition at line 1070 of file kfiledialog.cpp.

bool KFileDialog::keepsLocation ( ) const
Returns
whether the contents of the location edit are kept when changing directories.

Definition at line 1828 of file kfiledialog.cpp.

void KFileDialog::keyPressEvent ( TQKeyEvent *  e)
protectedvirtual

Reimplemented to animate the cancel button.

Definition at line 2208 of file kfiledialog.cpp.

KFile::Mode KFileDialog::mode ( ) const

Returns the mode of the filedialog.

See Also
setMode()

Definition at line 1693 of file kfiledialog.cpp.

void KFileDialog::multiSelectionChanged ( )
protected

called when an item is highlighted/selected in multiselection mode.

handles setting the locationEdit.

Definition at line 745 of file kfiledialog.cpp.

KPushButton * KFileDialog::okButton ( ) const
Returns
a pointer to the OK-Button in the filedialog. You may use it e.g. to set a custom text to it.

Definition at line 1797 of file kfiledialog.cpp.

KFileDialog::OperationMode KFileDialog::operationMode ( ) const
Returns
the current operation mode, Opening, Saving or Other. Default is Other.
See Also
operationMode
KFileDialog::OperationMode

Definition at line 1850 of file kfiledialog.cpp.

void KFileDialog::pathComboChanged ( const TQString &  )
protectedslot
Deprecated:

Definition at line 1291 of file kfiledialog.cpp.

int KFileDialog::pathComboIndex ( )
Returns
the index of the path combobox so when inserting widgets into the dialog (e.g. subclasses) they can do so without hardcoding in an index

Definition at line 2290 of file kfiledialog.cpp.

void KFileDialog::readConfig ( KConfig *  kc,
const TQString &  group = TQString::null 
)
protectedvirtual

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

Definition at line 1699 of file kfiledialog.cpp.

void KFileDialog::readRecentFiles ( KConfig *  kc)
protectedvirtual

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

Definition at line 1772 of file kfiledialog.cpp.

void KFileDialog::saveRecentFiles ( KConfig *  kc)
protectedvirtual

Saves the entries from the location combobox.

Definition at line 1787 of file kfiledialog.cpp.

TQString KFileDialog::selectedFile ( ) const

Returns the full path of the selected file in the local filesystem.

(Local files only)

Definition at line 1547 of file kfiledialog.cpp.

TQStringList KFileDialog::selectedFiles ( ) const

Returns a list of all selected local files.

Definition at line 1563 of file kfiledialog.cpp.

KURL KFileDialog::selectedURL ( ) const
Returns
The selected fully qualified filename.

Definition at line 1446 of file kfiledialog.cpp.

KURL::List KFileDialog::selectedURLs ( ) const
Returns
The list of selected URLs.

Definition at line 1454 of file kfiledialog.cpp.

void KFileDialog::selectionChanged ( )
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
void KFileDialog::setFilter ( const TQString &  filter)

Sets the filter to be used to filter.

You can set more filters for the user to select separated by '
'. 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|" + 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)" );
See Also
filterChanged
setMimeFilter

Definition at line 205 of file kfiledialog.cpp.

void KFileDialog::setFilterMimeType ( const TQString &  label,
const KMimeType::List &  types,
const KMimeType::Ptr &  defaultType 
)

Sets the filter up to specify the output type.

Parameters
labelthe label to use instead of "Filter:"
typesa list of mimetypes that can be used as output format
defaultTypethe default mimetype to use as output format.

Do not use in conjunction with setFilter()

Deprecated:

Definition at line 240 of file kfiledialog.cpp.

void KFileDialog::setKeepLocation ( bool  keep)

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 1823 of file kfiledialog.cpp.

void KFileDialog::setLocationLabel ( const TQString &  text)

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.

void KFileDialog::setMimeFilter ( const TQStringList &  types,
const TQString &  defaultType = TQString::null 
)

Sets the filter up to specify the output type.

Parameters
typesa list of mimetypes that can be used as output format
defaultTypethe 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.

Do not use in conjunction with setFilter()

Definition at line 254 of file kfiledialog.cpp.

void KFileDialog::setMode ( KFile::Mode  m)

Convenient overload of the other setMode(unsigned int) method.

Definition at line 1675 of file kfiledialog.cpp.

void KFileDialog::setMode ( unsigned int  m)

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

You can OR the values, e.g.

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

Definition at line 1688 of file kfiledialog.cpp.

void KFileDialog::setOperationMode ( KFileDialog::OperationMode  mode)

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 mode Saving, together with a default filter set via setMimeFilter() will make the filter combobox read-only.

The default mode is Opening.

Call this method right after instantiating KFileDialog.

See Also
operationMode
KFileDialog::OperationMode

Definition at line 1833 of file kfiledialog.cpp.

void KFileDialog::setPreviewWidget ( const TQWidget *  w)
Deprecated:
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 TQWidget 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.

Definition at line 298 of file kfiledialog.cpp.

void KFileDialog::setPreviewWidget ( const KPreviewWidgetBase *  w)

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.

Parameters
wThe widget to be used for the preview.

Definition at line 304 of file kfiledialog.cpp.

void KFileDialog::setSelection ( const TQString &  name)

Sets the file name to preselect to name.

This takes absolute URLs and relative file names.

Definition at line 1219 of file kfiledialog.cpp.

void KFileDialog::setURL ( const KURL &  url,
bool  clearforward = true 
)

Sets the directory to view.

Parameters
urlURL to show.
clearforwardIndicates whether the forward queue should be cleared.

Definition at line 1158 of file kfiledialog.cpp.

KURLBar * KFileDialog::speedBar ( )
Returns
the KURLBar object used as the "speed bar". You can add custom entries to it like that:
KURLBar *urlBar = fileDialog->speedBar();
if ( urlBar )
urlBar->insertDynamicItem( someURL, i18n("The URL's description") );

Note that this method may return a null-pointer if the user configured to not use the speed-bar.

See Also
KURLBar
KURLBar::insertDynamicItem
Since
3.2

Definition at line 1807 of file kfiledialog.cpp.

void KFileDialog::toggleBookmarks ( bool  show)
protectedslot
Since
3.4

Definition at line 2255 of file kfiledialog.cpp.

void KFileDialog::toggleSpeedbar ( bool  show)
protectedslot
Since
3.1

Definition at line 2219 of file kfiledialog.cpp.

KURL::List KFileDialog::tokenize ( const TQString &  line) const
protected

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 1501 of file kfiledialog.cpp.

KToolBar* KFileDialog::toolBar ( ) const
inline

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, TQT_SLOT( yourSlot() ),
this, "action name" );
yourAction->plug( kfileDialog->toolBar() );

Definition at line 722 of file kfiledialog.h.

void KFileDialog::toolbarCallback ( int  )
protectedslot
Deprecated:
,

Definition at line 1210 of file kfiledialog.cpp.

void KFileDialog::updateAutoSelectExtension ( void  )
protected

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

Since
3.2

Definition at line 1914 of file kfiledialog.cpp.

void KFileDialog::updateStatusLine ( int  dirs,
int  files 
)
protectedvirtualslot
Deprecated:

Definition at line 1313 of file kfiledialog.cpp.

void KFileDialog::writeConfig ( KConfig *  kc,
const TQString &  group = TQString::null 
)
protectedvirtual

Saves the current configuration.

Definition at line 1750 of file kfiledialog.cpp.


The documentation for this class was generated from the following files:
  • kfiledialog.h
  • kfiledialog.cpp

kio/kfile

Skip menu "kio/kfile"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

kio/kfile

Skip menu "kio/kfile"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kio/kfile by doxygen 1.8.1.2
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |