.TH "KIcon" 3 "28 Jan 2004" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIcon \- One icon as found by \fBKIconTheme\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kicontheme.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBContext\fP { \fBAny\fP, \fBAction\fP, \fBApplication\fP, \fBDevice\fP, \fBFileSystem\fP, \fBMimeType\fP }"
.br
.RI "\fIDefines the context of the icon. \fP"
.ti -1c
.RI "enum \fBType\fP { \fBFixed\fP, \fBScalable\fP, \fBThreshold\fP }"
.br
.RI "\fIThe type of the icon. \fP"
.ti -1c
.RI "enum \fBMatchType\fP { \fBMatchExact\fP, \fBMatchBest\fP }"
.br
.RI "\fIThe type of a match. \fP"
.ti -1c
.RI "enum \fBGroup\fP { \fBNoGroup\fP = -1, \fBDesktop\fP = 0, \fBFirstGroup\fP = 0, \fBToolbar\fP, \fBMainToolbar\fP, \fBSmall\fP, \fBPanel\fP, \fBLastGroup\fP, \fBUser\fP }"
.br
.RI "\fIThe group an an icon. \fP"
.ti -1c
.RI "enum \fBStdSizes\fP { \fBSizeSmall\fP = 16, \fBSizeMedium\fP = 32, \fBSizeLarge\fP = 48 }"
.br
.RI "\fIThese are the standard sizes for icons. \fP"
.ti -1c
.RI "enum \fBStates\fP { \fBDefaultState\fP, \fBActiveState\fP, \fBDisabledState\fP, \fBLastState\fP }"
.br
.RI "\fIDefines the possible states of an icon. \fP"
.ti -1c
.RI "enum \fBOverlays\fP { \fBLockOverlay\fP = 0x100, \fBZipOverlay\fP = 0x200, \fBLinkOverlay\fP = 0x400, \fBHiddenOverlay\fP = 0x800, \fBShareOverlay\fP = 0x1000, \fBOverlayMask\fP =  ~0xff }"
.br
.RI "\fIThis defines an overlay, a semi-transparent image that is projected onto the icon. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "bool \fBisValid\fP () const "
.br
.RI "\fIReturn true if this icon is valid, false otherwise. \fP"
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "int \fBsize\fP"
.br
.RI "\fIThe size in pixels of the icon. \fP"
.ti -1c
.RI "\fBContext\fP \fBcontext\fP"
.br
.RI "\fIThe context of the icon. \fP"
.ti -1c
.RI "\fBType\fP \fBtype\fP"
.br
.RI "\fIThe type of the icon: Fixed, Scalable or Threshold. \fP"
.ti -1c
.RI "int \fBthreshold\fP"
.br
.RI "\fIThe threshold in case type == Threshold. \fP"
.ti -1c
.RI "\fBQString\fP \fBpath\fP"
.br
.RI "\fIThe full path of the icon. \fP"
.in -1c
.SH "Detailed Description"
.PP 
One icon as found by \fBKIconTheme\fP. 

Also serves as a namespace containing icon related constants. 
.PP
\fBSee also:\fP
.RS 4
\fBKIconEffect\fP 
.PP
\fBKIconTheme\fP 
.PP
\fBKIconLoader\fP 
.RE
.PP

.PP
Definition at line 36 of file kicontheme.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKIcon::Context\fP"
.PP
Defines the context of the icon. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIAny \fP\fP
Some icon with unknown purpose. 
.TP
\fB\fIAction \fP\fP
An action icon (e.g. 'save', 'print'). 
.TP
\fB\fIApplication \fP\fP
An icon that represents an application. 
.TP
\fB\fIDevice \fP\fP
An icon that represents a device. 
.TP
\fB\fIFileSystem \fP\fP
An icon that represents a file system. 
.TP
\fB\fIMimeType \fP\fP
An icon that represents a mime type (or file type). 
.PP
Definition at line 49 of file kicontheme.h.
.SS "enum \fBKIcon::Type\fP"
.PP
The type of the icon. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIFixed \fP\fP
Fixed-size icon. 
.TP
\fB\fIScalable \fP\fP
Scalable-size icon. 
.TP
\fB\fIThreshold \fP\fP
A threshold icon. 
.PP
Definition at line 61 of file kicontheme.h.
.SS "enum \fBKIcon::MatchType\fP"
.PP
The type of a match. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIMatchExact \fP\fP
Only try to find an exact match. 
.TP
\fB\fIMatchBest \fP\fP
Take the best match if there is no exact match. 
.PP
Definition at line 70 of file kicontheme.h.
.SS "enum \fBKIcon::Group\fP"
.PP
The group an an icon. Definition at line 81 of file kicontheme.h.
.SS "enum \fBKIcon::StdSizes\fP"
.PP
These are the standard sizes for icons. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fISizeSmall \fP\fP
small icons for menu entries 
.TP
\fB\fISizeMedium \fP\fP
medium sized icons for the desktop 
.TP
\fB\fISizeLarge \fP\fP
large sized icons for the panel 
.PP
Definition at line 87 of file kicontheme.h.
.SS "enum \fBKIcon::States\fP"
.PP
Defines the possible states of an icon. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIDefaultState \fP\fP
The default state. 
.TP
\fB\fIActiveState \fP\fP
Icon is active. 
.TP
\fB\fIDisabledState \fP\fP
Icon is disabled. 
.TP
\fB\fILastState \fP\fP
Last state (last constant). 
.PP
Definition at line 98 of file kicontheme.h.
.SS "enum \fBKIcon::Overlays\fP"
.PP
This defines an overlay, a semi-transparent image that is projected onto the icon. They are used to show that the file represented by the icon is, for example, locked, zipped or hidden. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fILockOverlay \fP\fP
a file is locked 
.TP
\fB\fIZipOverlay \fP\fP
a file is zipped 
.TP
\fB\fILinkOverlay \fP\fP
a fileis a link 
.TP
\fB\fIHiddenOverlay \fP\fP
a file is hidden 
.TP
\fB\fIShareOverlay \fP\fP
a file is shared 
.PP
Definition at line 109 of file kicontheme.h.
.SH "Member Function Documentation"
.PP 
.SS "bool KIcon::isValid () const\fC [inline]\fP"
.PP
Return true if this icon is valid, false otherwise. Definition at line 44 of file kicontheme.h.
.PP
References size.
.PP
Referenced by KIconLoader::iconPath(), KIconLoader::loadAnimated(), KIconLoader::loadIcon(), and KIconLoader::moviePath().
.SH "Member Data Documentation"
.PP 
.SS "int \fBKIcon::size\fP"
.PP
The size in pixels of the icon. Definition at line 121 of file kicontheme.h.
.PP
Referenced by KIconTheme::iconPath(), and isValid().
.SS "\fBContext\fP \fBKIcon::context\fP"
.PP
The context of the icon. Definition at line 126 of file kicontheme.h.
.PP
Referenced by KIconTheme::iconPath(), and KIconLoader::loadIcon().
.SS "\fBType\fP \fBKIcon::type\fP"
.PP
The type of the icon: Fixed, Scalable or Threshold. Definition at line 131 of file kicontheme.h.
.PP
Referenced by KIconTheme::iconPath(), and KIconLoader::loadIcon().
.SS "int \fBKIcon::threshold\fP"
.PP
The threshold in case type == Threshold. Definition at line 136 of file kicontheme.h.
.PP
Referenced by KIconTheme::iconPath(), and KIconLoader::loadIcon().
.SS "\fBQString\fP \fBKIcon::path\fP"
.PP
The full path of the icon. Definition at line 141 of file kicontheme.h.
.PP
Referenced by KIconTheme::iconPath(), KIconLoader::iconPath(), KIconLoader::loadAnimated(), KIconLoader::loadIcon(), and KIconLoader::moviePath().

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