#include <kfilewidget.h>

Inheritance diagram for KFileWidget:

Public Slots
virtual void	accept ()

virtual void	slotCancel ()

virtual void	slotOk ()

Signals
void	accepted ()

void	fileHighlighted (const KUrl &)

QT_MOC_COMPAT void	fileHighlighted (const QString &)

void	fileSelected (const KUrl &)

QT_MOC_COMPAT void	fileSelected (const QString &)

void	filterChanged (const QString &filter)

void	selectionChanged ()

Public Member Functions
	KFileWidget (const KUrl &startDir, QWidget *parent)

virtual	~KFileWidget ()

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

KUrlComboBox *	locationEdit () const

virtual KFile::Modes	mode () const

KPushButton *	okButton () const

virtual OperationMode	operationMode () const

void	readConfig (KConfigGroup &group)

virtual QString	selectedFile () const

virtual QStringList	selectedFiles () const

virtual KUrl	selectedUrl () const

virtual KUrl::List	selectedUrls () const

virtual void	setCustomWidget (QWidget *widget)

virtual void	setCustomWidget (const QString &text, 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)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

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

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) 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 (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

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

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

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > 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

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

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

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () 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 (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (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

virtual QSize	minimumSizeHint () 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 (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) 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 (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

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

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

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

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

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

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	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

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	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

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

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

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 (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

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

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > 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 (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

virtual QSize	sizeHint () 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

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

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

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

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)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

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

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

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

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

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

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

Public Member Functions inherited from KAbstractFileWidget
virtual	~KAbstractFileWidget ()

virtual void	accept ()=0

void	setConfirmOverwrite (bool enable)

void	setInlinePreviewShown (bool show)

virtual void	slotCancel ()=0

virtual void	slotOk ()=0

Static Public Member Functions
static KUrl	getStartUrl (const KUrl &startDir, QString &recentDirClass)

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

static void	setStartDir (const KUrl &directory)

Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

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

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

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char 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)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Protected Member Functions
virtual bool	eventFilter (QObject watched, QEvent event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

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

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *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 bool	event (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef 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 void	paintEvent (QPaintEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Additional Inherited Members
Public Types inherited from KAbstractFileWidget
enum	OperationMode

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

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

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

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 319 of file kfilewidget.cpp.

KFileWidget::~KFileWidget ( )

virtual

Destructor.

Definition at line 648 of file kfilewidget.cpp.

Member Function Documentation

void KFileWidget::accept ( )

virtualslot

Definition at line 1011 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 2469 of file kfilewidget.cpp.

KUrl KFileWidget::baseUrl ( ) const

virtual

Returns: the currently shown directory.

Implements KAbstractFileWidget.

Definition at line 1744 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 1949 of file kfilewidget.cpp.

void KFileWidget::clearFilter ( )

virtual

Clears any mime- or namefilter.

Does not reload the directory.

Implements KAbstractFileWidget.

Definition at line 712 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 691 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 731 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 722 of file kfilewidget.cpp.

KDirOperator * KFileWidget::dirOperator ( )

Returns: the KDirOperator used to navigate the filesystem

Since: 4.3

Definition at line 2743 of file kfilewidget.cpp.

bool KFileWidget::eventFilter	(	QObject *	watched,
		QEvent *	event
	)

protectedvirtual

Reimplemented from QObject.

Definition at line 1777 of file kfilewidget.cpp.

void KFileWidget::fileHighlighted ( const KUrl & )

signal

Emitted when the user highlights a file.

Since: 4.4

QT_MOC_COMPAT void KFileWidget::fileHighlighted ( const QString & )

signal

Deprecated:: , connect to fileSelected(const KUrl&) instead

void KFileWidget::fileSelected ( const KUrl & )

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

Since: 4.4

QT_MOC_COMPAT void KFileWidget::fileSelected ( const QString & )

signal

Deprecated:: , connect to fileSelected(const KUrl&) instead

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 2464 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 2558 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 2567 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 1969 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 2459 of file kfilewidget.cpp.

KFile::Modes KFileWidget::mode ( ) const

virtual

Returns the mode of the filedialog.

See also: setMode()

Implements KAbstractFileWidget.

Definition at line 1823 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 1944 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 2000 of file kfilewidget.cpp.

void KFileWidget::readConfig ( KConfigGroup & group )

reads the configuration for this widget from the given config group

Parameters

group the KConfigGroup to read from

Since: 4.4

Definition at line 2748 of file kfilewidget.cpp.

void KFileWidget::resizeEvent ( QResizeEvent * event )

protectedvirtual

Reimplemented from QWidget.

Definition at line 1749 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 1700 of file kfilewidget.cpp.

QStringList KFileWidget::selectedFiles ( ) const

virtual

Returns a list of all selected local files.

Implements KAbstractFileWidget.

Definition at line 1717 of file kfilewidget.cpp.

KUrl KFileWidget::selectedUrl ( ) const

virtual

Returns: The selected fully qualified filename.

Implements KAbstractFileWidget.

Definition at line 1583 of file kfilewidget.cpp.

KUrl::List KFileWidget::selectedUrls ( ) const

virtual

Returns: The list of selected URLs.

Implements KAbstractFileWidget.

Definition at line 1593 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 ( 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 2687 of file kfilewidget.cpp.

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

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 661 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 1964 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 656 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 696 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 1808 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 1974 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 736 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 1509 of file kfilewidget.cpp.

void KFileWidget::setStartDir ( const KUrl & directory )

static

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

Definition at line 2660 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 1420 of file kfilewidget.cpp.

void KFileWidget::showEvent ( QShowEvent * event )

protectedvirtual

Reimplemented from QWidget.

Definition at line 1763 of file kfilewidget.cpp.

void KFileWidget::slotCancel ( )

virtualslot

Definition at line 1955 of file kfilewidget.cpp.

void KFileWidget::slotOk ( )

virtualslot

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

Definition at line 766 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 2682 of file kfilewidget.cpp.

void KFileWidget::virtual_hook	(	int	id,
		void *	data
	)

virtual

for future extensions

Implements KAbstractFileWidget.

Definition at line 2720 of file kfilewidget.cpp.

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

KFile

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KFile

kdelibs API Reference

Search