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:


Classes
struct	_KURLComboItem
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 QPixmap &pix, const QString &text=QString::null)
void	addDefaultURL (const KURL &url, const QString &text=QString::null)
	KURLComboBox (Mode mode, bool rw, QWidget parent=0, const char name=0)
	KURLComboBox (Mode mode, QWidget parent=0, const char name=0)
int	maxItems () const
void	removeURL (const KURL &url, bool checkDefaultURLs=true)
void	setDefaults ()
void	setMaxItems (int)
void	setURL (const KURL &url)
void	setURLs (QStringList urls, OverLoadResolving remove)
void	setURLs (QStringList urls)
QStringList	urls () const
	~KURLComboBox ()
Protected Types
typedef _KURLComboItem	KURLComboItem
Protected Slots
void	slotActivated (int)
Protected Member Functions
QPixmap	getPixmap (const KURL &url) const
void	init (Mode mode)
void	insertURLItem (const KURLComboItem *)
void	updateItem (const KURLComboItem *item, int index, const QPixmap &pix)
Protected Attributes
QPtrList< KURLComboItem >	defaultList
int	firstItemIndex
QPtrList< KURLComboItem >	itemList
QMap< int, const KURLComboItem * >	itemMapper
QPixmap	opendirPix
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().

A combo box showing a number of recent URLs/directories

Author:: Carsten Pfeiffer <pfeiffer@kde.org>

Definition at line 41 of file kurlcombobox.h.

Member Typedef Documentation

typedef _KURLComboItem KURLComboBox::KURLComboItem [protected]

Definition at line 192 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 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

Enumerator:

RemoveTop
RemoveBottom

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.
	parent	The parent object of this widget.
	name	The name of this widget.

Definition at line 41 of file kurlcombobox.cpp.

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

Definition at line 48 of file kurlcombobox.cpp.

KURLComboBox::~KURLComboBox ( )

Destructs the combo box.

Definition at line 56 of file kurlcombobox.cpp.

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

Definition at line 107 of file kurlcombobox.cpp.

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

Definition at line 101 of file kurlcombobox.cpp.

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.

Definition at line 335 of file kurlcombobox.cpp.

void KURLComboBox::init ( Mode mode ) [protected]

Definition at line 62 of file kurlcombobox.cpp.

void KURLComboBox::insertURLItem ( const KURLComboItem * item ) [protected]

Definition at line 278 of file kurlcombobox.cpp.

int KURLComboBox::maxItems ( ) const [inline]

Returns:: the maximum of items the combobox handles.

See also:: setMaxItems

Definition at line 137 of file kurlcombobox.h.

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 313 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 125 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 287 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 205 of file kurlcombobox.cpp.

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.

Definition at line 142 of file kurlcombobox.cpp.

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.

Definition at line 137 of file kurlcombobox.cpp.

void KURLComboBox::slotActivated ( int index ) [protected, slot]

Definition at line 267 of file kurlcombobox.cpp.

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.

Definition at line 346 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:/

Member Data Documentation

QPtrList<KURLComboItem> KURLComboBox::defaultList [protected]

Definition at line 194 of file kurlcombobox.h.

int KURLComboBox::firstItemIndex [protected]

Definition at line 214 of file kurlcombobox.h.

QPtrList<KURLComboItem> KURLComboBox::itemList [protected]

Definition at line 193 of file kurlcombobox.h.

QMap<int,const KURLComboItem*> KURLComboBox::itemMapper [protected]

Definition at line 195 of file kurlcombobox.h.

QPixmap KURLComboBox::opendirPix [protected]

Definition at line 213 of file kurlcombobox.h.

Property Documentation

int KURLComboBox::maxItems [read, write]

Definition at line 45 of file kurlcombobox.h.

QStringList KURLComboBox::urls [read, write]

Definition at line 44 of file kurlcombobox.h.

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

kio

KURLComboBox Class Reference

Classes

Public Types

Signals

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Properties