KIconDialog Class Reference

Dialog for interactive selection of icons. More...

#include <kicondialog.h>

Inheritance diagram for KIconDialog:

List of all members.

Signals
void	newIconName (const QString &)
Public Member Functions
	KIconDialog (QWidget *parent=0L)
	KIconDialog (KIconLoader *loader, QWidget *parent=0)
	~KIconDialog ()
int	iconSize () const
QString	openDialog ()
void	setCustomLocation (const QString &location)
void	setIconSize (int size)
void	setStrictIconSize (bool b)
void	setup (KIconLoader::Group group, KIconLoader::Context context=KIconLoader::Application, bool strictIconSize=false, int iconSize=0, bool user=false, bool lockUser=false, bool lockCustomDir=false)
void	showDialog ()
bool	strictIconSize () const
Static Public Member Functions
static QString	getIcon (KIconLoader::Group group=KIconLoader::Desktop, KIconLoader::Context context=KIconLoader::Application, bool strictIconSize=false, int iconSize=0, bool user=false, QWidget *parent=0, const QString &caption=QString())
Protected Slots
void	slotOk ()

---

Detailed Description

Dialog for interactive selection of icons.

Use the function getIcon() let the user select an icon.

An icon selection dialog.

Definition at line 107 of file kicondialog.h.

---

Constructor & Destructor Documentation

KIconDialog::KIconDialog

(

QWidget *

parent = 0L

)

[explicit]

Constructs an icon selection dialog using the global iconloader.

Parameters:

parent

The parent widget.

Definition at line 332 of file kicondialog.cpp.

KIconDialog::KIconDialog	(	KIconLoader *	loader,
		QWidget *	parent = 0
	)		[explicit]

Constructs an icon selection dialog using a specific iconloader.

Parameters:

loader	The icon loader to use.
parent	The parent widget.

Definition at line 344 of file kicondialog.cpp.

KIconDialog::~KIconDialog

(

)

Destructs the dialog.

Definition at line 487 of file kicondialog.cpp.

---

Member Function Documentation

QString KIconDialog::getIcon	(	KIconLoader::Group	group = KIconLoader::Desktop,
		KIconLoader::Context	context = KIconLoader::Application,
		bool	strictIconSize = false,
		int	iconSize = 0,
		bool	user = false,
		QWidget *	parent = 0,
		const QString &	caption = QString()
	)		[static]

Pops up the dialog an lets the user select an icon.

Parameters:

group	The icon group this icon is intended for. Providing the group shows the icons in the dialog with the same appearance as when used outside the dialog.
context	The initial icon context. Initially, the icons having this context are shown in the dialog. The user can change this.
strictIconSize	When true, only icons of the specified group's size are shown, otherwise icon not available in the desired group's size will also be selectable.
iconSize	the size of the icons -- the default of the icongroup if set to 0
user	Begin with the "user icons" instead of "system icons".
parent	The parent widget of the dialog.
caption	The caption to use for the dialog.

Returns:

The name of the icon, suitable for loading with KIconLoader.

Definition at line 673 of file kicondialog.cpp.

int KIconDialog::iconSize

(

)

const

Returns the iconsize set via setIconSize() or 0, if the default iconsize will be used.

Definition at line 567 of file kicondialog.cpp.

void KIconDialog::newIconName

(

const QString &

)

[signal]

QString KIconDialog::openDialog

(

)

exec()utes this modal dialog and returns the name of the selected icon, or QString() if the dialog was aborted.

Returns:

the name of the icon, suitable for loading with KIconLoader.

See also:

getIcon

Definition at line 626 of file kicondialog.cpp.

void KIconDialog::setCustomLocation

(

const QString &

location

)

sets a custom icon directory

Definition at line 621 of file kicondialog.cpp.

void KIconDialog::setIconSize

(

int

size

)

Sets the size of the icons to be shown / selected.

See also:

KIconLoader::StdSizes

iconSize

Definition at line 557 of file kicondialog.cpp.

void KIconDialog::setStrictIconSize

(

bool

b

)

Sets a strict icon size policy for allowed icons.

When true, only icons of the specified group's size in getIcon() are shown. When false, icons not available at the desired group's size will also be selectable.

Definition at line 547 of file kicondialog.cpp.

void KIconDialog::setup	(	KIconLoader::Group	group,
		KIconLoader::Context	context = KIconLoader::Application,
		bool	strictIconSize = false,
		int	iconSize = 0,
		bool	user = false,
		bool	lockUser = false,
		bool	lockCustomDir = false
	)

Allows you to set the same parameters as in the class method getIcon(), as well as two additional parameters to lock the choice between system and user dirs and to lock the custom user dir itself.

Definition at line 573 of file kicondialog.cpp.

void KIconDialog::showDialog

(

)

show()es this dialog and emits a newIcon(const QString&) signal when successful.

QString() will be emitted if the dialog was aborted.

Definition at line 645 of file kicondialog.cpp.

void KIconDialog::slotOk

(

)

[protected, slot]

Definition at line 653 of file kicondialog.cpp.

bool KIconDialog::strictIconSize

(

)

const

Returns true if a strict icon size policy is set.

Definition at line 552 of file kicondialog.cpp.

---

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

• kicondialog.h
• kicondialog.cpp