• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KUrlRequester Class Reference

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

#include <kurlrequester.h>

Inheritance diagram for KUrlRequester:
KHBox QFrame KUrlComboRequester

List of all members.

Public Slots

void clear ()
KDE_DEPRECATED 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 (const QString &)
void returnPressed ()
void textChanged (const QString &)
void urlSelected (const KUrl &)

Public Member Functions

KPushButton * button () const
QString clickMessage () const
KComboBox * comboBox () const
KUrlCompletion * completionObject () const
const KEditListBox::CustomEditor & customEditor ()
virtual KFileDialog * fileDialog () const
QString filter () const
 KUrlRequester (QWidget *editWidget, QWidget *parent)
 KUrlRequester (const KUrl &url, QWidget *parent=0)
 KUrlRequester (QWidget *parent=0)
KLineEdit * lineEdit () const
KFile::Modes mode () const
void setClickMessage (const QString &msg)
void setFilter (const QString &filter)
void setMode (KFile::Modes m)
KUrl startDir () const
QString text () const
KUrl url () const
 ~KUrlRequester ()

Protected Member Functions

virtual void changeEvent (QEvent *e)
bool eventFilter (QObject *obj, QEvent *ev)

Properties

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

kurlrequester.png

KDE URL Requester

A widget to request a filename/url from the user

Author:
Carsten Pfeiffer <pfeiffer@kde.org>

Definition at line 53 of file kurlrequester.h.


Constructor & Destructor Documentation

KUrlRequester::KUrlRequester ( QWidget *  parent = 0  )  [explicit]

Constructs a KUrlRequester widget.

Definition at line 201 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 208 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 186 of file kurlrequester.cpp.

KUrlRequester::~KUrlRequester (  ) 

Destructs the KUrlRequester.

Definition at line 215 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 425 of file kurlrequester.cpp.

void KUrlRequester::changeEvent ( QEvent *  e  )  [protected, virtual]

Definition at line 278 of file kurlrequester.cpp.

void KUrlRequester::clear (  )  [slot]

Clears the lineedit/combobox.

Definition at line 393 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 403 of file kurlrequester.cpp.

KUrlCompletion * KUrlRequester::completionObject (  )  const
Returns:
the KUrlCompletion object used in the lineedit/combobox.

Definition at line 430 of file kurlrequester.cpp.

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

Definition at line 449 of file kurlrequester.cpp.

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

Definition at line 414 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 specify a filter. Never returns 0L.

Remove in KDE4? KUrlRequester should use KDirSelectDialog for (mode & KFile::Directory) && !(mode & KFile::File)

Definition at line 380 of file kurlrequester.cpp.

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

void KUrlRequester::setClickMessage ( const QString &  msg  ) 

Set a click message msg.

Since:
4.2

Definition at line 435 of file kurlrequester.cpp.

void KUrlRequester::setFilter ( const QString &  filter  ) 

Sets the filter for the file dialog.

See also:
KFileDialog::setFilter()

Definition at line 367 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 350 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|KFileExistingOnly|KFileLocalOnly)

Deprecated:
Use setUrl(KUrl(path)) instead.

Definition at line 263 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 273 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 268 of file kurlrequester.cpp.

void KUrlRequester::setUrl ( const KUrl &  url  )  [slot]

Sets the url in the lineedit to url.

Definition at line 258 of file kurlrequester.cpp.

KUrl KUrlRequester::startDir (  )  const
Returns:
the current start dir
Since:
4.3

Definition at line 293 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 [read, write]

Definition at line 60 of file kurlrequester.h.

QString KUrlRequester::filter [read, write]

Definition at line 57 of file kurlrequester.h.

KFile::Modes KUrlRequester::mode [read, write]

Definition at line 59 of file kurlrequester.h.

QString KUrlRequester::text [read, write]

Definition at line 61 of file kurlrequester.h.

KUrl KUrlRequester::url [read, write]

Definition at line 56 of file kurlrequester.h.


The documentation for this class was generated from the following files:
  • kurlrequester.h
  • kurlrequester.cpp

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal