\section{KConfig\-Skeleton\-Item Class Reference}
\label{classKConfigSkeletonItem}\index{KConfigSkeletonItem@{KConfigSkeletonItem}}
Class for storing a preferences setting.  


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

Collaboration diagram for KConfig\-Skeleton\-Item:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=73pt]{classKConfigSkeletonItem__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
typedef {\bf QValue\-List}$<$ {\bf KConfig\-Skeleton\-Item} $\ast$ $>$ {\bf List}\label{classKConfigSkeletonItem_w0}

\item 
typedef {\bf QDict}$<$ {\bf KConfig\-Skeleton\-Item} $>$ {\bf Dict}\label{classKConfigSkeletonItem_w1}

\item 
typedef {\bf QDict\-Iterator}$<$ {\bf KConfig\-Skeleton\-Item} $>$ {\bf Dict\-Iterator}\label{classKConfigSkeletonItem_w2}

\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KConfig\-Skeleton\-Item} (const {\bf QString} \&group, const {\bf QString} \&key)
\item 
virtual {\bf $\sim$KConfig\-Skeleton\-Item} ()
\item 
void {\bf set\-Group} (const {\bf QString} \&group)
\item 
{\bf QString} {\bf group} () const 
\item 
void {\bf set\-Key} (const {\bf QString} \&key)
\item 
{\bf QString} {\bf key} () const 
\item 
void {\bf set\-Name} (const {\bf QString} \&name)
\item 
{\bf QString} {\bf name} () const 
\item 
void {\bf set\-Label} (const {\bf QString} \&l)
\item 
{\bf QString} {\bf label} () const 
\item 
void {\bf set\-Whats\-This} (const {\bf QString} \&w)
\item 
{\bf QString} {\bf whats\-This} () const 
\item 
virtual void {\bf read\-Config} ({\bf KConfig} $\ast$)=0
\item 
virtual void {\bf write\-Config} ({\bf KConfig} $\ast$)=0
\item 
virtual void {\bf read\-Default} ({\bf KConfig} $\ast$)=0
\item 
virtual void {\bf set\-Property} (const {\bf QVariant} \&p)=0
\item 
virtual {\bf QVariant} {\bf property} () const =0
\item 
virtual {\bf QVariant} {\bf min\-Value} () const 
\item 
virtual {\bf QVariant} {\bf max\-Value} () const 
\item 
virtual void {\bf set\-Default} ()=0
\item 
virtual void {\bf swap\-Default} ()=0
\item 
bool {\bf is\-Immutable} () const 
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf read\-Immutability} ({\bf KConfig} $\ast$config)
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf QString} {\bf m\-Group}\label{classKConfigSkeletonItem_p0}

\item 
{\bf QString} {\bf m\-Key}\label{classKConfigSkeletonItem_p1}

\item 
{\bf QString} {\bf m\-Name}\label{classKConfigSkeletonItem_p2}

\end{CompactItemize}


\subsection{Detailed Description}
Class for storing a preferences setting. 

\begin{Desc}
\item[Author:]Cornelius Schumacher \end{Desc}
\begin{Desc}
\item[See also:]{\bf KConfig\-Skeleton}{\rm (p.\,\pageref{classKConfigSkeleton})}\end{Desc}
This class represents one preferences setting as used by {\bf KConfig\-Skeleton}{\rm (p.\,\pageref{classKConfigSkeleton})}. Subclasses of KConfig\-Skeleton\-Item implement storage functions for a certain type of setting. Normally you don't have to use this class directly. Use the special add\-Item() functions of {\bf KConfig\-Skeleton}{\rm (p.\,\pageref{classKConfigSkeleton})} instead. If you subclass this class you will have to register instances with the function {\bf KConfig\-Skeleton::add\-Item()}{\rm (p.\,\pageref{classKConfigSkeleton_a8})}. 



Definition at line 50 of file kconfigskeleton.h.

\subsection{Constructor \& Destructor Documentation}
\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!KConfigSkeletonItem@{KConfigSkeletonItem}}
\index{KConfigSkeletonItem@{KConfigSkeletonItem}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KConfig\-Skeleton\-Item::KConfig\-Skeleton\-Item (const {\bf QString} \& {\em group}, const {\bf QString} \& {\em key})\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a0}


Constructor. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em group}]Config file group. \item[{\em key}]Config file key. \end{description}
\end{Desc}


Definition at line 63 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!~KConfigSkeletonItem@{$\sim$KConfigSkeletonItem}}
\index{~KConfigSkeletonItem@{$\sim$KConfigSkeletonItem}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual KConfig\-Skeleton\-Item::$\sim${\bf KConfig\-Skeleton\-Item} ()\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKConfigSkeletonItem_a1}


Destructor. 



Definition at line 71 of file kconfigskeleton.h.

\subsection{Member Function Documentation}
\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!setGroup@{setGroup}}
\index{setGroup@{setGroup}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Skeleton\-Item::set\-Group (const {\bf QString} \& {\em group})\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a2}


Set config file group. 



Definition at line 78 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!group@{group}}
\index{group@{group}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KConfig\-Skeleton\-Item::group () const\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a3}


Return config file group. 



Definition at line 86 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!setKey@{setKey}}
\index{setKey@{setKey}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Skeleton\-Item::set\-Key (const {\bf QString} \& {\em key})\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a4}


Set config file key. 



Definition at line 94 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!key@{key}}
\index{key@{key}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KConfig\-Skeleton\-Item::key () const\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a5}


Return config file key. 



Definition at line 102 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!setName@{setName}}
\index{setName@{setName}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Skeleton\-Item::set\-Name (const {\bf QString} \& {\em name})\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a6}


Set internal name of entry. 



Definition at line 110 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!name@{name}}
\index{name@{name}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KConfig\-Skeleton\-Item::name () const\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a7}


Return internal name of entry. 



Definition at line 118 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!setLabel@{setLabel}}
\index{setLabel@{setLabel}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Skeleton\-Item::set\-Label (const {\bf QString} \& {\em l})\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a8}


Set label providing a translated one-line description of the item. 



Definition at line 126 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!label@{label}}
\index{label@{label}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KConfig\-Skeleton\-Item::label () const\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a9}


Return label of item. 

See {\bf set\-Label()}{\rm (p.\,\pageref{classKConfigSkeletonItem_a8})}. 

Definition at line 134 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!setWhatsThis@{setWhatsThis}}
\index{setWhatsThis@{setWhatsThis}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Skeleton\-Item::set\-Whats\-This (const {\bf QString} \& {\em w})\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a10}


Set Whats\-This description og item. 



Definition at line 142 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!whatsThis@{whatsThis}}
\index{whatsThis@{whatsThis}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KConfig\-Skeleton\-Item::whats\-This () const\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a11}


Return Whats\-This description of item. 

See {\bf set\-Whats\-This()}{\rm (p.\,\pageref{classKConfigSkeletonItem_a10})}. 

Definition at line 150 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!readConfig@{readConfig}}
\index{readConfig@{readConfig}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KConfig\-Skeleton\-Item::read\-Config ({\bf KConfig} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKConfigSkeletonItem_a12}


This function is called by {\bf KConfig\-Skeleton}{\rm (p.\,\pageref{classKConfigSkeleton})} to read the value for this setting from a config file. 

value. 

Implemented in {\bf KConfig\-Skeleton::Item\-Double} {\rm (p.\,\pageref{classKConfigSkeleton_1_1ItemDouble_a1})}.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!writeConfig@{writeConfig}}
\index{writeConfig@{writeConfig}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KConfig\-Skeleton\-Item::write\-Config ({\bf KConfig} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKConfigSkeletonItem_a13}


This function is called by {\bf KConfig\-Skeleton}{\rm (p.\,\pageref{classKConfigSkeleton})} to write the value of this setting to a config file. 

\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!readDefault@{readDefault}}
\index{readDefault@{readDefault}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KConfig\-Skeleton\-Item::read\-Default ({\bf KConfig} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKConfigSkeletonItem_a14}


Read global default value. 

\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!setProperty@{setProperty}}
\index{setProperty@{setProperty}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KConfig\-Skeleton\-Item::set\-Property (const {\bf QVariant} \& {\em p})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKConfigSkeletonItem_a15}


Set item to {\tt p}. 



Implemented in {\bf KConfig\-Skeleton::Item\-Double} {\rm (p.\,\pageref{classKConfigSkeleton_1_1ItemDouble_a2})}.

Referenced by KConfig\-Dialog\-Manager::update\-Settings().\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!property@{property}}
\index{property@{property}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QVariant} KConfig\-Skeleton\-Item::property () const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKConfigSkeletonItem_a16}


Return item as property. 



Implemented in {\bf KConfig\-Skeleton::Item\-Double} {\rm (p.\,\pageref{classKConfigSkeleton_1_1ItemDouble_a3})}.

Referenced by KConfig\-Dialog\-Manager::has\-Changed(), KConfig\-Dialog\-Manager::update\-Settings(), and KConfig\-Dialog\-Manager::update\-Widgets().\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!minValue@{minValue}}
\index{minValue@{minValue}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QVariant} KConfig\-Skeleton\-Item::min\-Value () const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKConfigSkeletonItem_a17}


Return minimum value of item or invalid if not specified. 



Reimplemented in {\bf KConfig\-Skeleton::Item\-Double} {\rm (p.\,\pageref{classKConfigSkeleton_1_1ItemDouble_a4})}.

Definition at line 186 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!maxValue@{maxValue}}
\index{maxValue@{maxValue}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QVariant} KConfig\-Skeleton\-Item::max\-Value () const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKConfigSkeletonItem_a18}


Return maximum value of item or invalid if not specified. 



Reimplemented in {\bf KConfig\-Skeleton::Item\-Double} {\rm (p.\,\pageref{classKConfigSkeleton_1_1ItemDouble_a5})}.

Definition at line 191 of file kconfigskeleton.h.\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!setDefault@{setDefault}}
\index{setDefault@{setDefault}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KConfig\-Skeleton\-Item::set\-Default ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKConfigSkeletonItem_a19}


Sets the current value to the default value. 

\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!swapDefault@{swapDefault}}
\index{swapDefault@{swapDefault}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KConfig\-Skeleton\-Item::swap\-Default ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKConfigSkeletonItem_a20}


Exchanges the current value with the default value Used by {\bf KConfig\-Skeleton::use\-Defaults(bool)}{\rm (p.\,\pageref{classKConfigSkeleton_a33})};. 

\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!isImmutable@{isImmutable}}
\index{isImmutable@{isImmutable}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KConfig\-Skeleton\-Item::is\-Immutable () const\hspace{0.3cm}{\tt  [inline]}}\label{classKConfigSkeletonItem_a21}


Return if the entry can be modified. 



Definition at line 207 of file kconfigskeleton.h.

Referenced by KConfig\-Skeleton::is\-Immutable(), and KConfig\-Dialog\-Manager::update\-Widgets().\index{KConfigSkeletonItem@{KConfig\-Skeleton\-Item}!readImmutability@{readImmutability}}
\index{readImmutability@{readImmutability}!KConfigSkeletonItem@{KConfig\-Skeleton\-Item}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Skeleton\-Item::read\-Immutability ({\bf KConfig} $\ast$ {\em config})\hspace{0.3cm}{\tt  [protected]}}\label{classKConfigSkeletonItem_b0}


sets m\-Is\-Immutable to true if m\-Key in config is immutable 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em config}]{\bf KConfig}{\rm (p.\,\pageref{classKConfig})} to check if m\-Key is immutable in \end{description}
\end{Desc}


Definition at line 35 of file kconfigskeleton.cpp.

Referenced by KConfig\-Skeleton::Item\-Double::read\-Config().

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