KIconDialog Class Reference

Dialog for interactive selection of icons. More...

#include <kicondialog.h>

Inherits KDialogBase.

List of all members.

Signals

void newIconName (const QString &)

Public Member Functions

 KIconDialog (QWidget *parent=0L, const char *name=0L)
 KIconDialog (KIconLoader *loader, QWidget *parent=0, const char *name=0)
 ~KIconDialog ()
void setStrictIconSize (bool b)
bool strictIconSize () const
void setCustomLocation (const QString &location)
void setIconSize (int size)
int iconSize () const
QString selectIcon (KIcon::Group group=KIcon::Desktop, KIcon::Context context=KIcon::Application, bool user=false)
void setup (KIcon::Group group, KIcon::Context context=KIcon::Application, bool strictIconSize=false, int iconSize=0, bool user=false)
void setup (KIcon::Group group, KIcon::Context context, bool strictIconSize, int iconSize, bool user, bool lockUser, bool lockCustomDir)
QString openDialog ()
void showDialog ()

Static Public Member Functions

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

Protected Slots

void slotOk ()

Protected Member Functions

virtual void virtual_hook (int id, void *data)

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 91 of file kicondialog.h.


Constructor & Destructor Documentation

KIconDialog::KIconDialog ( QWidget parent = 0L,
const char *  name = 0L 
)

Constructs an icon selection dialog using the global iconloader.

Definition at line 240 of file kicondialog.cpp.

KIconDialog::KIconDialog ( KIconLoader *  loader,
QWidget parent = 0,
const char *  name = 0 
)

Constructs an icon selection dialog using a specific iconloader.

Definition at line 248 of file kicondialog.cpp.

KIconDialog::~KIconDialog (  ) 

Destructs the dialog.

Definition at line 379 of file kicondialog.cpp.


Member Function Documentation

QString KIconDialog::getIcon ( KIcon::Group  group = KIcon::Desktop,
KIcon::Context  context = KIcon::Application,
bool  strictIconSize = false,
int  iconSize = 0,
bool  user = false,
QWidget parent = 0,
const QString caption = QString::null 
) [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.
Version:
New in 3.0

Definition at line 547 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 439 of file kicondialog.cpp.

QString KIconDialog::openDialog (  ) 

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

Returns:
the name of the icon, suitable for loading with KIconLoader.
See also:
getIcon

Definition at line 502 of file kicondialog.cpp.

QString KIconDialog::selectIcon ( KIcon::Group  group = KIcon::Desktop,
KIcon::Context  context = KIcon::Application,
bool  user = false 
)
Deprecated:
in KDE 3.0, use the static method getIcon instead.

Definition at line 446 of file kicondialog.cpp.

void KIconDialog::setCustomLocation ( const QString location  ) 

sets a custom icon directory

Since:
3.1

Definition at line 497 of file kicondialog.cpp.

void KIconDialog::setIconSize ( int  size  ) 

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

See also:
KIcon::StdSizes
iconSize

Definition at line 430 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 420 of file kicondialog.cpp.

void KIconDialog::setup ( KIcon::Group  group,
KIcon::Context  context,
bool  strictIconSize,
int  iconSize,
bool  user,
bool  lockUser,
bool  lockCustomDir 
)

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.

Since:
3.3

Definition at line 466 of file kicondialog.cpp.

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

Allows you to set the same parameters as in the class method getIcon().

Definition at line 453 of file kicondialog.cpp.

void KIconDialog::showDialog (  ) 

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

QString::null will be emitted if the dialog was aborted.

Definition at line 519 of file kicondialog.cpp.

bool KIconDialog::strictIconSize (  )  const

Returns true if a strict icon size policy is set.

Definition at line 425 of file kicondialog.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys