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

KIO

KUrlComboBox Class Reference

This combobox shows a number of recent URLs/directories, as well as some default directories. More...

#include <kurlcombobox.h>

Inheritance diagram for KUrlComboBox:

Inheritance graph
[legend]

List of all members.


Public Types

enum  Mode { Files = -1, Directories = 1, Both = 0 }
enum  OverLoadResolving { RemoveTop, RemoveBottom }

Signals

void urlActivated (const KUrl &url)

Public Member Functions

void addDefaultUrl (const KUrl &url, const QIcon &icon, const QString &text=QString())
void addDefaultUrl (const KUrl &url, const QString &text=QString())
 KUrlComboBox (Mode mode, bool rw, QWidget *parent=0)
 KUrlComboBox (Mode mode, QWidget *parent=0)
int maxItems () const
void removeUrl (const KUrl &url, bool checkDefaultURLs=true)
virtual void setCompletionObject (KCompletion *compObj, bool hsig=true)
void setDefaults ()
void setMaxItems (int)
void setUrl (const KUrl &url)
void setUrls (const QStringList &urls, OverLoadResolving remove)
void setUrls (const QStringList &urls)
QStringList urls () const
 ~KUrlComboBox ()

Protected Member Functions

virtual void mouseMoveEvent (QMouseEvent *event)
virtual void mousePressEvent (QMouseEvent *event)

Properties

int maxItems
QStringList urls

Detailed Description

This combobox shows a number of recent URLs/directories, as well as some default directories.

It will manage the default dirs root-directory, home-directory and Desktop-directory, as well as a number of URLs set via setUrls() and one additional entry to be set via setUrl().

This widget forces the layout direction to be Qt::LeftToRight instead of inheriting the layout direction like a normal widget. This means that even in RTL desktops the widget will be displayed in LTR mode, as generally URLs are LTR by nature.

A combo box showing a number of recent URLs/directories

Author:
Carsten Pfeiffer <pfeiffer@kde.org>

Definition at line 47 of file kurlcombobox.h.


Member Enumeration Documentation

enum KUrlComboBox::Mode

This enum describes which kind of items is shown in the combo box.

Enumerator:
Files 
Directories 
Both 

Definition at line 57 of file kurlcombobox.h.

enum KUrlComboBox::OverLoadResolving

This Enumeration is used in setUrl() to determine which items will be removed when the given list is larger than maxItems().

  • RemoveTop means that items will be removed from top
  • RemoveBottom means, that items will be removed from the bottom
Enumerator:
RemoveTop 
RemoveBottom 

Definition at line 65 of file kurlcombobox.h.


Constructor & Destructor Documentation

KUrlComboBox::KUrlComboBox ( Mode  mode,
QWidget *  parent = 0 
) [explicit]

Constructs a KUrlComboBox.

Parameters:
mode is either Files, Directories or Both and controls the following behavior:
  • Files all inserted URLs will be treated as files, therefore the url shown in the combo will never show a trailing / the icon will be the one associated with the file's mimetype.
  • Directories all inserted URLs will be treated as directories, will have a trailing slash in the combobox. The current directory will show the "open folder" icon, other directories the "folder" icon.
  • Both Don't mess with anything, just show the url as given.
parent The parent object of this widget.

Definition at line 75 of file kurlcombobox.cpp.

KUrlComboBox::KUrlComboBox ( Mode  mode,
bool  rw,
QWidget *  parent = 0 
)

Definition at line 82 of file kurlcombobox.cpp.

KUrlComboBox::~KUrlComboBox (  ) 

Destructs the combo box.

Definition at line 89 of file kurlcombobox.cpp.


Member Function Documentation

void KUrlComboBox::addDefaultUrl ( const KUrl &  url,
const QIcon &  icon,
const QString &  text = QString() 
)

Adds a url that will always be shown in the combobox, it can't be "rotated away".

Default urls won't be returned in urls() and don't have to be set via setUrls(). If you don't need to specify a pixmap, use the overloaded method without the pixmap parameter. Default URLs will be inserted into the combobox by setDefaults()

Definition at line 140 of file kurlcombobox.cpp.

void KUrlComboBox::addDefaultUrl ( const KUrl &  url,
const QString &  text = QString() 
)

Adds a url that will always be shown in the combobox, it can't be "rotated away".

Default urls won't be returned in urls() and don't have to be set via setUrls(). If you want to specify a special pixmap, use the overloaded method with the pixmap parameter. Default URLs will be inserted into the combobox by setDefaults()

Definition at line 134 of file kurlcombobox.cpp.

int KUrlComboBox::maxItems (  )  const

Returns:
the maximum of items the combobox handles.
See also:
setMaxItems

void KUrlComboBox::mouseMoveEvent ( QMouseEvent *  event  )  [protected, virtual]

Definition at line 407 of file kurlcombobox.cpp.

void KUrlComboBox::mousePressEvent ( QMouseEvent *  event  )  [protected, virtual]

Definition at line 390 of file kurlcombobox.cpp.

void KUrlComboBox::removeUrl ( const KUrl &  url,
bool  checkDefaultURLs = true 
)

Removes any occurrence of url.

If checkDefaultUrls is false default-urls won't be removed.

Definition at line 359 of file kurlcombobox.cpp.

void KUrlComboBox::setCompletionObject ( KCompletion *  compObj,
bool  hsig = true 
) [virtual]

Reimplemented from KComboBox (from KCompletion).

For internal use only.

Definition at line 379 of file kurlcombobox.cpp.

void KUrlComboBox::setDefaults (  ) 

Clears all items and inserts the default urls into the combo.

Will be called implicitly upon the first call to setUrls() or setUrl()

See also:
addDefaultUrl

Definition at line 157 of file kurlcombobox.cpp.

void KUrlComboBox::setMaxItems ( int  max  ) 

Sets how many items should be handled and displayed by the combobox.

See also:
maxItems

Definition at line 329 of file kurlcombobox.cpp.

void KUrlComboBox::setUrl ( const KUrl &  url  ) 

Sets the current url.

This combo handles exactly one url additionally to the default items and those set via setUrls(). So you can call setUrl() as often as you want, it will always replace the previous one set via setUrl(). If url is already in the combo, the last item will stay there and the existing item becomes the current item. The current item will always have the open-directory-pixmap as icon.

Note that you won't receive any signals, e.g. textChanged(), returnPressed() or activated() upon calling this method.

Definition at line 241 of file kurlcombobox.cpp.

void KUrlComboBox::setUrls ( const QStringList &  urls,
OverLoadResolving  remove 
)

Inserts urls into the combobox below the "default urls" (see addDefaultUrl).

If the list of urls contains more items than maxItems, the remove parameter determines whether the first or last items will be stripped.

Definition at line 174 of file kurlcombobox.cpp.

void KUrlComboBox::setUrls ( const QStringList &  urls  ) 

Inserts urls into the combobox below the "default urls" (see addDefaultUrl).

If the list of urls contains more items than maxItems, the first items will be stripped.

Definition at line 169 of file kurlcombobox.cpp.

void KUrlComboBox::urlActivated ( const KUrl &  url  )  [signal]

Emitted when an item was clicked at.

Parameters:
url is the url of the now current item. If it is a local url, it won't have a protocol (file:/), otherwise it will.

QStringList KUrlComboBox::urls (  )  const

Returns:
a list of all urls currently handled. The list contains at most maxItems() items. Use this to save the list of urls in a config-file and reinsert them via setUrls() next time. Note that all default urls set via addDefaultUrl() are not returned, they will automatically be set via setUrls() or setUrl(). You will always get fully qualified urls, i.e. with protocol like file:/


Property Documentation

int KUrlComboBox::maxItems [read, write]

Definition at line 51 of file kurlcombobox.h.

QStringList KUrlComboBox::urls [read, write]

Definition at line 50 of file kurlcombobox.h.


The documentation for this class was generated from the following files:
  • kurlcombobox.h
  • kurlcombobox.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
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
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