KIO

KAbstractFileWidget Class Reference

#include <kabstractfilewidget.h>

Detailed Description

Definition at line 41 of file kabstractfilewidget.h.


Public Types
enum	OperationMode { Other = 0, Opening, Saving }
Public Member Functions
virtual	~KAbstractFileWidget ()
virtual KUrl	selectedUrl () const =0
virtual KUrl::List	selectedUrls () const =0
virtual KUrl	baseUrl () const =0
virtual QString	selectedFile () const =0
virtual QStringList	selectedFiles () const =0
virtual void	setUrl (const KUrl &url, bool clearforward=true)=0
virtual void	setSelection (const QString &name)=0
virtual void	setOperationMode (OperationMode)=0
virtual OperationMode	operationMode () const =0
virtual void	setKeepLocation (bool keep)=0
virtual bool	keepsLocation () const =0
virtual void	setFilter (const QString &filter)=0
virtual QString	currentFilter () const =0
virtual KMimeType::Ptr	currentFilterMimeType ()=0
virtual void	setMimeFilter (const QStringList &types, const QString &defaultType=QString())=0
virtual QString	currentMimeFilter () const =0
virtual void	clearFilter ()=0
virtual void	setPreviewWidget (KPreviewWidgetBase *w)=0
virtual void	setMode (KFile::Modes m)=0
virtual KFile::Modes	mode () const =0
virtual void	setLocationLabel (const QString &text)=0
virtual KToolBar *	toolBar () const =0
virtual KPushButton *	okButton () const =0
virtual KPushButton *	cancelButton () const =0
virtual KUrlComboBox *	locationEdit () const =0
virtual KFileFilterCombo *	filterWidget () const =0
virtual KActionCollection *	actionCollection () const =0
virtual void	setCustomWidget (QWidget *widget)=0
virtual void	setCustomWidget (const QString &text, QWidget *widget)=0
virtual void	slotOk ()=0
virtual void	accept ()=0
virtual void	slotCancel ()=0
virtual void	virtual_hook (int id, void *data)=0

Member Enumeration Documentation

enum KAbstractFileWidget::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

Enumerator:

Other
Opening
Saving

Definition at line 57 of file kabstractfilewidget.h.

Constructor & Destructor Documentation

virtual KAbstractFileWidget::~KAbstractFileWidget ( ) [inline, virtual]

Definition at line 44 of file kabstractfilewidget.h.

Member Function Documentation

virtual KUrl KAbstractFileWidget::selectedUrl ( ) const [pure virtual]

Returns:: The selected fully qualified filename.

virtual KUrl::List KAbstractFileWidget::selectedUrls ( ) const [pure virtual]

Returns:: The list of selected URLs.

virtual KUrl KAbstractFileWidget::baseUrl ( ) const [pure virtual]

Returns:: the currently shown directory.

virtual QString KAbstractFileWidget::selectedFile ( ) const [pure virtual]

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

(Local files only)

virtual QStringList KAbstractFileWidget::selectedFiles ( ) const [pure virtual]

Returns a list of all selected local files.

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

Sets the directory to view.

Parameters:

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

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

Sets the file name to preselect to name.

This takes absolute URLs and relative file names.

virtual void KAbstractFileWidget::setOperationMode ( OperationMode ) [pure 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( 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

virtual OperationMode KAbstractFileWidget::operationMode ( ) const [pure virtual]

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

Default is Other.

See also:: operationMode
KFileDialog::OperationMode

virtual void KAbstractFileWidget::setKeepLocation ( bool keep ) [pure 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 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.

virtual bool KAbstractFileWidget::keepsLocation ( ) const [pure virtual]

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

virtual void KAbstractFileWidget::setFilter ( const QString & filter ) [pure 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

virtual QString KAbstractFileWidget::currentFilter ( ) const [pure virtual]

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

See also:: setFilter()
filterChanged()

virtual KMimeType::Ptr KAbstractFileWidget::currentFilterMimeType ( ) [pure virtual]

Returns the mimetype for the desired output format.

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

See also:: setFilterMimeType()

virtual void KAbstractFileWidget::setMimeFilter	(	const QStringList &	types,
		const QString &	defaultType = `QString()`
	)			`[pure 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()

virtual QString KAbstractFileWidget::currentMimeFilter ( ) const [pure virtual]

The mimetype for the desired output format.

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

See also:: setMimeFilter()

virtual void KAbstractFileWidget::clearFilter ( ) [pure virtual]

Clears any mime- or namefilter.

Does not reload the directory.

virtual void KAbstractFileWidget::setPreviewWidget ( KPreviewWidgetBase * w ) [pure 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 KFileDialog. You need to create the preview-widget with "new", i.e. on the heap.

Parameters:

The widget to be used for the preview.

virtual void KAbstractFileWidget::setMode ( KFile::Modes m ) [pure 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 );

virtual KFile::Modes KAbstractFileWidget::mode ( ) const [pure virtual]

Returns the mode of the filedialog.

See also:: setMode()

virtual void KAbstractFileWidget::setLocationLabel ( const QString & text ) [pure 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.

virtual KToolBar* KAbstractFileWidget::toolBar ( ) const [pure 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() );

virtual KPushButton* KAbstractFileWidget::okButton ( ) const [pure 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.

virtual KPushButton* KAbstractFileWidget::cancelButton ( ) const [pure 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.

virtual KUrlComboBox* KAbstractFileWidget::locationEdit ( ) const [pure virtual]

Returns:: the combobox used to type the filename or full location of the file.

virtual KFileFilterCombo* KAbstractFileWidget::filterWidget ( ) const [pure virtual]

Returns:: the combobox that contains the filters

virtual KActionCollection* KAbstractFileWidget::actionCollection ( ) const [pure virtual]

Returns:: a pointer to the action collection, holding all the used KActions.

virtual void KAbstractFileWidget::setCustomWidget ( QWidget * widget ) [pure virtual]

Set a custom widget that should be added to the bottom of 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.

virtual void KAbstractFileWidget::setCustomWidget	(	const QString &	text,
		QWidget *	widget
	)			`[pure 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.

virtual void KAbstractFileWidget::slotOk ( ) [pure virtual]

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

virtual void KAbstractFileWidget::accept ( ) [pure virtual]

virtual void KAbstractFileWidget::slotCancel ( ) [pure virtual]

virtual void KAbstractFileWidget::virtual_hook	(	int	id,
		void *	data
	)			`[pure virtual]`

The documentation for this class was generated from the following file:

kabstractfilewidget.h

KIO

KAbstractFileWidget Class Reference

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

KIO

kdelibs