\section{KIcon\-Theme Class Reference}
\label{classKIconTheme}\index{KIconTheme@{KIconTheme}}
Class to use/access icon themes in {\bf KDE}{\rm (p.\,\pageref{namespaceKDE})}.  


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

Collaboration diagram for KIcon\-Theme:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=227pt]{classKIconTheme__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KIcon\-Theme} (const {\bf QString} \&name, const {\bf QString} \&app\-Name=QString::null)
\item 
{\bf QString} {\bf name} () const 
\item 
{\bf QString} {\bf description} () const 
\item 
{\bf QString} {\bf example} () const 
\item 
{\bf QString} {\bf screenshot} () const 
\item 
{\bf QString} {\bf link\-Overlay} () const 
\item 
{\bf QString} {\bf zip\-Overlay} () const 
\item 
{\bf QString} {\bf lock\-Overlay} () const 
\item 
{\bf QString} {\bf share\-Overlay} () const 
\item 
{\bf QString} {\bf dir} () const 
\item 
{\bf QString\-List} {\bf inherits} () const 
\item 
bool {\bf is\-Valid} () const 
\item 
bool {\bf is\-Hidden} () const 
\item 
int {\bf depth} () const 
\item 
int {\bf default\-Size} ({\bf KIcon::Group} group) const 
\item 
{\bf QValue\-List}$<$ int $>$ {\bf query\-Sizes} ({\bf KIcon::Group} group) const 
\item 
{\bf QString\-List} {\bf query\-Icons} (int size, {\bf KIcon::Context} context=KIcon::Any) const 
\item 
{\bf QString\-List} {\bf query\-Icons\-By\-Context} (int size, {\bf KIcon::Context} context=KIcon::Any) const 
\item 
{\bf KIcon} {\bf icon\-Path} (const {\bf QString} \&name, int size, {\bf KIcon::Match\-Type} match) const 
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static {\bf QString\-List} {\bf list} ()
\item 
static {\bf QString} {\bf current} ()
\item 
static void {\bf reconfigure} ()
\item 
static {\bf QString} {\bf default\-Theme\-Name} ()
\end{CompactItemize}


\subsection{Detailed Description}
Class to use/access icon themes in {\bf KDE}{\rm (p.\,\pageref{namespaceKDE})}. 

This class is used by the iconloader but can be used by others too. \begin{Desc}
\item[See also:]{\bf KIcon\-Loader}{\rm (p.\,\pageref{classKIconLoader})} \end{Desc}




Definition at line 179 of file kicontheme.h.

\subsection{Constructor \& Destructor Documentation}
\index{KIconTheme@{KIcon\-Theme}!KIconTheme@{KIconTheme}}
\index{KIconTheme@{KIconTheme}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KIcon\-Theme::KIcon\-Theme (const {\bf QString} \& {\em name}, const {\bf QString} \& {\em app\-Name} = {\tt QString::null})}\label{classKIconTheme_a0}


Load an icon theme by name. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]the name of the theme (e.g. \char`\"{}hicolor\char`\"{} or \char`\"{}keramik\char`\"{}) \item[{\em app\-Name}]the name of the application. Can be null. This argument allows applications to have themed application icons. \end{description}
\end{Desc}


Definition at line 82 of file kicontheme.cpp.

References QPtr\-List::append(), QValue\-List::begin(), QMap::contains(), dir(), KGlobal::dirs(), QValue\-List::end(), QFile::exists(), KStandard\-Dirs::exists(), QPtr\-List::first(), QString::is\-Empty(), name(), QPtr\-List::next(), KShared\-Config::open\-Config(), KConfig\-Base::read\-Bool\-Entry(), KConfig\-Base::read\-Entry(), KConfig\-Base::read\-Int\-List\-Entry(), KConfig\-Base::read\-List\-Entry(), KConfig\-Base::read\-Num\-Entry(), KConfig\-Base::read\-Path\-Entry(), KConfig\-Base::read\-Path\-List\-Entry(), KStandard\-Dirs::resource\-Dirs(), QPtr\-List::set\-Auto\-Delete(), and KConfig\-Base::set\-Group().

\subsection{Member Function Documentation}
\index{KIconTheme@{KIcon\-Theme}!name@{name}}
\index{name@{name}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::name () const\hspace{0.3cm}{\tt  [inline]}}\label{classKIconTheme_a2}


The stylized name of the icon theme. 

\begin{Desc}
\item[Returns:]the (human-readable) name of the theme \end{Desc}


Definition at line 195 of file kicontheme.h.

Referenced by icon\-Path(), and KIcon\-Theme().\index{KIconTheme@{KIcon\-Theme}!description@{description}}
\index{description@{description}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::description () const\hspace{0.3cm}{\tt  [inline]}}\label{classKIconTheme_a3}


A description for the icon theme. 

\begin{Desc}
\item[Returns:]a human-readable description of the theme, QString::null if there is none \end{Desc}


Definition at line 202 of file kicontheme.h.\index{KIconTheme@{KIcon\-Theme}!example@{example}}
\index{example@{example}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::example () const}\label{classKIconTheme_a4}


Return the name of the \char`\"{}example\char`\"{} icon. 

This can be used to present the theme to the user. \begin{Desc}
\item[Returns:]the name of the example icon, QString::null if there is none \end{Desc}


Definition at line 233 of file kicontheme.cpp.\index{KIconTheme@{KIcon\-Theme}!screenshot@{screenshot}}
\index{screenshot@{screenshot}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::screenshot () const}\label{classKIconTheme_a5}


Return the name of the screenshot. 

\begin{Desc}
\item[Returns:]the name of the screenshot, QString::null if there is none \end{Desc}


Definition at line 234 of file kicontheme.cpp.\index{KIconTheme@{KIcon\-Theme}!linkOverlay@{linkOverlay}}
\index{linkOverlay@{linkOverlay}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::link\-Overlay () const}\label{classKIconTheme_a6}


Returns the name of this theme's link overlay. 

\begin{Desc}
\item[Returns:]the name of the link overlay \end{Desc}


Definition at line 235 of file kicontheme.cpp.

Referenced by KIcon\-Loader::load\-Icon().\index{KIconTheme@{KIcon\-Theme}!zipOverlay@{zipOverlay}}
\index{zipOverlay@{zipOverlay}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::zip\-Overlay () const}\label{classKIconTheme_a7}


Returns the name of this theme's zip overlay. 

\begin{Desc}
\item[Returns:]the name of the zip overlay \end{Desc}


Definition at line 237 of file kicontheme.cpp.

Referenced by KIcon\-Loader::load\-Icon().\index{KIconTheme@{KIcon\-Theme}!lockOverlay@{lockOverlay}}
\index{lockOverlay@{lockOverlay}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::lock\-Overlay () const}\label{classKIconTheme_a8}


Returns the name of this theme's lock overlay. 

\begin{Desc}
\item[Returns:]the name of the lock overlay \end{Desc}


Definition at line 236 of file kicontheme.cpp.

Referenced by KIcon\-Loader::load\-Icon().\index{KIconTheme@{KIcon\-Theme}!shareOverlay@{shareOverlay}}
\index{shareOverlay@{shareOverlay}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::share\-Overlay () const}\label{classKIconTheme_a9}


Returns the name of this theme's share overlay. 

\begin{Desc}
\item[Returns:]the name of the share overlay \end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 238 of file kicontheme.cpp.

Referenced by KIcon\-Loader::load\-Icon().\index{KIconTheme@{KIcon\-Theme}!dir@{dir}}
\index{dir@{dir}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::dir () const\hspace{0.3cm}{\tt  [inline]}}\label{classKIconTheme_a10}


Returns the toplevel theme directory. 

\begin{Desc}
\item[Returns:]the directory of the theme \end{Desc}


Definition at line 246 of file kicontheme.h.

Referenced by icon\-Path(), KIcon\-Theme(), list(), query\-Icons(), and query\-Icons\-By\-Context().\index{KIconTheme@{KIcon\-Theme}!inherits@{inherits}}
\index{inherits@{inherits}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} KIcon\-Theme::inherits () const\hspace{0.3cm}{\tt  [inline]}}\label{classKIconTheme_a11}


The themes this icon theme falls back on. 

\begin{Desc}
\item[Returns:]a list of icon themes that are used as fall-backs \end{Desc}


Definition at line 252 of file kicontheme.h.\index{KIconTheme@{KIcon\-Theme}!isValid@{isValid}}
\index{isValid@{isValid}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KIcon\-Theme::is\-Valid () const}\label{classKIconTheme_a12}


The icon theme exists? 

\begin{Desc}
\item[Returns:]true if the icon theme is valid \end{Desc}


Definition at line 223 of file kicontheme.cpp.

References QPtr\-List::is\-Empty().

Referenced by list().\index{KIconTheme@{KIcon\-Theme}!isHidden@{isHidden}}
\index{isHidden@{isHidden}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KIcon\-Theme::is\-Hidden () const}\label{classKIconTheme_a13}


The icon theme should be hidden to the user? 

\begin{Desc}
\item[Returns:]true if the icon theme is hidden \end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 228 of file kicontheme.cpp.\index{KIconTheme@{KIcon\-Theme}!depth@{depth}}
\index{depth@{depth}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KIcon\-Theme::depth () const\hspace{0.3cm}{\tt  [inline]}}\label{classKIconTheme_a14}


The minimum display depth required for this theme. 

This can either be 8 or 32. \begin{Desc}
\item[Returns:]the minimum bpp (8 or 32) \end{Desc}


Definition at line 272 of file kicontheme.h.\index{KIconTheme@{KIcon\-Theme}!defaultSize@{defaultSize}}
\index{defaultSize@{defaultSize}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KIcon\-Theme::default\-Size ({\bf KIcon::Group} {\em group}) const}\label{classKIconTheme_a15}


The default size of this theme for a certain icon group. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em group}]The icon group. See {\bf KIcon::Group}{\rm (p.\,\pageref{classKIcon_w39})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The default size in pixels for the given icon group. \end{Desc}


Definition at line 240 of file kicontheme.cpp.\index{KIconTheme@{KIcon\-Theme}!querySizes@{querySizes}}
\index{querySizes@{querySizes}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QValue\-List}$<$ int $>$ KIcon\-Theme::query\-Sizes ({\bf KIcon::Group} {\em group}) const}\label{classKIconTheme_a16}


Query available sizes for a group. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em group}]The icon group. See {\bf KIcon::Group}{\rm (p.\,\pageref{classKIcon_w39})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]a list of available sized for the given group \end{Desc}


Definition at line 250 of file kicontheme.cpp.\index{KIconTheme@{KIcon\-Theme}!queryIcons@{queryIcons}}
\index{queryIcons@{queryIcons}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} KIcon\-Theme::query\-Icons (int {\em size}, {\bf KIcon::Context} {\em context} = {\tt KIcon::Any}) const}\label{classKIconTheme_a17}


Query available icons for a size and context. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]the size of the icons \item[{\em context}]the context of the icons \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the list of icon names \end{Desc}


Definition at line 261 of file kicontheme.cpp.

References QPtr\-List\-Iterator::current(), dir(), and QPtr\-List\-Iterator::to\-First().\index{KIconTheme@{KIcon\-Theme}!queryIconsByContext@{queryIconsByContext}}
\index{queryIconsByContext@{queryIconsByContext}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} KIcon\-Theme::query\-Icons\-By\-Context (int {\em size}, {\bf KIcon::Context} {\em context} = {\tt KIcon::Any}) const}\label{classKIconTheme_a18}


Query available icons for a context and preferred size. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]the size of the icons \item[{\em context}]the context of the icons \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the list of icon names \end{Desc}


Definition at line 314 of file kicontheme.cpp.

References QPtr\-List\-Iterator::current(), and dir().\index{KIconTheme@{KIcon\-Theme}!iconPath@{iconPath}}
\index{iconPath@{iconPath}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KIcon} KIcon\-Theme::icon\-Path (const {\bf QString} \& {\em name}, int {\em size}, {\bf KIcon::Match\-Type} {\em match}) const}\label{classKIconTheme_a19}


Lookup an icon in the theme. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]The name of the icon, without extension. \item[{\em size}]The desired size of the icon. \item[{\em match}]The matching mode. {\bf KIcon::Match\-Exact}{\rm (p.\,\pageref{classKIcon_w38w9})} returns an icon only if matches exactly. {\bf KIcon::Match\-Best}{\rm (p.\,\pageref{classKIcon_w38w10})} returns the best matching icon. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A {\bf KIcon}{\rm (p.\,\pageref{classKIcon})} class that describes the icon. If an icon is found, \end{Desc}
\begin{Desc}
\item[See also:]{\bf KIcon::is\-Valid}{\rm (p.\,\pageref{classKIcon_a1})} will return true, and false otherwise. \end{Desc}


Definition at line 343 of file kicontheme.cpp.

References KIcon::context, QPtr\-List\-Iterator::current(), dir(), QString::is\-Empty(), name(), KIcon::path, KIcon::size, KIcon::threshold, and KIcon::type.\index{KIconTheme@{KIcon\-Theme}!list@{list}}
\index{list@{list}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} KIcon\-Theme::list ()\hspace{0.3cm}{\tt  [static]}}\label{classKIconTheme_e0}


List all icon themes installed on the system, global and local. 

\begin{Desc}
\item[Returns:]the list of all icon themes \end{Desc}


Definition at line 448 of file kicontheme.cpp.

References dir(), KGlobal::dirs(), QDir::entry\-List(), QDir::exists(), is\-Valid(), and KStandard\-Dirs::resource\-Dirs().\index{KIconTheme@{KIcon\-Theme}!current@{current}}
\index{current@{current}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::current ()\hspace{0.3cm}{\tt  [static]}}\label{classKIconTheme_e1}


Returns the current icon theme. 

\begin{Desc}
\item[Returns:]the name of the current theme \end{Desc}


Definition at line 426 of file kicontheme.cpp.

References KGlobal::config(), default\-Theme\-Name(), and KConfig\-Base::read\-Entry().\index{KIconTheme@{KIcon\-Theme}!reconfigure@{reconfigure}}
\index{reconfigure@{reconfigure}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIcon\-Theme::reconfigure ()\hspace{0.3cm}{\tt  [static]}}\label{classKIconTheme_e2}


Reconfigure the theme. 



Definition at line 481 of file kicontheme.cpp.

Referenced by KInstance::new\-Icon\-Loader().\index{KIconTheme@{KIcon\-Theme}!defaultThemeName@{defaultThemeName}}
\index{defaultThemeName@{defaultThemeName}!KIconTheme@{KIcon\-Theme}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KIcon\-Theme::default\-Theme\-Name ()\hspace{0.3cm}{\tt  [static]}}\label{classKIconTheme_e3}


Returns the default icon theme. 

\begin{Desc}
\item[Returns:]the name of the default theme name \end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 490 of file kicontheme.cpp.

References QString::from\-Latin1().

Referenced by current().

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