---

KURLRequester Class Reference

A widget to request a filename/url from the user. More...

#include <kurlrequester.h>

List of all members.

Public Slots
void	setURL (const QString &url)
virtual void	setCaption (const QString &caption)
void	clear ()
Signals
void	textChanged (const QString &)
void	returnPressed ()
void	returnPressed (const QString &)
void	openFileDialog (KURLRequester *)
void	urlSelected (const QString &)
Public Methods
	KURLRequester (QWidget *parent=0, const char *name=0)
	KURLRequester (const QString &url, QWidget *parent=0, const char *name=0)
	KURLRequester (QWidget *editWidget, QWidget *parent, const char *name=0)
	~KURLRequester ()
QString	url () const
void	setShowLocalProtocol (bool b)
void	setMode (unsigned int m)
void	setFilter (const QString &filter)
bool	showLocalProtocol () const
virtual KFileDialog *	fileDialog () const
KLineEdit *	lineEdit () const
KComboBox *	comboBox () const
KPushButton *	button () const
KURLCompletion *	completionObject () const
KEditListBox::CustomEditor	customEditor ()
Protected Slots
void	slotOpenDialog ()

---

Detailed Description

A widget to request a filename/url from the user.

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

Author:

Carsten Pfeiffer <pfeiffer@kde.org>

Definition at line 54 of file kurlrequester.h.

---

Constructor & Destructor Documentation

KURLRequester::KURLRequester (  QWidget *    parent = 0, const char *    name = 0 )

Constructs a KURLRequester widget.

KURLRequester::KURLRequester (  const QString &    url, QWidget *    parent = 0, const char *    name = 0 )

Constructs a KURLRequester widget with the initial URL url.

KURLRequester::KURLRequester (  QWidget *    editWidget, QWidget *    parent, const char *    name = 0 )

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. Parameters: modal  specifies whether the filedialog should be opened as modal or not.

KURLRequester::~KURLRequester (    )

Destructs the KURLRequester.

---

Member Function Documentation

KPushButton* KURLRequester::button (    )

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.

void KURLRequester::clear (    )  [slot]

Clears the lineedit/combobox.

KComboBox* KURLRequester::comboBox (    )

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

KURLCompletion* KURLRequester::completionObject (    )  const [inline]

Returns: the KURLCompletion object used in the lineedit/combobox. Definition at line 150 of file kurlrequester.h.

KEditListBox::CustomEditor KURLRequester::customEditor (    )

Returns: an object, suitable for use with KEditListBox. It allows you to put this KURLRequester into a KEditListBox. Basically, do it like this: KURLRequester *req = new KURLRequester( someWidget ); [...] KEditListBox *editListBox = new KEditListBox( i18n("Some Title"), req->customEditor(), someWidget ); Since: 3.1

virtual KFileDialog* KURLRequester::fileDialog (    )  [virtual]

Returns: a pointer to the filedialog You can use this to customize the dialog, e.g. to specify a filter. Never returns 0L.

KLineEdit* KURLRequester::lineEdit (    )

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.

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 (  const QString &    )  [signal]

Emitted when return or enter was pressed in the lineedit. The parameter contains the contents of the lineedit.

void KURLRequester::returnPressed (    )  [signal]

Emitted when return or enter was pressed in the lineedit.

virtual void KURLRequester::setCaption (  const QString &    caption )  [virtual, slot]

@reimp Sets the caption of the file dialog. Since: 3.1

void KURLRequester::setFilter (  const QString &    filter )

Sets the filter for the file dialog. See also: KFileDialog::setFilter()

void KURLRequester::setMode (  unsigned int    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()

void KURLRequester::setShowLocalProtocol (  bool    b )

Enables/disables showing file:/ in the lineedit, when a local file has been selected in the filedialog or was set via setURL(). Default is false, not showing file:/ See also: showLocalProtocol

void KURLRequester::setURL (  const QString &    url )  [slot]

Sets the url in the lineedit to url. Depending on the state of showLocalProtocol(), file:/ on local files will be shown or not. Since: 3.1

bool KURLRequester::showLocalProtocol (    )  const [inline]

Returns: whether local files will be prefixed with file:/ in the lineedit See also: setShowLocalProtocol Definition at line 117 of file kurlrequester.h.

void KURLRequester::slotOpenDialog (    )  [protected, slot]

Called when the button is pressed to open the filedialog. Also called when KStdAccel::Open (default is Ctrl-O) is pressed.

void KURLRequester::textChanged (  const QString &    )  [signal]

Emitted when the text in the lineedit changes. The parameter contains the contents of the lineedit. Since: 3.1

QString KURLRequester::url (    )

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 QString &    )  [signal]

Emitted when the user changed the URL via the file dialog. The parameter contains the contents of the lineedit.

---

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

• kurlrequester.h

---