\section{KIcon Class Reference}
\label{classKIcon}\index{KIcon@{KIcon}}
One icon as found by {\bf KIcon\-Theme}{\rm (p.\,\pageref{classKIconTheme})}.  


{\tt \#include $<$kicontheme.h$>$}

Collaboration diagram for KIcon:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=43pt]{classKIcon__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Context} \{ \par
{\bf Any}, 
{\bf Action}, 
{\bf Application}, 
{\bf Device}, 
\par
{\bf File\-System}, 
{\bf Mime\-Type}
 \}
\item 
enum {\bf Type} \{ {\bf Fixed}, 
{\bf Scalable}, 
{\bf Threshold}
 \}
\item 
enum {\bf Match\-Type} \{ {\bf Match\-Exact}, 
{\bf Match\-Best}
 \}
\item 
enum {\bf Group} \{ \par
{\bf No\-Group} = -1, 
{\bf Desktop} = 0, 
{\bf First\-Group} = 0, 
{\bf Toolbar}, 
\par
{\bf Main\-Toolbar}, 
{\bf Small}, 
{\bf Panel}, 
{\bf Last\-Group}, 
\par
{\bf User}
 \}
\item 
enum {\bf Std\-Sizes} \{ \par
{\bf Size\-Small} = 16, 
{\bf Size\-Small\-Medium} = 22, 
{\bf Size\-Medium} = 32, 
{\bf Size\-Large} = 48, 
\par
{\bf Size\-Huge} = 64, 
{\bf Size\-Enormous} = 128
 \}
\item 
enum {\bf States} \{ {\bf Default\-State}, 
{\bf Active\-State}, 
{\bf Disabled\-State}, 
{\bf Last\-State}
 \}
\item 
enum {\bf Overlays} \{ \par
{\bf Lock\-Overlay} = 0x100, 
{\bf Zip\-Overlay} = 0x200, 
{\bf Link\-Overlay} = 0x400, 
{\bf Hidden\-Overlay} = 0x800, 
\par
{\bf Share\-Overlay} = 0x1000, 
{\bf Overlay\-Mask} =  $\sim$0xff
 \}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
bool {\bf is\-Valid} () const 
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
int {\bf size}
\item 
{\bf Context} {\bf context}
\item 
{\bf Type} {\bf type}
\item 
int {\bf threshold}
\item 
{\bf QString} {\bf path}
\end{CompactItemize}


\subsection{Detailed Description}
One icon as found by {\bf KIcon\-Theme}{\rm (p.\,\pageref{classKIconTheme})}. 

Also serves as a namespace containing icon related constants. \begin{Desc}
\item[See also:]{\bf KIcon\-Effect}{\rm (p.\,\pageref{classKIconEffect})} 

{\bf KIcon\-Theme}{\rm (p.\,\pageref{classKIconTheme})} 

{\bf KIcon\-Loader}{\rm (p.\,\pageref{classKIconLoader})} \end{Desc}




Definition at line 35 of file kicontheme.h.

\subsection{Member Enumeration Documentation}
\index{KIcon@{KIcon}!Context@{Context}}
\index{Context@{Context}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KIcon::Context}}\label{classKIcon_w36}


Defines the context of the icon. 

\begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{Any@{Any}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Any@{Any}}\item[{\em 
Any\label{classKIcon_w36w0}
}]Some icon with unknown purpose. \index{Action@{Action}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Action@{Action}}\item[{\em 
Action\label{classKIcon_w36w1}
}]An action icon (e.g. 'save', 'print'). \index{Application@{Application}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Application@{Application}}\item[{\em 
Application\label{classKIcon_w36w2}
}]An icon that represents an application. \index{Device@{Device}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Device@{Device}}\item[{\em 
Device\label{classKIcon_w36w3}
}]An icon that represents a device. \index{FileSystem@{FileSystem}!KIcon@{KIcon}}\index{KIcon@{KIcon}!FileSystem@{FileSystem}}\item[{\em 
File\-System\label{classKIcon_w36w4}
}]An icon that represents a file system. \index{MimeType@{MimeType}!KIcon@{KIcon}}\index{KIcon@{KIcon}!MimeType@{MimeType}}\item[{\em 
Mime\-Type\label{classKIcon_w36w5}
}]An icon that represents a mime type (or file type). \end{description}
\end{Desc}



Definition at line 48 of file kicontheme.h.\index{KIcon@{KIcon}!Type@{Type}}
\index{Type@{Type}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KIcon::Type}}\label{classKIcon_w37}


The type of the icon. 

\begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{Fixed@{Fixed}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Fixed@{Fixed}}\item[{\em 
Fixed\label{classKIcon_w37w6}
}]Fixed-size icon. \index{Scalable@{Scalable}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Scalable@{Scalable}}\item[{\em 
Scalable\label{classKIcon_w37w7}
}]Scalable-size icon. \index{Threshold@{Threshold}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Threshold@{Threshold}}\item[{\em 
Threshold\label{classKIcon_w37w8}
}]A threshold icon. \end{description}
\end{Desc}



Definition at line 60 of file kicontheme.h.\index{KIcon@{KIcon}!MatchType@{MatchType}}
\index{MatchType@{MatchType}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KIcon::Match\-Type}}\label{classKIcon_w38}


The type of a match. 

\begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{MatchExact@{MatchExact}!KIcon@{KIcon}}\index{KIcon@{KIcon}!MatchExact@{MatchExact}}\item[{\em 
Match\-Exact\label{classKIcon_w38w9}
}]Only try to find an exact match. \index{MatchBest@{MatchBest}!KIcon@{KIcon}}\index{KIcon@{KIcon}!MatchBest@{MatchBest}}\item[{\em 
Match\-Best\label{classKIcon_w38w10}
}]Take the best match if there is no exact match. \end{description}
\end{Desc}



Definition at line 69 of file kicontheme.h.\index{KIcon@{KIcon}!Group@{Group}}
\index{Group@{Group}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KIcon::Group}}\label{classKIcon_w39}


The group of the icon. 

\begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{NoGroup@{NoGroup}!KIcon@{KIcon}}\index{KIcon@{KIcon}!NoGroup@{NoGroup}}\item[{\em 
No\-Group\label{classKIcon_w39w11}
}]No group. \index{Desktop@{Desktop}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Desktop@{Desktop}}\item[{\em 
Desktop\label{classKIcon_w39w12}
}]Desktop icons. \index{FirstGroup@{FirstGroup}!KIcon@{KIcon}}\index{KIcon@{KIcon}!FirstGroup@{FirstGroup}}\item[{\em 
First\-Group\label{classKIcon_w39w13}
}]First group. \index{Toolbar@{Toolbar}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Toolbar@{Toolbar}}\item[{\em 
Toolbar\label{classKIcon_w39w14}
}]Toolbar icons. \index{MainToolbar@{MainToolbar}!KIcon@{KIcon}}\index{KIcon@{KIcon}!MainToolbar@{MainToolbar}}\item[{\em 
Main\-Toolbar\label{classKIcon_w39w15}
}]Main toolbar icons. \index{Small@{Small}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Small@{Small}}\item[{\em 
Small\label{classKIcon_w39w16}
}]Small icons. \index{Panel@{Panel}!KIcon@{KIcon}}\index{KIcon@{KIcon}!Panel@{Panel}}\item[{\em 
Panel\label{classKIcon_w39w17}
}]Panel (Kicker) icons. \index{LastGroup@{LastGroup}!KIcon@{KIcon}}\index{KIcon@{KIcon}!LastGroup@{LastGroup}}\item[{\em 
Last\-Group\label{classKIcon_w39w18}
}]Last group. \index{User@{User}!KIcon@{KIcon}}\index{KIcon@{KIcon}!User@{User}}\item[{\em 
User\label{classKIcon_w39w19}
}]User icons. \end{description}
\end{Desc}



Definition at line 80 of file kicontheme.h.\index{KIcon@{KIcon}!StdSizes@{StdSizes}}
\index{StdSizes@{StdSizes}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KIcon::Std\-Sizes}}\label{classKIcon_w40}


These are the standard sizes for icons. 

\begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{SizeSmall@{SizeSmall}!KIcon@{KIcon}}\index{KIcon@{KIcon}!SizeSmall@{SizeSmall}}\item[{\em 
Size\-Small\label{classKIcon_w40w20}
}]small icons for menu entries \index{SizeSmallMedium@{SizeSmallMedium}!KIcon@{KIcon}}\index{KIcon@{KIcon}!SizeSmallMedium@{SizeSmallMedium}}\item[{\em 
Size\-Small\-Medium\label{classKIcon_w40w21}
}]slightly larger small icons for toolbars, panels, etc \index{SizeMedium@{SizeMedium}!KIcon@{KIcon}}\index{KIcon@{KIcon}!SizeMedium@{SizeMedium}}\item[{\em 
Size\-Medium\label{classKIcon_w40w22}
}]medium sized icons for the desktop \index{SizeLarge@{SizeLarge}!KIcon@{KIcon}}\index{KIcon@{KIcon}!SizeLarge@{SizeLarge}}\item[{\em 
Size\-Large\label{classKIcon_w40w23}
}]large sized icons for the panel \index{SizeHuge@{SizeHuge}!KIcon@{KIcon}}\index{KIcon@{KIcon}!SizeHuge@{SizeHuge}}\item[{\em 
Size\-Huge\label{classKIcon_w40w24}
}]huge sized icons for iconviews \index{SizeEnormous@{SizeEnormous}!KIcon@{KIcon}}\index{KIcon@{KIcon}!SizeEnormous@{SizeEnormous}}\item[{\em 
Size\-Enormous\label{classKIcon_w40w25}
}]enormous sized icons for iconviews \end{description}
\end{Desc}



Definition at line 104 of file kicontheme.h.\index{KIcon@{KIcon}!States@{States}}
\index{States@{States}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KIcon::States}}\label{classKIcon_w41}


Defines the possible states of an icon. 

\begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{DefaultState@{DefaultState}!KIcon@{KIcon}}\index{KIcon@{KIcon}!DefaultState@{DefaultState}}\item[{\em 
Default\-State\label{classKIcon_w41w26}
}]The default state. \index{ActiveState@{ActiveState}!KIcon@{KIcon}}\index{KIcon@{KIcon}!ActiveState@{ActiveState}}\item[{\em 
Active\-State\label{classKIcon_w41w27}
}]Icon is active. \index{DisabledState@{DisabledState}!KIcon@{KIcon}}\index{KIcon@{KIcon}!DisabledState@{DisabledState}}\item[{\em 
Disabled\-State\label{classKIcon_w41w28}
}]Icon is disabled. \index{LastState@{LastState}!KIcon@{KIcon}}\index{KIcon@{KIcon}!LastState@{LastState}}\item[{\em 
Last\-State\label{classKIcon_w41w29}
}]Last state (last constant). \end{description}
\end{Desc}



Definition at line 122 of file kicontheme.h.\index{KIcon@{KIcon}!Overlays@{Overlays}}
\index{Overlays@{Overlays}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KIcon::Overlays}}\label{classKIcon_w42}


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. \begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{LockOverlay@{LockOverlay}!KIcon@{KIcon}}\index{KIcon@{KIcon}!LockOverlay@{LockOverlay}}\item[{\em 
Lock\-Overlay\label{classKIcon_w42w30}
}]a file is locked \index{ZipOverlay@{ZipOverlay}!KIcon@{KIcon}}\index{KIcon@{KIcon}!ZipOverlay@{ZipOverlay}}\item[{\em 
Zip\-Overlay\label{classKIcon_w42w31}
}]a file is zipped \index{LinkOverlay@{LinkOverlay}!KIcon@{KIcon}}\index{KIcon@{KIcon}!LinkOverlay@{LinkOverlay}}\item[{\em 
Link\-Overlay\label{classKIcon_w42w32}
}]a file is a link \index{HiddenOverlay@{HiddenOverlay}!KIcon@{KIcon}}\index{KIcon@{KIcon}!HiddenOverlay@{HiddenOverlay}}\item[{\em 
Hidden\-Overlay\label{classKIcon_w42w33}
}]a file is hidden \index{ShareOverlay@{ShareOverlay}!KIcon@{KIcon}}\index{KIcon@{KIcon}!ShareOverlay@{ShareOverlay}}\item[{\em 
Share\-Overlay\label{classKIcon_w42w34}
}]a file is shared \end{description}
\end{Desc}



Definition at line 133 of file kicontheme.h.

\subsection{Member Function Documentation}
\index{KIcon@{KIcon}!isValid@{isValid}}
\index{isValid@{isValid}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KIcon::is\-Valid () const\hspace{0.3cm}{\tt  [inline]}}\label{classKIcon_a1}


Return true if this icon is valid, false otherwise. 



Definition at line 43 of file kicontheme.h.

Referenced by KIcon\-Loader::icon\-Path(), KIcon\-Loader::load\-Animated(), KIcon\-Loader::load\-Icon(), and KIcon\-Loader::movie\-Path().

\subsection{Member Data Documentation}
\index{KIcon@{KIcon}!size@{size}}
\index{size@{size}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf KIcon::size}}\label{classKIcon_o0}


The size in pixels of the icon. 



Definition at line 145 of file kicontheme.h.

Referenced by KIcon\-Theme::icon\-Path().\index{KIcon@{KIcon}!context@{context}}
\index{context@{context}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Context} {\bf KIcon::context}}\label{classKIcon_o1}


The context of the icon. 



Definition at line 150 of file kicontheme.h.

Referenced by KIcon\-Theme::icon\-Path(), and KIcon\-Loader::load\-Icon().\index{KIcon@{KIcon}!type@{type}}
\index{type@{type}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Type} {\bf KIcon::type}}\label{classKIcon_o2}


The type of the icon: Fixed, Scalable or Threshold. 



Definition at line 155 of file kicontheme.h.

Referenced by KIcon\-Theme::icon\-Path(), and KIcon\-Loader::load\-Icon().\index{KIcon@{KIcon}!threshold@{threshold}}
\index{threshold@{threshold}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf KIcon::threshold}}\label{classKIcon_o3}


The threshold in case type == Threshold. 



Definition at line 160 of file kicontheme.h.

Referenced by KIcon\-Theme::icon\-Path(), and KIcon\-Loader::load\-Icon().\index{KIcon@{KIcon}!path@{path}}
\index{path@{path}!KIcon@{KIcon}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} {\bf KIcon::path}}\label{classKIcon_o4}


The full path of the icon. 



Definition at line 165 of file kicontheme.h.

Referenced by KIcon\-Theme::icon\-Path(), KIcon\-Loader::icon\-Path(), KIcon\-Loader::load\-Animated(), KIcon\-Loader::load\-Icon(), and KIcon\-Loader::movie\-Path().

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
kicontheme.h\end{CompactItemize}
