.TH "KIconDialog" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIconDialog \- Dialog for interactive selection of icons. An icon selection dialog.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kicondialog.h>\fP
.PP
Inherits \fBKDialogBase\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKIconDialog\fP (\fBQWidget\fP *parent=0L, const  char *name=0L)"
.br
.RI "\fIConstructs an icon selection dialog using the global iconloader. \fP"
.ti -1c
.RI "\fBKIconDialog\fP (\fBKIconLoader\fP *loader, \fBQWidget\fP *parent=0, const  char *name=0)"
.br
.RI "\fIConstructs an icon selection dialog using a specific iconloader. \fP"
.ti -1c
.RI "\fB~KIconDialog\fP ()"
.br
.RI "\fIDestructs the dialog. \fP"
.ti -1c
.RI "void \fBsetStrictIconSize\fP (bool b)"
.br
.RI "\fISets a strict icon size policy for allowed icons. \fP"
.ti -1c
.RI "bool \fBstrictIconSize\fP () const "
.br
.RI "\fIReturns true if a strict icon size policy is set. \fP"
.ti -1c
.RI "void \fBsetCustomLocation\fP (const  \fBQString\fP &location)"
.br
.RI "\fIsets a custom icon directory 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
\fP"
.ti -1c
.RI "void \fBsetIconSize\fP (int size)"
.br
.RI "\fISets the size of the icons to be shown / selected. \fP"
.ti -1c
.RI "int \fBiconSize\fP () const "
.br
.RI "\fIReturns the iconsize set via \fBsetIconSize\fP() or 0, if the default iconsize will be used. \fP"
.ti -1c
.RI "\fBQString\fP \fBselectIcon\fP (\fBKIcon::Group\fP group=KIcon::Desktop, \fBKIcon::Context\fP context=\fBKIcon::Application\fP, bool user=false)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP in \fBKDE\fP 3.0, use the static method getIcon instead. \fP"
.ti -1c
.RI "void \fBsetup\fP (\fBKIcon::Group\fP group, \fBKIcon::Context\fP context=\fBKIcon::Application\fP, bool strictIconSize=false, int iconSize=0, bool user=false)"
.br
.RI "\fIAllows you to set the same parameters as in the class method \fBgetIcon\fP(). \fP"
.ti -1c
.RI "\fBQString\fP \fBopenDialog\fP ()"
.br
.RI "\fI\fBexec()\fPutes this modal dialog and returns the name of the selected icon, or QString::null if the dialog was aborted. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQString\fP \fBgetIcon\fP (\fBKIcon::Group\fP group=KIcon::Desktop, \fBKIcon::Context\fP context=\fBKIcon::Application\fP, bool strictIconSize=false, int iconSize=0, bool user=false, \fBQWidget\fP *parent=0, const  \fBQString\fP &caption=QString::null)"
.br
.RI "\fIPops up the dialog an lets the user select an icon. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Dialog for interactive selection of icons. An icon selection dialog. 

Use the function \fBgetIcon()\fP let the user select an icon.
.PP
Definition at line 92 of file kicondialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KIconDialog::KIconDialog (\fBQWidget\fP * parent = 0L, const char * name = 0L)"
.PP
Constructs an icon selection dialog using the global iconloader. Definition at line 198 of file kicondialog.cpp.
.PP
References KGlobal::iconLoader(), and KStdAccel::name().
.SS "KIconDialog::KIconDialog (\fBKIconLoader\fP * loader, \fBQWidget\fP * parent = 0, const char * name = 0)"
.PP
Constructs an icon selection dialog using a specific iconloader. Definition at line 206 of file kicondialog.cpp.
.PP
References KStdAccel::name().
.SS "KIconDialog::~\fBKIconDialog\fP ()"
.PP
Destructs the dialog. Definition at line 271 of file kicondialog.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KIconDialog::setStrictIconSize (bool b)"
.PP
Sets a strict icon size policy for allowed icons. When true, only icons of the specified group's size in \fBgetIcon\fP() are shown. When false, icons not available at the desired group's size will also be selectable. Definition at line 311 of file kicondialog.cpp.
.SS "bool KIconDialog::strictIconSize () const"
.PP
Returns true if a strict icon size policy is set. Definition at line 316 of file kicondialog.cpp.
.SS "void KIconDialog::setCustomLocation (const \fBQString\fP & location)"
.PP
sets a custom icon directory 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
Definition at line 358 of file kicondialog.cpp.
.PP
Referenced by KIconButton::setIcon().
.SS "void KIconDialog::setIconSize (int size)"
.PP
Sets the size of the icons to be shown / selected. \fBSee also:\fP
.RS 4
\fBKIcon::StdSizes\fP 
.PP
\fBiconSize\fP 
.RE
.PP
Definition at line 321 of file kicondialog.cpp.
.SS "int KIconDialog::iconSize () const"
.PP
Returns the iconsize set via \fBsetIconSize\fP() or 0, if the default iconsize will be used. Definition at line 330 of file kicondialog.cpp.
.SS "\fBQString\fP KIconDialog::selectIcon (\fBKIcon::Group\fP group = KIcon::Desktop, \fBKIcon::Context\fP context = \fBKIcon::Application\fP, bool user = false)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP in \fBKDE\fP 3.0, use the static method getIcon instead. Definition at line 337 of file kicondialog.cpp.
.PP
References openDialog(), and setup().
.SS "void KIconDialog::setup (\fBKIcon::Group\fP group, \fBKIcon::Context\fP context = \fBKIcon::Application\fP, bool strictIconSize = false, int iconSize = 0, bool user = false)"
.PP
Allows you to set the same parameters as in the class method \fBgetIcon\fP(). Definition at line 344 of file kicondialog.cpp.
.PP
References QRadioButton::setChecked(), and QComboBox::setCurrentItem().
.PP
Referenced by getIcon(), and selectIcon().
.SS "\fBQString\fP KIconDialog::openDialog ()"
.PP
\fBexec()\fPutes this modal dialog and returns the name of the selected icon, or QString::null if the dialog was aborted. \fBReturns:\fP
.RS 4
the name of the icon, suitable for loading with \fBKIconLoader\fP. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBgetIcon\fP 
.RE
.PP
Definition at line 363 of file kicondialog.cpp.
.PP
References QFileInfo::baseName(), QDialog::exec(), KIconCanvas::getCurrent(), QString::isEmpty(), and KStdAccel::name().
.PP
Referenced by getIcon(), and selectIcon().
.SS "\fBQString\fP KIconDialog::getIcon (\fBKIcon::Group\fP group = KIcon::Desktop, \fBKIcon::Context\fP context = \fBKIcon::Application\fP, bool strictIconSize = false, int iconSize = 0, bool user = false, \fBQWidget\fP * parent = 0, const \fBQString\fP & caption = QString::null)\fC [static]\fP"
.PP
Pops up the dialog an lets the user select an icon. \fBParameters:\fP
.RS 4
\fIgroup\fP 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. 
.br
\fIcontext\fP The initial icon context. Initially, the icons having this context are shown in the dialog. The user can change this. 
.br
\fIstrictIconSize\fP 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. 
.br
\fIiconSize\fP the size of the icons -- the default of the icongroup if set to 0 
.br
\fIuser\fP Begin with the 'user icons' instead of 'system icons'. 
.RE
.PP
\fBReturns:\fP
.RS 4
The name of the icon, suitable for loading with \fBKIconLoader\fP. 
.RE
.PP
\fBVersion:\fP
.RS 4
New in 3.0 
.RE
.PP
Definition at line 380 of file kicondialog.cpp.
.PP
References QString::isNull(), openDialog(), KDialog::setCaption(), and setup().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
