• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KFile

KFileWidget Class Reference

#include <kfilewidget.h>

Inheritance diagram for KFileWidget:
QWidget KAbstractFileWidget

List of all members.

Public Slots

virtual void accept ()
virtual void slotCancel ()
virtual void slotOk ()

Signals

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

Public Member Functions

KActionCollection * actionCollection () const
virtual KUrl baseUrl () const
KPushButton * cancelButton () const
virtual void clearFilter ()
virtual QString currentFilter () const
virtual KMimeType::Ptr currentFilterMimeType ()
virtual QString currentMimeFilter () const
KDirOperator * dirOperator ()
KFileFilterCombo * filterWidget () const
virtual bool keepsLocation () const
 KFileWidget (const KUrl &startDir, QWidget *parent)
KUrlComboBox * locationEdit () const
virtual KFile::Modes mode () const
KPushButton * okButton () const
virtual OperationMode operationMode () const
virtual QString selectedFile () const
virtual QStringList selectedFiles () const
virtual KUrl selectedUrl () const
virtual KUrl::List selectedUrls () const
virtual void setCustomWidget (const QString &text, QWidget *widget)
virtual void setCustomWidget (QWidget *widget)
virtual void setFilter (const QString &filter)
virtual void setKeepLocation (bool keep)
virtual void setLocationLabel (const QString &text)
virtual void setMimeFilter (const QStringList &types, const QString &defaultType=QString())
virtual void setMode (KFile::Modes m)
virtual void setOperationMode (OperationMode)
virtual void setPreviewWidget (KPreviewWidgetBase *w)
virtual void setSelection (const QString &name)
virtual void setUrl (const KUrl &url, bool clearforward=true)
KToolBar * toolBar () const
virtual void virtual_hook (int id, void *data)
virtual ~KFileWidget ()

Static Public Member Functions

static KUrl getStartUrl (const KUrl &startDir, QString &recentDirClass, QString &fileName)
static KUrl getStartUrl (const KUrl &startDir, QString &recentDirClass)
static void setStartDir (const KUrl &directory)

Protected Member Functions

virtual bool eventFilter (QObject *watched, QEvent *event)
virtual void resizeEvent (QResizeEvent *event)
virtual void showEvent (QShowEvent *event)

Detailed Description

Definition at line 39 of file kfilewidget.h.


Constructor & Destructor Documentation

KFileWidget::KFileWidget ( const KUrl &  startDir,
QWidget *  parent 
)

Constructs a file selector widget.

Parameters:
startDir This can either be:

  • An empty URL (KUrl()) to start in the current working directory, or the last directory where a file has been selected.
  • The path or URL of a starting directory.
  • An initial file name to select, with the starting directory being the current working directory or the last directory where a file has been selected.
  • The path or URL of a file, specifying both the starting directory and an initially selected file name.
  • A URL of the form kfiledialog:///<keyword> to start in the directory last used by a filedialog in the same application that specified the same keyword.
  • A URL of the form kfiledialog:///<keyword>/<filename> 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.
  • A URL of the form kfiledialog:///<keyword>?global to start in the directory last used by a filedialog in any application that specified the same keyword.
  • A URL of the form kfiledialog:///<keyword>/<filename>?global 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.
parent The parent widget of this widget

Definition at line 314 of file kfilewidget.cpp.

KFileWidget::~KFileWidget (  )  [virtual]

Destructor.

Definition at line 619 of file kfilewidget.cpp.


Member Function Documentation

void KFileWidget::accept (  )  [virtual, slot]

Implements KAbstractFileWidget.

Definition at line 981 of file kfilewidget.cpp.

void KFileWidget::accepted (  )  [signal]

Emitted by slotOk() (directly or asynchronously) once everything has been done.

Should be used by the caller to call accept().

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

Implements KAbstractFileWidget.

Definition at line 2391 of file kfilewidget.cpp.

KUrl KFileWidget::baseUrl (  )  const [virtual]
Returns:
the currently shown directory.

Implements KAbstractFileWidget.

Definition at line 1692 of file kfilewidget.cpp.

KPushButton * KFileWidget::cancelButton (  )  const [virtual]
Returns:
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.

Implements KAbstractFileWidget.

Definition at line 1896 of file kfilewidget.cpp.

void KFileWidget::clearFilter (  )  [virtual]

Clears any mime- or namefilter.

Does not reload the directory.

Implements KAbstractFileWidget.

Definition at line 683 of file kfilewidget.cpp.

QString KFileWidget::currentFilter (  )  const [virtual]

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

See also:
setFilter()
filterChanged()

Implements KAbstractFileWidget.

Definition at line 662 of file kfilewidget.cpp.

KMimeType::Ptr KFileWidget::currentFilterMimeType (  )  [virtual]

Returns the mimetype for the desired output format.

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

See also:
setFilterMimeType()

Implements KAbstractFileWidget.

Definition at line 702 of file kfilewidget.cpp.

QString KFileWidget::currentMimeFilter (  )  const [virtual]

The mimetype for the desired output format.

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

See also:
setMimeFilter()

Implements KAbstractFileWidget.

Definition at line 693 of file kfilewidget.cpp.

KDirOperator * KFileWidget::dirOperator (  ) 
Returns:
the KDirOperator used to navigate the filesystem
Since:
4.3

Definition at line 2644 of file kfilewidget.cpp.

bool KFileWidget::eventFilter ( QObject *  watched,
QEvent *  event 
) [protected, virtual]

Definition at line 1727 of file kfilewidget.cpp.

void KFileWidget::fileHighlighted ( const QString &   )  [signal]

Emitted when the user highlights a file.

void KFileWidget::fileSelected ( const QString &   )  [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 KDialog and call selectedFile(), selectedFiles(), selectedUrl() or selectedUrls().

void KFileWidget::filterChanged ( const QString &  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:
filter contains the new filter (only the extension part, not the explanation), i.e. "*.cpp" or "*.cpp *.cc".
See also:
setFilter()
currentFilter()
KFileFilterCombo * KFileWidget::filterWidget (  )  const [virtual]
Returns:
the combobox that contains the filters

Implements KAbstractFileWidget.

Definition at line 2386 of file kfilewidget.cpp.

KUrl KFileWidget::getStartUrl ( const KUrl &  startDir,
QString &  recentDirClass,
QString &  fileName 
) [static]

Similar to getStartUrl(const KUrl& startDir,QString& recentDirClass), but allows both the recent start directory keyword and a suggested file name to be returned.

Parameters:
startDir 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.
recentDirClass If the kfiledialog:/// syntax is used, this will return the string to be passed to KRecentDirs::dir() and KRecentDirs::add().
fileName The suggested file name, if specified as part of the StartDir URL.
Returns:
The URL that should be listed by default (e.g. by KFileDialog or KDirSelectDialog).
See also:
KFileWidget::KFileWidget()
Since:
4.3

Definition at line 2486 of file kfilewidget.cpp.

KUrl KFileWidget::getStartUrl ( const KUrl &  startDir,
QString &  recentDirClass 
) [static]

This method implements the logic to determine the user's default directory to be listed.

E.g. the documents directory, home directory or a recently used directory.

Parameters:
startDir A URL specifying the initial directory, or using the kfiledialog:/// syntax to specify a last used directory. If this URL specifies a file name, it is ignored. Refer to the KFileWidget::KFileWidget() documentation for the kfiledialog:/// URL syntax.
recentDirClass If the kfiledialog:/// syntax is used, this will return the string to be passed to KRecentDirs::dir() and KRecentDirs::add().
Returns:
The URL that should be listed by default (e.g. by KFileDialog or KDirSelectDialog).
See also:
KFileWidget::KFileWidget()

Definition at line 2477 of file kfilewidget.cpp.

bool KFileWidget::keepsLocation (  )  const [virtual]
Returns:
whether the contents of the location edit are kept when changing directories.

Implements KAbstractFileWidget.

Definition at line 1917 of file kfilewidget.cpp.

KUrlComboBox * KFileWidget::locationEdit (  )  const [virtual]
Returns:
the combobox used to type the filename or full location of the file.

Implements KAbstractFileWidget.

Definition at line 2381 of file kfilewidget.cpp.

KFile::Modes KFileWidget::mode (  )  const [virtual]

Returns the mode of the filedialog.

See also:
setMode()

Implements KAbstractFileWidget.

Definition at line 1773 of file kfilewidget.cpp.

KPushButton * KFileWidget::okButton (  )  const [virtual]
Returns:
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.

Implements KAbstractFileWidget.

Definition at line 1891 of file kfilewidget.cpp.

KFileWidget::OperationMode KFileWidget::operationMode (  )  const [virtual]
Returns:
the current operation mode, Opening, Saving or Other. Default is Other.
See also:
operationMode
KFileWidget::OperationMode

Implements KAbstractFileWidget.

Definition at line 1948 of file kfilewidget.cpp.

void KFileWidget::resizeEvent ( QResizeEvent *  event  )  [protected, virtual]

Definition at line 1697 of file kfilewidget.cpp.

QString KFileWidget::selectedFile (  )  const [virtual]

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

(Local files only)

Implements KAbstractFileWidget.

Definition at line 1648 of file kfilewidget.cpp.

QStringList KFileWidget::selectedFiles (  )  const [virtual]

Returns a list of all selected local files.

Implements KAbstractFileWidget.

Definition at line 1665 of file kfilewidget.cpp.

KUrl KFileWidget::selectedUrl (  )  const [virtual]
Returns:
The selected fully qualified filename.

Implements KAbstractFileWidget.

Definition at line 1531 of file kfilewidget.cpp.

KUrl::List KFileWidget::selectedUrls (  )  const [virtual]
Returns:
The list of selected URLs.

Implements KAbstractFileWidget.

Definition at line 1541 of file kfilewidget.cpp.

void KFileWidget::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 KFileWidget::setCustomWidget ( const QString &  text,
QWidget *  widget 
) [virtual]

Sets a custom widget that should be added below the location and the filter editors.

Parameters:
text Label of the custom widget, which is displayed below the labels "Location:" and "Filter:".
widget 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.

Implements KAbstractFileWidget.

Definition at line 2610 of file kfilewidget.cpp.

void KFileWidget::setCustomWidget ( QWidget *  widget  )  [virtual]

Set a custom widget that should be added to the file dialog.

Parameters:
widget A widget, or a widget of widgets, for displaying custom data in the file widget. 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 KFileWidget.

Implements KAbstractFileWidget.

Definition at line 2588 of file kfilewidget.cpp.

void KFileWidget::setFilter ( const QString &  filter  )  [virtual]

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

Implements KAbstractFileWidget.

Definition at line 632 of file kfilewidget.cpp.

void KFileWidget::setKeepLocation ( bool  keep  )  [virtual]

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 KFileWidget::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.

Implements KAbstractFileWidget.

Definition at line 1912 of file kfilewidget.cpp.

void KFileWidget::setLocationLabel ( const QString &  text  )  [virtual]

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.

Implements KAbstractFileWidget.

Definition at line 627 of file kfilewidget.cpp.

void KFileWidget::setMimeFilter ( const QStringList &  types,
const QString &  defaultType = QString() 
) [virtual]

Sets the filter up to specify the output type.

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.

Do not use in conjunction with setFilter()

Implements KAbstractFileWidget.

Definition at line 667 of file kfilewidget.cpp.

void KFileWidget::setMode ( KFile::Modes  m  )  [virtual]

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::Modes mode = KFile::Files |
                     KFile::ExistingOnly |
                     KFile::LocalOnly );
 setMode( mode );

Implements KAbstractFileWidget.

Definition at line 1758 of file kfilewidget.cpp.

void KFileWidget::setOperationMode ( OperationMode  mode  )  [virtual]

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( KFileWidget::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 KFileWidget.

See also:
operationMode
KFileWidget::OperationMode

Implements KAbstractFileWidget.

Definition at line 1922 of file kfilewidget.cpp.

void KFileWidget::setPreviewWidget ( KPreviewWidgetBase *  w  )  [virtual]

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 KFileWidget. You need to create the preview-widget with "new", i.e. on the heap.

Parameters:
w The widget to be used for the preview.

Implements KAbstractFileWidget.

Definition at line 707 of file kfilewidget.cpp.

void KFileWidget::setSelection ( const QString &  name  )  [virtual]

Sets the file name to preselect to name.

This takes absolute URLs and relative file names.

Implements KAbstractFileWidget.

Definition at line 1457 of file kfilewidget.cpp.

void KFileWidget::setStartDir ( const KUrl &  directory  )  [static]

For internal use only.

Used by KDirSelectDialog to share the dialog's start directory.

Definition at line 2561 of file kfilewidget.cpp.

void KFileWidget::setUrl ( const KUrl &  url,
bool  clearforward = true 
) [virtual]

Sets the directory to view.

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

Implements KAbstractFileWidget.

Definition at line 1368 of file kfilewidget.cpp.

void KFileWidget::showEvent ( QShowEvent *  event  )  [protected, virtual]

Definition at line 1711 of file kfilewidget.cpp.

void KFileWidget::slotCancel (  )  [virtual, slot]

Implements KAbstractFileWidget.

Definition at line 1902 of file kfilewidget.cpp.

void KFileWidget::slotOk (  )  [virtual, slot]

Called when clicking ok (when this widget is used in KFileDialog) Might or might not call accept().

Logic of the next part of code (ends at "end multi relative urls").

We allow for instance to be at "/" and insert '"home/foo/bar.txt" "boot/grub/menu.lst"'. Why we need to support this ? Because we provide tree views, which aren't plain.

Now, how does this logic work. It will get the first element on the list (with no filename), following the previous example say "/home/foo" and set it as the top most url.

After this, it will iterate over the rest of items and check if this URL (topmost url) contains the url being iterated.

As you might have guessed it will do "/home/foo" against "/boot/grub" (again stripping filename), and a false will be returned. Then we upUrl the top most url, resulting in "/home" against "/boot/grub", what will again return false, so we upUrl again. Now we have "/" against "/boot/grub", what returns true for us, so we can say that the closest common ancestor of both is "/".

This example has been written for 2 urls, but this works for any number of urls.

end multi relative urls

Implements KAbstractFileWidget.

Definition at line 737 of file kfilewidget.cpp.

KToolBar * KFileWidget::toolBar (  )  const [virtual]

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

Implements KAbstractFileWidget.

Definition at line 2583 of file kfilewidget.cpp.

void KFileWidget::virtual_hook ( int  id,
void *  data 
) [virtual]

For internal use only.

for future extensions

Implements KAbstractFileWidget.

Definition at line 2621 of file kfilewidget.cpp.


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

KFile

Skip menu "KFile"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal