KUrlRequester Class Reference

#include <kurlrequester.h>

Inheritance diagram for KUrlRequester:

Public Slots
void	clear ()
void	setPath (const QString &path)
void	setStartDir (const KUrl &startDir)
void	setText (const QString &text)
void	setUrl (const KUrl &url)

Signals
void	openFileDialog (KUrlRequester *)
void	returnPressed ()
void	returnPressed (const QString &)
void	textChanged (const QString &)
void	urlSelected (const KUrl &)

Public Member Functions
	KUrlRequester (QWidget *parent=0)
	KUrlRequester (const KUrl &url, QWidget *parent=0)
	KUrlRequester (QWidget *editWidget, QWidget *parent)
	~KUrlRequester ()
KPushButton *	button () const
QString	clickMessage () const
KComboBox *	comboBox () const
KUrlCompletion *	completionObject () const
const KEditListBox::CustomEditor &	customEditor ()
virtual KFileDialog *	fileDialog () const
Qt::WindowModality	fileDialogModality () const
QString	filter () const
KLineEdit *	lineEdit () const
KFile::Modes	mode () const
void	setClickMessage (const QString &msg)
void	setFileDialogModality (Qt::WindowModality modality)
void	setFilter (const QString &filter)
void	setMode (KFile::Modes m)
KUrl	startDir () const
QString	text () const
KUrl	url () const
Public Member Functions inherited from KHBox
	KHBox (QWidget *parent=0)
	~KHBox ()
virtual QSize	minimumSizeHint () const
void	setMargin (int margin)
void	setSpacing (int space)
void	setStretchFactor (QWidget *widget, int stretch)
virtual QSize	sizeHint () const

Protected Member Functions
virtual void	changeEvent (QEvent *e)
bool	eventFilter (QObject *obj, QEvent *ev)
Protected Member Functions inherited from KHBox
	KHBox (bool vertical, QWidget *parent)
virtual void	childEvent (QChildEvent *ev)

Properties
QString	clickMessage
Qt::WindowModality	fileDialogModality
QString	filter
KFile::Modes	mode
QString	text
KUrl	url

Detailed Description

This class is a widget showing a lineedit and a button, which invokes a filedialog.

File name completion is available in the lineedit.

The defaults for the filedialog are to ask for one existing local file, i.e. KFileDialog::setMode( KFile::File | KFile::ExistingOnly | KFile::LocalOnly ) The default filter is "*", i.e. show all files, and the start directory is the current working directory, or the last directory where a file has been selected.

You can change this behavior by using setMode() or setFilter().

The default window modality for the file dialog is Qt::ApplicationModal

KDE URL Requester

A widget to request a filename/url from the user

Author

Carsten Pfeiffer pfeif.nosp@m.fer@.nosp@m.kde.o.nosp@m.rg

Definition at line 60 of file kurlrequester.h.

Constructor & Destructor Documentation

KUrlRequester::KUrlRequester ( QWidget *  parent = 0 )

explicit

Constructs a KUrlRequester widget.

Definition at line 207 of file kurlrequester.cpp.

KUrlRequester::KUrlRequester ( const KUrl &  url, QWidget *  parent = 0  )

explicit

Constructs a KUrlRequester widget with the initial URL url.

Definition at line 214 of file kurlrequester.cpp.

KUrlRequester::KUrlRequester	(	QWidget *	editWidget,
		QWidget *	parent
	)

Special constructor, which creates a KUrlRequester widget with a custom edit-widget.

The edit-widget can be either a KComboBox or a KLineEdit (or inherited thereof). Note: for geometry management reasons, the edit-widget is reparented to have the KUrlRequester as parent.

Definition at line 192 of file kurlrequester.cpp.

KUrlRequester::~KUrlRequester

(

)

Destructs the KUrlRequester.

Definition at line 221 of file kurlrequester.cpp.

Member Function Documentation

KPushButton * KUrlRequester::button

(

)

const

Returns

a pointer to the pushbutton. It is provided so that you can specify an own pixmap or a text, if you really need to.

Definition at line 468 of file kurlrequester.cpp.

void KUrlRequester::changeEvent ( QEvent *  e )

protectedvirtual

Definition at line 289 of file kurlrequester.cpp.

void KUrlRequester::clear ( )

slot

Clears the lineedit/combobox.

Definition at line 436 of file kurlrequester.cpp.

QString KUrlRequester::clickMessage

(

)

const

Returns

the message set with setClickMessage

Since

4.2

KComboBox * KUrlRequester::comboBox

(

)

const

Returns

a pointer to the combobox, in case you have set one using the special constructor. Returns 0L otherwise.

Definition at line 446 of file kurlrequester.cpp.

KUrlCompletion * KUrlRequester::completionObject

(

)

const

Returns

the KUrlCompletion object used in the lineedit/combobox.

Definition at line 473 of file kurlrequester.cpp.

const KEditListBox::CustomEditor & KUrlRequester::customEditor

(

)

Returns

an object, suitable for use with KEditListWidget. It allows you to put this KUrlRequester into a KEditListWidget. Basically, do it like this:

KUrlRequester *req = new KUrlRequester( someWidget );
[...]
KEditListWidget *editListWidget = new KEditListWidget( req->customEditor(), someWidget );

Definition at line 503 of file kurlrequester.cpp.

bool KUrlRequester::eventFilter ( QObject *  obj, QEvent *  ev  )

protected

Definition at line 457 of file kurlrequester.cpp.

KFileDialog * KUrlRequester::fileDialog ( ) const

virtual

Returns

a pointer to the filedialog. You can use this to customize the dialog, e.g. to call setLocationLabel or other things which are not accessible in the KUrlRequester API.

Never returns 0. This method creates the file dialog on demand.

Important: in "Directory only" mode, a KDirSelectDialog is used instead, so calling this method is useless.

Definition at line 422 of file kurlrequester.cpp.

Qt::WindowModality KUrlRequester::fileDialogModality

(

)

const

Returns

the window modality of the file dialog set with setFileDialogModality

Since

4.4

QString KUrlRequester::filter

(

)

const

Returns the current filter for the file dialog.

See also

KFileDialog::filter()

KLineEdit * KUrlRequester::lineEdit

(

)

const

Returns

a pointer to the lineedit, either the default one, or the special one, if you used the special constructor.

It is provided so that you can e.g. set an own completion object (e.g. KShellCompletion) into it.

Definition at line 441 of file kurlrequester.cpp.

KFile::Modes KUrlRequester::mode

(

)

const

Returns the current mode.

See also

KFileDialog::mode()

void KUrlRequester::openFileDialog ( KUrlRequester *  )

signal

Emitted before the filedialog is going to open.

Connect to this signal to "configure" the filedialog, e.g. set the filefilter, the mode, a preview-widget, etc. It's usually not necessary to set a URL for the filedialog, as it will get set properly from the editfield contents.

If you use multiple KUrlRequesters, you can connect all of them to the same slot and use the given KUrlRequester pointer to know which one is going to open.

void KUrlRequester::returnPressed ( )

signal

Emitted when return or enter was pressed in the lineedit.

void KUrlRequester::returnPressed ( const QString &  )

signal

Emitted when return or enter was pressed in the lineedit.

The parameter contains the contents of the lineedit.

void KUrlRequester::setClickMessage

(

const QString &

msg

)

Set a click message msg.

Since

4.2

Definition at line 478 of file kurlrequester.cpp.

void KUrlRequester::setFileDialogModality

(

Qt::WindowModality

modality

)

Set the window modality for the file dialog to modality Directory selection dialogs are always modal.

Since

4.4

Definition at line 497 of file kurlrequester.cpp.

void KUrlRequester::setFilter

(

const QString &

filter

)

Sets the filter for the file dialog.

See also

KFileDialog::setFilter()

Definition at line 409 of file kurlrequester.cpp.

void KUrlRequester::setMode

(

KFile::Modes

m

)

Sets the mode of the file dialog.

Note: you can only select one file with the filedialog, so KFile::Files doesn't make much sense.

See also

KFileDialog::setMode()

Definition at line 392 of file kurlrequester.cpp.

void KUrlRequester::setPath ( const QString &  path )

slot

Sets the url in the lineedit to KUrl::fromPath(path).

This is only for local paths; do not pass a url here. This method is mostly for "local paths only" url requesters, for instance those set up with setMode(KFile::File|KFile::ExistingOnly|KFile::LocalOnly)

Deprecated:

Use setUrl(KUrl(path)) instead.

Definition at line 271 of file kurlrequester.cpp.

void KUrlRequester::setStartDir ( const KUrl &  startDir )

slot

Sets the start dir startDir.

The start dir is only used when the URL isn't set.

Since

4.3

Definition at line 282 of file kurlrequester.cpp.

void KUrlRequester::setText ( const QString &  text )

slot

Sets the current text in the lineedit or combobox.

This is used for cases where KUrlRequester is used to enter URL-or-something-else, like KOpenWithDialog where you can type a full command with arguments.

See also

text

Since

4.3

Definition at line 277 of file kurlrequester.cpp.

void KUrlRequester::setUrl ( const KUrl &  url )

slot

Sets the url in the lineedit to url.

Definition at line 265 of file kurlrequester.cpp.

KUrl KUrlRequester::startDir

(

)

const

Returns

the current start dir

Since

4.3

Definition at line 304 of file kurlrequester.cpp.

QString KUrlRequester::text

(

)

const

Returns

the current text in the lineedit or combobox. This does not do the URL expansion that url() does, it's only provided for cases where KUrlRequester is used to enter URL-or-something-else, like KOpenWithDialog where you can type a full command with arguments.

Since

4.2

void KUrlRequester::textChanged ( const QString &  )

signal

Emitted when the text in the lineedit changes.

The parameter contains the contents of the lineedit.

KUrl KUrlRequester::url

(

)

const

Returns

the current url in the lineedit. May be malformed, if the user entered something weird. ~user or environment variables are substituted for local files.

void KUrlRequester::urlSelected ( const KUrl &  )

signal

Emitted when the user changed the URL via the file dialog.

The parameter contains the contents of the lineedit.

Property Documentation

QString KUrlRequester::clickMessage

readwrite

Definition at line 66 of file kurlrequester.h.

Qt::WindowModality KUrlRequester::fileDialogModality

readwrite

Definition at line 68 of file kurlrequester.h.

QString KUrlRequester::filter

readwrite

Definition at line 64 of file kurlrequester.h.

KFile::Modes KUrlRequester::mode

readwrite

Definition at line 65 of file kurlrequester.h.

QString KUrlRequester::text

readwrite

Definition at line 67 of file kurlrequester.h.

KUrl KUrlRequester::url

readwrite

Definition at line 63 of file kurlrequester.h.

---

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

• kurlrequester.h
• kurlrequester.cpp