\section{KConfig\-Group Class Reference}
\label{classKConfigGroup}\index{KConfigGroup@{KConfigGroup}}
A {\bf KConfig\-Base}{\rm (p.\,\pageref{classKConfigBase})} derived class for one specific group in a {\bf KConfig}{\rm (p.\,\pageref{classKConfig})} object.  


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

Inheritance diagram for KConfig\-Group:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=57pt]{classKConfigGroup__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KConfig\-Group:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=230pt]{classKConfigGroup__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KConfig\-Group} ({\bf KConfig\-Base} $\ast$master, const {\bf QCString} \&group)
\item 
{\bf KConfig\-Group} ({\bf KConfig\-Base} $\ast$master, const {\bf QString} \&group)
\item 
{\bf KConfig\-Group} ({\bf KConfig\-Base} $\ast$master, const char $\ast$group)
\item 
void {\bf delete\-Group} (bool b\-Global=false)
\item 
bool {\bf group\-Is\-Immutable} () const 
\item 
virtual void {\bf set\-Dirty} (bool b)
\item 
virtual void {\bf put\-Data} (const {\bf KEntry\-Key} \&\_\-key, const {\bf KEntry} \&\_\-data, bool \_\-check\-Group=true)
\item 
virtual {\bf KEntry} {\bf lookup\-Data} (const {\bf KEntry\-Key} \&\_\-key) const 
\item 
virtual void {\bf sync} ()
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKConfigGroup_b0}

\end{CompactItemize}


\subsection{Detailed Description}
A {\bf KConfig\-Base}{\rm (p.\,\pageref{classKConfigBase})} derived class for one specific group in a {\bf KConfig}{\rm (p.\,\pageref{classKConfig})} object. 



Definition at line 2095 of file kconfigbase.h.

\subsection{Constructor \& Destructor Documentation}
\index{KConfigGroup@{KConfig\-Group}!KConfigGroup@{KConfigGroup}}
\index{KConfigGroup@{KConfigGroup}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KConfig\-Group::KConfig\-Group ({\bf KConfig\-Base} $\ast$ {\em master}, const {\bf QCString} \& {\em group})}\label{classKConfigGroup_a0}


Construct a config group corresponding to {\tt group} in {\tt master}. 

{\tt group} is the group name encoded in UTF-8. 

Definition at line 1777 of file kconfigbase.cpp.

References KConfig\-Base::a\-Locale\-String, KConfig\-Base::back\-End, KConfig\-Base::b\-Read\-Only, KConfig\-Base::read\-Defaults(), and KConfig\-Base::set\-Read\-Defaults().\index{KConfigGroup@{KConfig\-Group}!KConfigGroup@{KConfigGroup}}
\index{KConfigGroup@{KConfigGroup}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KConfig\-Group::KConfig\-Group ({\bf KConfig\-Base} $\ast$ {\em master}, const {\bf QString} \& {\em group})}\label{classKConfigGroup_a1}


This is an overloaded constructor provided for convenience. 

It behaves essentially like the above function.

Construct a config group corresponding to {\tt group} in {\tt master} 

Definition at line 1764 of file kconfigbase.cpp.

References KConfig\-Base::a\-Locale\-String, KConfig\-Base::back\-End, KConfig\-Base::b\-Read\-Only, KConfig\-Base::read\-Defaults(), and KConfig\-Base::set\-Read\-Defaults().\index{KConfigGroup@{KConfig\-Group}!KConfigGroup@{KConfigGroup}}
\index{KConfigGroup@{KConfigGroup}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KConfig\-Group::KConfig\-Group ({\bf KConfig\-Base} $\ast$ {\em master}, const char $\ast$ {\em group})}\label{classKConfigGroup_a2}


This is an overloaded constructor provided for convenience. 

It behaves essentially like the above function.

Construct a config group corresponding to {\tt group} in {\tt master} {\tt group} is the group name encoded in UTF-8. 

Definition at line 1790 of file kconfigbase.cpp.

References KConfig\-Base::a\-Locale\-String, KConfig\-Base::back\-End, KConfig\-Base::b\-Read\-Only, KConfig\-Base::read\-Defaults(), and KConfig\-Base::set\-Read\-Defaults().

\subsection{Member Function Documentation}
\index{KConfigGroup@{KConfig\-Group}!deleteGroup@{deleteGroup}}
\index{deleteGroup@{deleteGroup}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Group::delete\-Group (bool {\em b\-Global} = {\tt false})}\label{classKConfigGroup_a3}


Delete all entries in the entire group. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em b\-Global}]If {\tt b\-Global} is true, the entries are not removed from the application specific config file, but from the global {\bf KDE}{\rm (p.\,\pageref{namespaceKDE})} config file. \end{description}
\end{Desc}


Definition at line 1803 of file kconfigbase.cpp.

References KConfig\-Base::delete\-Group().\index{KConfigGroup@{KConfig\-Group}!groupIsImmutable@{groupIsImmutable}}
\index{groupIsImmutable@{groupIsImmutable}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KConfig\-Group::group\-Is\-Immutable () const}\label{classKConfigGroup_a4}


Checks whether it is possible to change this group. 

\begin{Desc}
\item[Returns:]whether changes may be made to this group in this configuration file. \end{Desc}
\begin{Desc}
\item[Since:]3.4 \end{Desc}


Definition at line 1808 of file kconfigbase.cpp.

References KConfig\-Base::group\-Is\-Immutable().\index{KConfigGroup@{KConfig\-Group}!setDirty@{setDirty}}
\index{setDirty@{setDirty}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Group::set\-Dirty (bool {\em \_\-b\-Dirty})\hspace{0.3cm}{\tt  [virtual]}}\label{classKConfigGroup_a5}


Sets the global dirty flag of the config object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-b\-Dirty}]How to mark the object's dirty status \end{description}
\end{Desc}


Reimplemented from {\bf KConfig\-Base} {\rm (p.\,\pageref{classKConfigBase_b1})}.

Definition at line 1813 of file kconfigbase.cpp.

References KConfig\-Base::set\-Dirty().\index{KConfigGroup@{KConfig\-Group}!putData@{putData}}
\index{putData@{putData}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Group::put\-Data (const {\bf KEntry\-Key} \& {\em \_\-key}, const {\bf KEntry} \& {\em \_\-data}, bool {\em \_\-check\-Group} = {\tt true})\hspace{0.3cm}{\tt  [virtual]}}\label{classKConfigGroup_a6}


Inserts a (key/value) pair into the internal storage mechanism of the configuration object. 

Classes that derive from {\bf KConfig\-Base}{\rm (p.\,\pageref{classKConfigBase})} will need to implement this method in a storage-specific manner.

Do not use this function, the implementation / return type are subject to change.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-key}]The key to insert. It contains information both on the group of the key and the key itself. If the key already exists, the old value will be replaced. \item[{\em \_\-data}]the {\bf KEntry}{\rm (p.\,\pageref{structKEntry})} that is to be stored. \item[{\em \_\-check\-Group}]When false, assume that the group already exists. \end{description}
\end{Desc}


Implements {\bf KConfig\-Base} {\rm (p.\,\pageref{classKConfigBase_b5})}.

Definition at line 1818 of file kconfigbase.cpp.

References KConfig\-Base::put\-Data().\index{KConfigGroup@{KConfig\-Group}!lookupData@{lookupData}}
\index{lookupData@{lookupData}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KEntry} KConfig\-Group::lookup\-Data (const {\bf KEntry\-Key} \& {\em \_\-key}) const\hspace{0.3cm}{\tt  [virtual]}}\label{classKConfigGroup_a7}


Looks up an entry in the config object's internal structure. 

Classes that derive from {\bf KConfig\-Base}{\rm (p.\,\pageref{classKConfigBase})} will need to implement this method in a storage-specific manner.

Do not use this function, the implementation and return type are subject to change.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-key}]The key to look up It contains information both on the group of the key and the entry's key itself. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The {\bf KEntry}{\rm (p.\,\pageref{structKEntry})} value (data) found for the key. {\tt KEntry.a\-Value} will be the null string if nothing was located. \end{Desc}


Implements {\bf KConfig\-Base} {\rm (p.\,\pageref{classKConfigBase_b6})}.

Definition at line 1823 of file kconfigbase.cpp.

References KConfig\-Base::lookup\-Data().\index{KConfigGroup@{KConfig\-Group}!sync@{sync}}
\index{sync@{sync}!KConfigGroup@{KConfig\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KConfig\-Group::sync ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKConfigGroup_a8}


Flushes all changes that currently reside only in memory back to disk / permanent storage. 

Dirty configuration entries are written to the most specific file available.

Asks the back end to flush out all pending writes, and then calls {\bf rollback()}{\rm (p.\,\pageref{classKConfigBase_a104})}. No changes are made if the object has {\tt read\-Only} status.

You should call this from your destructor in derivative classes.

\begin{Desc}
\item[See also:]{\bf rollback()}{\rm (p.\,\pageref{classKConfigBase_a104})}, {\bf is\-Read\-Only()}{\rm (p.\,\pageref{classKConfigBase_a108})} \end{Desc}


Reimplemented from {\bf KConfig\-Base} {\rm (p.\,\pageref{classKConfigBase_a105})}.

Definition at line 1828 of file kconfigbase.cpp.

References KConfig\-Base::sync().

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