KDELibs4Support

View on LXR

#include <kfiledialog.h>

Inheritance diagram for KFileDialog:

[legend]

Public Types
enum	OperationMode { Other = 0, Opening, Saving }

enum	Option { ConfirmOverwrite = 0x01, ShowInlinePreview = 0x02 }

Signals
void	fileHighlighted (const QUrl &)

void	fileSelected (const QUrl &)

void	filterChanged (const QString &filter)

void	selectionChanged ()

Public Member Functions
	KFileDialog (const QUrl &startDir, const QString &filter, QWidget parent, QWidget widget=nullptr)

	~KFileDialog ()

KActionCollection *	actionCollection () const

QUrl	baseUrl () const

QPushButton *	cancelButton () const

void	clearFilter ()

QString	currentFilter () const

QMimeType	currentFilterMimeType ()

QString	currentMimeFilter () const

KFileWidget *	fileWidget ()

KFileFilterCombo *	filterWidget () const

bool	keepsLocation () const

KUrlComboBox *	locationEdit () const

KFile::Modes	mode () const

QPushButton *	okButton () const

OperationMode	operationMode () const

QString	selectedFile () const

QStringList	selectedFiles () const

QUrl	selectedUrl () const

QList< QUrl >	selectedUrls () const

void	setConfirmOverwrite (bool enable)

void	setFilter (const QString &filter)

void	setInlinePreviewShown (bool show)

void	setKeepLocation (bool keep)

void	setLocationLabel (const QString &text)

void	setMimeFilter (const QStringList &types, const QString &defaultType=QString())

void	setMode (KFile::Modes m)

void	setOperationMode (KFileDialog::OperationMode)

void	setPreviewWidget (KPreviewWidgetBase *w)

void	setSelection (const QString &name)

void	setUrl (const QUrl &url, bool clearforward=true)

QSize	sizeHint () const override

KToolBar *	toolBar () const

Public Member Functions inherited from QDialog
	QDialog (QWidget *parent, Qt::WindowFlags f)

virtual void	accept ()

void	accepted ()

virtual void	done (int r)

virtual int	exec ()

QWidget *	extension () const

void	finished (int result)

bool	isSizeGripEnabled () const

virtual QSize	minimumSizeHint () const

virtual void	open ()

Qt::Orientation	orientation () const

virtual void	reject ()

void	rejected ()

int	result () const

void	setExtension (QWidget *extension)

void	setModal (bool modal)

void	setOrientation (Qt::Orientation orientation)

void	setResult (int i)

void	setSizeGripEnabled (bool)

virtual void	setVisible (bool visible)

void	showExtension (bool showIt)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

QPalette::ColorRole	backgroundRole () const

QBackingStore *	backingStore () const

QSize	baseSize () const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const

void	ensurePolished () const

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

virtual bool	hasHeightForWidth () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isEnabled () const

bool	isEnabledTo (const QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isTopLevel () const

bool	isVisible () const

bool	isVisibleTo (const QWidget *ancestor) const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget () const

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

QRect	rect () const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (int basew, int baseh)

void	setBaseSize (const QSize &)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setParent (QWidget *parent)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

int	toolTipDuration () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QWindow *	windowHandle () const

QIcon	windowIcon () const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QString	windowTitle () const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
int	colorCount () const

int	depth () const

int	devicePixelRatio () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

Static Public Member Functions
static QString	getExistingDirectory (const QUrl &startDir=QUrl(), QWidget *parent=nullptr, const QString &caption=QString())

static QUrl	getExistingDirectoryUrl (const QUrl &startDir=QUrl(), QWidget *parent=nullptr, const QString &caption=QString())

static QUrl	getImageOpenUrl (const QUrl &startDir=QUrl(), QWidget *parent=nullptr, const QString &caption=QString())

static QString	getOpenFileName (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString())

static QStringList	getOpenFileNames (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString())

static QString	getOpenFileNameWId (const QUrl &startDir, const QString &filter, WId parent_id, const QString &caption)

static QUrl	getOpenUrl (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString())

static QList< QUrl >	getOpenUrls (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString())

static QString	getSaveFileName (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString())

static QString	getSaveFileName (const QUrl &startDir, const QString &filter, QWidget *parent, const QString &caption, Options options)

static QString	getSaveFileNameWId (const QUrl &startDir, const QString &filter, WId parent_id, const QString &caption)

static QString	getSaveFileNameWId (const QUrl &startDir, const QString &filter, WId parent_id, const QString &caption, Options options)

static QUrl	getSaveUrl (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString())

static QUrl	getSaveUrl (const QUrl &startDir, const QString &filter, QWidget *parent, const QString &caption, Options options)

static QUrl	getStartUrl (const QUrl &startDir, QString &recentDirClass)

static void	setStartDir (const QUrl &directory)

Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Slots
void	accept () override

virtual void	slotCancel ()

virtual void	slotOk ()

Protected Member Functions
void	hideEvent (QHideEvent *event) override

void	keyPressEvent (QKeyEvent *e) override

Protected Member Functions inherited from QDialog
virtual void	closeEvent (QCloseEvent *e)

virtual void	contextMenuEvent (QContextMenuEvent *e)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject o, QEvent e)

virtual void	resizeEvent (QResizeEvent *)

virtual void	showEvent (QShowEvent *event)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	initPainter (QPainter *painter) const

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, long result)

virtual void	paintEvent (QPaintEvent *event)

virtual QPaintDevice *	redirected (QPoint *offset) const

virtual QPainter *	sharedPainter () const

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Properties inherited from QDialog
	modal

	sizeGripEnabled

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Public Attributes inherited from QWidget
typedef	RenderFlags

Detailed Description

A file selection dialog.

Warning: This class should be avoided in new code. QFileDialog should be used instead.

See also: QFileDialog

Provides 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 customize 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

Deprecated:: since 5.0, use the QFileDialog API instead. Note that when the KDE QPA theme plugin is installed, the KFileWidget will then be used automatically.

Definition at line 74 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 91 of file kfiledialog.h.

enum KFileDialog::Option

Defines the options to use when calling getSave* functions.

Since: 4.4

Enumerator
ConfirmOverwrite	Confirm whether to overwrite file to save.
ShowInlinePreview	Always show an inline preview.

Definition at line 97 of file kfiledialog.h.

Constructor & Destructor Documentation

KFileDialog::KFileDialog	(	const QUrl &	startDir,
		const QString &	filter,
		QWidget *	parent,
		QWidget *	widget = `nullptr`
	)

Constructs a file dialog.

Parameters

startDir	Specifies the starting directory and/or initially selected file name, or a last used directory and optional file name using the `kfiledialog:///` syntax. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. For better consistency across applications, it is recommended to use a mimetype filter. See setFilter() and setMimeFilter() for details on how to use this argument.
parent	The parent widget of this dialog
widget	A 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.

See also: KFileWidget::KFileWidget()

Definition at line 240 of file kfiledialog.cpp.

KFileDialog::~KFileDialog ( )

Destructs the file dialog.

Definition at line 296 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 901 of file kfiledialog.cpp.

QUrl KFileDialog::baseUrl ( ) const

Returns: the currently shown directory.

Definition at line 689 of file kfiledialog.cpp.

QPushButton * 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 877 of file kfiledialog.cpp.

void KFileDialog::clearFilter ( )

Clears any mime- or namefilter.

Does not reload the directory.

Definition at line 340 of file kfiledialog.cpp.

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

QMimeType KFileDialog::currentFilterMimeType ( )

Returns the mimetype for the desired output format.

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

See also: setFilterMimeType()

Definition at line 362 of file kfiledialog.cpp.

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

void KFileDialog::fileHighlighted ( const QUrl & )

signal

Emitted when the user highlights a file.

Since: 4.4

void KFileDialog::fileSelected ( const QUrl & )

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 accepted() signal inherited from QDialog and call selectedFile(), selectedFiles(), selectedUrl() or selectedUrls().

Since: 4.4

KFileWidget * KFileDialog::fileWidget ( )

Returns the KFileWidget that implements most of this file dialog.

If you link to libkfile you can cast this to a KFileWidget*.

Definition at line 985 of file kfiledialog.cpp.

void KFileDialog::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 * KFileDialog::filterWidget ( ) const

Returns: the combobox that contains the filters You need to link to libkfile to use this widget.

Definition at line 893 of file kfiledialog.cpp.

QString KFileDialog::getExistingDirectory	(	const QUrl &	startDir = `QUrl()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

static

Creates a modal directory-selection dialog and returns the selected directory (local only) or an empty string if none was chosen.

Parameters

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

Returns: the path to an existing local directory.

See also: KFileWidget::KFileWidget()

Deprecated:: use QFileDialog::getExistingDirectory(parent, caption, startDir)

Definition at line 614 of file kfiledialog.cpp.

QUrl KFileDialog::getExistingDirectoryUrl	(	const QUrl &	startDir = `QUrl()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

static

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

This version supports remote urls.

Parameters

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

Returns: the url to an existing directory (local or remote).

See also: KFileWidget::KFileWidget()

Deprecated:: use QFileDialog::getExistingDirectoryUrl(parent, caption, startDir)

Definition at line 607 of file kfiledialog.cpp.

QUrl KFileDialog::getImageOpenUrl	(	const QUrl &	startDir = `QUrl()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

static

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

Parameters

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

See also: KFileWidget::KFileWidget()

Definition at line 630 of file kfiledialog.cpp.

QString KFileDialog::getOpenFileName	(	const QUrl &	startDir = `QUrl()`,
		const QString &	filter = `QString()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

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

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

See also: KFileWidget::KFileWidget()

Deprecated:: use QFileDialog::getOpenFileName(parent, caption, startDir, filter)

Definition at line 439 of file kfiledialog.cpp.

QStringList KFileDialog::getOpenFileNames	(	const QUrl &	startDir = `QUrl()`,
		const QString &	filter = `QString()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

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

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

See also: KFileWidget::KFileWidget()

Deprecated:: use QFileDialog::getOpenFileNames(parent, caption, startDir, filter)

Definition at line 498 of file kfiledialog.cpp.

QString KFileDialog::getOpenFileNameWId	(	const QUrl &	startDir,
		const QString &	filter,
		WId	parent_id,
		const QString &	caption
	)

static

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

QUrl KFileDialog::getOpenUrl	(	const QUrl &	startDir = `QUrl()`,
		const QString &	filter = `QString()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

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

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

See also: KFileWidget::KFileWidget()

Deprecated:: use QFileDialog::getOpenFileUrl(parent, caption, startDir, filter)

Definition at line 534 of file kfiledialog.cpp.

QList< QUrl > KFileDialog::getOpenUrls	(	const QUrl &	startDir = `QUrl()`,
		const QString &	filter = `QString()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

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

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

See also: KFileWidget::KFileWidget()

Deprecated:: use QFileDialog::getOpenFileUrls(parent, caption, startDir, filter)

Definition at line 562 of file kfiledialog.cpp.

QString KFileDialog::getSaveFileName	(	const QUrl &	startDir = `QUrl()`,
		const QString &	filter = `QString()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

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

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

See also: KFileWidget::KFileWidget()

Deprecated:: use QFileDialog::getSaveFileName(parent, caption, startDir, filter)

Definition at line 697 of file kfiledialog.cpp.

QString KFileDialog::getSaveFileName	(	const QUrl &	startDir,
		const QString &	filter,
		QWidget *	parent,
		const QString &	caption,
		Options	options
	)

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

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.
options	Dialog options.

See also: KFileWidget::KFileWidget()

Since: 4.4

Deprecated:: use QFileDialog::getSaveFileName(parent, caption, startDir, filter, [selectedFilter], options)

Definition at line 706 of file kfiledialog.cpp.

QString KFileDialog::getSaveFileNameWId	(	const QUrl &	startDir,
		const QString &	filter,
		WId	parent_id,
		const QString &	caption
	)

static

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

It should be used only when necessary.

Definition at line 766 of file kfiledialog.cpp.

QString KFileDialog::getSaveFileNameWId	(	const QUrl &	startDir,
		const QString &	filter,
		WId	parent_id,
		const QString &	caption,
		Options	options
	)

static

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

It should be used only when necessary.

Since: 4.4

Definition at line 775 of file kfiledialog.cpp.

QUrl KFileDialog::getSaveUrl	(	const QUrl &	startDir = `QUrl()`,
		const QString &	filter = `QString()`,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`
	)

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

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.

See also: KFileWidget::KFileWidget()

Deprecated:: use QFileDialog::getSaveFileUrl(parent, caption, startDir, filter)

Definition at line 806 of file kfiledialog.cpp.

QUrl KFileDialog::getSaveUrl	(	const QUrl &	startDir,
		const QString &	filter,
		QWidget *	parent,
		const QString &	caption,
		Options	options
	)

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

startDir	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
filter	A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details.
parent	The widget the dialog will be centered on initially.
caption	The name of the dialog widget.
options	Dialog options.

See also: KFileWidget::KFileWidget()

Since: 4.4

Deprecated:: use QFileDialog::getSaveFileUrl(parent, caption, startDir, filter, [selectedFilter], options)

Definition at line 814 of file kfiledialog.cpp.

QUrl KFileDialog::getStartUrl	(	const QUrl &	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	Starting directory or `kfiledialog:///` URL. Refer to the KFileWidget documentation for more information on this parameter.
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(); KFileWidget::getStartUrl(const QUrl& startDir, QString& recentDirClass);

Definition at line 963 of file kfiledialog.cpp.

void KFileDialog::hideEvent ( QHideEvent * event )

overrideprotectedvirtual

Reimplemented for saving the dialog geometry.

Reimplemented from QWidget.

Definition at line 953 of file kfiledialog.cpp.

bool KFileDialog::keepsLocation ( ) const

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

Definition at line 916 of file kfiledialog.cpp.

void KFileDialog::keyPressEvent ( QKeyEvent * e )

overrideprotectedvirtual

Reimplemented to animate the cancel button.

Reimplemented from QDialog.

Definition at line 941 of file kfiledialog.cpp.

KUrlComboBox * KFileDialog::locationEdit ( ) const

Returns: the combobox used to type the filename or full location of the file. You need to link to libkfile to use this widget.

Definition at line 885 of file kfiledialog.cpp.

KFile::Modes KFileDialog::mode ( ) const

Returns the mode of the filedialog.

See also: setMode()

Definition at line 861 of file kfiledialog.cpp.

QPushButton * 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 869 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 933 of file kfiledialog.cpp.

QString KFileDialog::selectedFile ( ) const

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

(Local files only)

Definition at line 667 of file kfiledialog.cpp.

QStringList KFileDialog::selectedFiles ( ) const

Returns a list of all selected local files.

Definition at line 675 of file kfiledialog.cpp.

QUrl KFileDialog::selectedUrl ( ) const

Returns: The selected fully qualified filename.

Definition at line 651 of file kfiledialog.cpp.

QList< QUrl > KFileDialog::selectedUrls ( ) const

Returns: The list of selected URLs.

Definition at line 659 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::setConfirmOverwrite ( bool enable )

Sets whether the dialog should ask before accepting the selected file when KFileDialog::OperationMode is set to Saving.

In this case a KMessageBox appears for confirmation.

Parameters

enable Set this to true to enable checking.

Since: 4.2

Definition at line 600 of file kfiledialog.cpp.

void KFileDialog::setFilter ( const QString & filter )

Sets the filter to be used to filter.

The filter can be either set as a space-separated list of mimetypes, which is recommended, or as a list of shell globs separated by '\n'.

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

When showing the filter to the user, the mimetypes will be automatically translated into their description like `PNG image'. Multiple mimetypes will be automatically summarized to a filter item `All supported files'. To add a filter item for all files matching '*', add application/octet-stream as mimetype.

If the filter contains no unescaped '/', it is assumed that the filter contains conventional shell globs. Several filter items to select from can be separated by '\n'. Every filter entry is defined through namefilter|text to display. 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.

For better consistency across applications, it is recommended to use a mimetype filter.

See also: filterChanged; setMimeFilter

Definition at line 308 of file kfiledialog.cpp.

void KFileDialog::setInlinePreviewShown ( bool show )

Forces the inline previews to be shown or hidden, depending on show.

Parameters

show	Whether to show inline previews or not.

Since: 4.2

Definition at line 375 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 909 of file kfiledialog.cpp.

void KFileDialog::setLocationLabel ( const QString & 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 301 of file kfiledialog.cpp.

void KFileDialog::setMimeFilter	(	const QStringList &	types,
		const QString &	defaultType = `QString()`
	)

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

Definition at line 325 of file kfiledialog.cpp.

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

Definition at line 852 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 924 of file kfiledialog.cpp.

void KFileDialog::setPreviewWidget ( 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

w	The widget to be used for the preview.

Definition at line 368 of file kfiledialog.cpp.

void KFileDialog::setSelection ( const QString & name )

Sets the file name to preselect to name.

This takes absolute URLs and relative file names.

Definition at line 429 of file kfiledialog.cpp.

void KFileDialog::setStartDir ( const QUrl & directory )

static

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

Definition at line 969 of file kfiledialog.cpp.

void KFileDialog::setUrl	(	const QUrl &	url,
		bool	clearforward = `true`
	)

Sets the directory to view.

Parameters

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

Definition at line 419 of file kfiledialog.cpp.

QSize KFileDialog::sizeHint ( void ) const

overridevirtual

See also: QWidget::sizeHint()

Reimplemented from QDialog.

Definition at line 383 of file kfiledialog.cpp.

KToolBar * KFileDialog::toolBar ( ) const

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

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

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation