Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KIconDialog Class Reference

An icon selection dialog. More...

#include <kicondialog.h>

Inheritance diagram for KIconDialog:

KDialogBase KDialog List of all members.

Public Methods

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

Static Public Methods

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 Methods

virtual void virtual_hook (int id, void *data)

Detailed Description

An icon selection dialog.

Dialog for interactive selection of icons. Use the function getIcon() let the user select an icon.

Definition at line 92 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.

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

Constructs an icon selection dialog using a specific iconloader.

KIconDialog::~KIconDialog (    ) 
 

Destructs the dialog.


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".
Returns:
The name of the icon, suitable for loading with KIconLoader.
Version:
New in 3.0

int KIconDialog::iconSize (    ) 
 

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

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

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.

void KIconDialog::setCustomLocation (  const QString &    location ) 
 

sets a custom icon directory

Since:
3.1

void KIconDialog::setIconSize (  int    size ) 
 

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

See also:
KIcon::StdSizes , iconSize

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.

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

bool KIconDialog::strictIconSize (    ) 
 

Returns true if a strict icon size policy is set.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:15 2003 for kdelibs by doxygen1.2.18