class KURLRequester

# class KURLRequester | A widget to request a filename/url from the user. More...
Definition | `#include <kurlrequester.h>`
Inherits | QHBox (qt) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

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

#### 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& )

#### Protected Methods

- void init ()
- virtual void virtual_hook ( int id, void* data )

#### Protected Slots

- void slotOpenDialog ()

#### Protected Members

- KURLCompletion * myCompletion

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

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

Constructs a KURLRequester widget.

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

Constructs a KURLRequester widget with the initial URL `url`.

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

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.

QString url () | ### 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 setShowLocalProtocol ( bool b ) | ### setShowLocalProtocol

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 setMode ( unsigned int m ) | ### setMode

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 setFilter ( const QString& filter ) | ### setFilter

Sets the filter for the file dialog.

See also: KFileDialog::setFilter()

bool showLocalProtocol () | ### showLocalProtocol

[const]

Returns: whether local files will be prefixed with file:/ in the lineedit

See also: setShowLocalProtocol

KFileDialog * fileDialog () | ### fileDialog

[const 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 * lineEdit () | ### lineEdit

[const]

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

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

KComboBox * comboBox () | ### comboBox

[const]

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

KPushButton * button () | ### 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.

KURLCompletion * completionObject () | ### completionObject

[const]

Returns: the KURLCompletion object used in the lineedit/combobox.

KEditListBox::CustomEditor customEditor () | ### customEditor

     KURLRequester *req = new KURLRequester( someWidget );
     [...]
     KEditListBox *editListBox = new KEditListBox( i18n("Some Title"), req->customEditor(), someWidget );

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

void setURL ( const QString& url ) | ### setURL

[slot]

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

void setCaption ( const QString& caption ) | ### setCaption

[virtual slot]

@reimp Sets the caption of the file dialog.

void clear () | ### clear

[slot]

Clears the lineedit/combobox.

void textChanged ( const QString& ) | ### textChanged

[signal]

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

void returnPressed () | ### returnPressed

[signal]

Emitted when return or enter was pressed in the lineedit.

void returnPressed ( const QString& ) | ### returnPressed

[signal]

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

void openFileDialog ( KURLRequester * ) | ### openFileDialog

[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 urlSelected ( const QString& ) | ### urlSelected

[signal]

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

void init () | ### init

[protected]

KURLCompletion * myCompletion | ### myCompletion

[protected]

void slotOpenDialog () | ### slotOpenDialog

[protected slots slot]

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

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

- Author: Carsten Pfeiffer
- Generated: root on macppc.ports.openbsd.org on Sat Sep 6 10:37:17 2003, using kdoc 2.0a54.