.TH "KIconView" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIconView \- This Widget extends the functionality of \fBQIconView\fP to honor the system wide settings for Single Click/Double Click mode, Auto Selection and Change Cursor over Link. A variant of \fBQIconView\fP that honors KDE's system-wide settings.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kiconview.h>\fP
.PP
Inherits \fBQIconView\fP.
.PP
Inherited by \fBKFileIconView\fP, and \fBKIconCanvas\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBMode\fP { \fBExecute\fP, \fBSelect\fP }"
.br
.RI "\fIKIconView has two different operating modes. \fP"
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBexecuted\fP (\fBQIconViewItem\fP *item)"
.br
.RI "\fIThis signal is emitted whenever the user executes an iconview item. \fP"
.ti -1c
.RI "void \fBexecuted\fP (\fBQIconViewItem\fP *item, const  \fBQPoint\fP &pos)"
.br
.RI "\fIThis signal is emitted whenever the user executes an iconview item. \fP"
.ti -1c
.RI "void \fBdoubleClicked\fP (\fBQIconViewItem\fP *item, const  \fBQPoint\fP &pos)"
.br
.RI "\fIThis signal gets emitted whenever the user double clicks into the iconview. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKIconView\fP (\fBQWidget\fP *parent=0, const  char *name=0, WFlags f=0)"
.br
.ti -1c
.RI "void \fBsetMode\fP (\fBMode\fP m)"
.br
.RI "\fISets the mode to Execute or Select. \fP"
.ti -1c
.RI "\fBMode\fP \fBmode\fP () const "
.br
.ti -1c
.RI "virtual void \fBsetFont\fP (const  \fBQFont\fP &)"
.br
.RI "\fIReimplemented for internal purposes. \fP"
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotOnItem\fP (\fBQIconViewItem\fP *item)"
.br
.ti -1c
.RI "void \fBslotOnViewport\fP ()"
.br
.ti -1c
.RI "void \fBslotSettingsChanged\fP (int)"
.br
.ti -1c
.RI "void \fBslotAutoSelect\fP ()"
.br
.RI "\fIAuto selection happend. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBemitExecute\fP (\fBQIconViewItem\fP *item, const  \fBQPoint\fP &pos)"
.br
.ti -1c
.RI "virtual void \fBfocusOutEvent\fP (\fBQFocusEvent\fP *fe)"
.br
.ti -1c
.RI "virtual void \fBleaveEvent\fP (\fBQEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBcontentsMousePressEvent\fP (\fBQMouseEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBcontentsMouseDoubleClickEvent\fP (\fBQMouseEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBcontentsMouseReleaseEvent\fP (\fBQMouseEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKIconViewItem\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This Widget extends the functionality of \fBQIconView\fP to honor the system wide settings for Single Click/Double Click mode, Auto Selection and Change Cursor over Link. A variant of \fBQIconView\fP that honors KDE's system-wide settings. 

There is a new signal \fBexecuted()\fP. It gets connected to either \fBQIconView::clicked\fP() or \fBQIconView::doubleClicked\fP() depending on the \fBKDE\fP wide Single Click/Double Click settings. It is strongly recomended that you use this signal instead of the above mentioned. This way you donīt need to care about the current settings. If you want to get informed when the user selects something connect to the \fBQIconView::selectionChanged\fP() signal.
.PP
Definition at line 39 of file kiconview.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBKIconView::Mode\fP"
.PP
KIconView has two different operating modes. Execute mode is depending on the configuration of single-click or double-click where the signal \fBexecuted()\fP will be emitted upon click/double-click. In Select mode, this signal will not be emitted.
.PP
Default is Execute mode. Definition at line 59 of file kiconview.h.
.PP
Referenced by mode().
.SH "Member Function Documentation"
.PP 
.SS "void KIconView::setMode (\fBMode\fP m)"
.PP
Sets the mode to Execute or Select. .IP "\(bu" 2
In Execute mode, the signal \fBexecuted()\fP will be emitted when the user clicks/double-clicks an item. 
.IP "\(bu" 2
Select mode is the normal \fBQIconView\fP mode.
.PP
Default is Execute. Definition at line 82 of file kiconview.cpp.
.SS "\fBKIconView::Mode\fP KIconView::mode () const"
.PP
\fBReturns:\fP
.RS 4
the current Mode, either Execute or Select. 
.RE
.PP
Definition at line 87 of file kiconview.cpp.
.PP
References Mode.
.SS "void KIconView::setFont (const \fBQFont\fP &)\fC [virtual]\fP"
.PP
Reimplemented for internal purposes. Definition at line 328 of file kiconview.cpp.
.SS "void KIconView::executed (\fBQIconViewItem\fP * item)\fC [signal]\fP"
.PP
This signal is emitted whenever the user executes an iconview item. That means depending on the \fBKDE\fP wide Single Click/Double Click setting the user clicked or double clicked on that item. 
.PP
\fBParameters:\fP
.RS 4
\fIitem\fP is the pointer to the executed iconview item.
.RE
.PP
Note that you may not delete any \fBQIconViewItem\fP objects in slots connected to this signal. 
.SS "void KIconView::executed (\fBQIconViewItem\fP * item, const \fBQPoint\fP & pos)\fC [signal]\fP"
.PP
This signal is emitted whenever the user executes an iconview item. That means depending on the \fBKDE\fP wide Single Click/Double Click setting the user clicked or double clicked on that item. 
.PP
\fBParameters:\fP
.RS 4
\fIitem\fP is the pointer to the executed iconview item. 
.br
\fIpos\fP is the position where the user has clicked
.RE
.PP
Note that you may not delete any \fBQIconViewItem\fP objects in slots connected to this signal. 
.SS "void KIconView::doubleClicked (\fBQIconViewItem\fP * item, const \fBQPoint\fP & pos)\fC [signal]\fP"
.PP
This signal gets emitted whenever the user double clicks into the iconview. \fBParameters:\fP
.RS 4
\fIitem\fP is the pointer to the clicked iconview item. 
.br
\fIpos\fP is the position where the user has clicked, and
.RE
.PP
Note that you may not delete any \fBQIconViewItem\fP objects in slots connected to this signal.
.PP
This signal is more or less here for the sake of completeness. You should normally not need to use this. In most cases itīs better to use \fBexecuted\fP() instead. 
.SS "void KIconView::slotAutoSelect ()\fC [protected, slot]\fP"
.PP
Auto selection happend. Definition at line 152 of file kiconview.cpp.
.PP
References QIconView::clearSelection(), QIconView::currentItem(), QIconView::firstItem(), QIconViewItem::height(), QIconView::index(), QIconViewItem::intersects(), QIconViewItem::isSelected(), QIconViewItem::nextItem(), QRect::normalize(), QIconViewItem::rect(), QIconView::selectionChanged(), QIconView::selectionMode(), QIconView::setCurrentItem(), QRect::setHeight(), QIconView::setSelected(), QRect::setWidth(), QRect::unite(), QIconViewItem::width(), QIconViewItem::x(), and QIconViewItem::y().

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