---

KURLComboBox Class Reference

A combo box showing a number of recent URLs/directories. More...

#include <kurlcombobox.h>

Inheritance diagram for KURLComboBox:

List of all members.

Public Types
enum	Mode
enum	OverLoadResolving
Signals
void	urlActivated (const KURL &url)
Public Methods
	KURLComboBox (Mode mode, QWidget *parent=0, const char *name=0)
	~KURLComboBox ()
void	setURL (const KURL &url)
void	setURLs (QStringList urls)
void	setURLs (QStringList urls, OverLoadResolving remove)
QStringList	urls () const
void	setMaxItems (int)
int	maxItems () const
void	addDefaultURL (const KURL &url, const QString &text=QString::null)
void	addDefaultURL (const KURL &url, const QPixmap &pix, const QString &text=QString::null)
void	setDefaults ()
void	removeURL (const KURL &url, bool checkDefaultURLs=true)
Protected Methods
QPixmap	getPixmap (const KURL &url) const
void	updateItem (const KURLComboItem *item, int index, const QPixmap &pix)

---

Detailed Description

A combo box showing a number of recent URLs/directories.

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

Author:

Carsten Pfeiffer <pfeiffer@kde.org>

Definition at line 41 of file kurlcombobox.h.

---

Member Enumeration Documentation

enum KURLComboBox::Mode

This enum describes which kind of items is shown in the combo box. Definition at line 51 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 Definition at line 59 of file kurlcombobox.h.

---

Constructor & Destructor Documentation

KURLComboBox::KURLComboBox (  Mode    mode, QWidget *    parent = 0, const char *    name = 0 )

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.

KURLComboBox::~KURLComboBox (    )

Destructs the combo box.

---

Member Function Documentation

void KURLComboBox::addDefaultURL (  const KURL &    url, const QPixmap &    pix, const QString &    text = QString::null )

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

void KURLComboBox::addDefaultURL (  const KURL &    url, const QString &    text = QString::null )

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

QPixmap KURLComboBox::getPixmap (  const KURL &    url )  const [protected]

Uses KMimeType::pixmapForURL() to return a proper pixmap for url. In directory mode, a folder icon is always returned.

int KURLComboBox::maxItems (    )  const [inline]

Returns: the maximum of items the combobox handles. See also: setMaxItems Definition at line 135 of file kurlcombobox.h.

void KURLComboBox::removeURL (  const KURL &    url, bool    checkDefaultURLs = true )

Removes any occurence of url. If checkDefaultURLs is false default-urls won't be removed.

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

void KURLComboBox::setMaxItems (  int    )

Sets how many items should be handled and displayed by the combobox. See also: maxItems

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.

void KURLComboBox::setURLs (  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.

void KURLComboBox::setURLs (  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.

void KURLComboBox::updateItem (  const KURLComboItem *    item, int    index, const QPixmap &    pix )  [protected]

Updates item with pixmap and sets the url instead of the text of the KURLComboItem. Also works around a Qt bug.

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

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:/

---

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

• kurlcombobox.h

---