KFilePlaceEditDialog Class Reference

A dialog that allows editing entries of a KUrlBar ( KUrlBarItem). More...

#include <kfileplaceeditdialog.h>

Inheritance diagram for KFilePlaceEditDialog:

List of all members.

Public Slots
void	urlChanged (const QString &)
Public Member Functions
	KFilePlaceEditDialog (bool allowGlobal, const KUrl &url, const QString &label, const QString &icon, bool isAddingNewPlace, bool appLocal=true, int iconSize=KIconLoader::SizeMedium, QWidget *parent=0)
	~KFilePlaceEditDialog ()
bool	applicationLocal () const
const QString &	icon () const
QString	label () const
KUrl	url () const
Static Public Member Functions
static bool	getInformation (bool allowGlobal, KUrl &url, QString &label, QString &icon, bool isAddingNewPlace, bool &appLocal, int iconSize, QWidget *parent=0)

---

Detailed Description

A dialog that allows editing entries of a KUrlBar ( KUrlBarItem).

The dialog offers to configure a given url, label and icon. See the class-method getInformation() for easy usage.

Author:

Carsten Pfeiffer <pfeiffer@kde.org>

Definition at line 41 of file kfileplaceeditdialog.h.

---

Constructor & Destructor Documentation

KFilePlaceEditDialog::KFilePlaceEditDialog	(	bool	allowGlobal,
		const KUrl &	url,
		const QString &	label,
		const QString &	icon,
		bool	isAddingNewPlace,
		bool	appLocal = true,
		int	iconSize = KIconLoader::SizeMedium,
		QWidget *	parent = 0
	)

Constructs a KFilePlaceEditDialog.

allowGlobal if you set this to true, the dialog will have a checkbox for the user to decide if he wants the entry to be available globally or just for the current application. url the url of the item label a short, translated description of the item icon an icon for the item appLocal tells whether the item should be local for this application or be available globally iconSize determines the size of the icon that is shown/selectable parent the parent-widget for the dialog

If you leave the icon empty, the default icon for the given url will be used (KMimeType::pixmapForUrl()).

Definition at line 81 of file kfileplaceeditdialog.cpp.

KFilePlaceEditDialog::~KFilePlaceEditDialog

(

)

Destroys the dialog.

Definition at line 167 of file kfileplaceeditdialog.cpp.

---

Member Function Documentation

bool KFilePlaceEditDialog::applicationLocal

(

)

const

Returns:

whether the item should be local to the application or global. If allowGlobal was set to false in the constructor, this will always return true.

Definition at line 203 of file kfileplaceeditdialog.cpp.

bool KFilePlaceEditDialog::getInformation	(	bool	allowGlobal,
		KUrl &	url,
		QString &	label,
		QString &	icon,
		bool	isAddingNewPlace,
		bool &	appLocal,
		int	iconSize,
		QWidget *	parent = 0
	)		[static]

A convenience method to show the dialog and retrieve all the properties via the given parameters.

The parameters are used to initialize the dialog and then return the user-configured values.

allowGlobal if you set this to true, the dialog will have a checkbox for the user to decide if he wants the entry to be available globally or just for the current application. url the url of the item label a short, translated description of the item icon an icon for the item appLocal tells whether the item should be local for this application or be available globally iconSize determines the size of the icon that is shown/selectable parent the parent-widget for the dialog

If you leave the icon empty, the default icon for the given url will be used (KMimeType::pixmapForUrl()).

Definition at line 54 of file kfileplaceeditdialog.cpp.

const QString & KFilePlaceEditDialog::icon

(

)

const

Returns:

the configured icon

Definition at line 198 of file kfileplaceeditdialog.cpp.

QString KFilePlaceEditDialog::label

(

)

const

Returns:

the configured label

Definition at line 181 of file kfileplaceeditdialog.cpp.

KUrl KFilePlaceEditDialog::url

(

)

const

Returns:

the configured url

Definition at line 176 of file kfileplaceeditdialog.cpp.

void KFilePlaceEditDialog::urlChanged

(

const QString &

text

)

[slot]

Definition at line 171 of file kfileplaceeditdialog.cpp.

---

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

• kfileplaceeditdialog.h
• kfileplaceeditdialog.cpp