\section{KText\-Editor::Config\-Interface Class Reference}
\label{classKTextEditor_1_1ConfigInterface}\index{KTextEditor::ConfigInterface@{KTextEditor::ConfigInterface}}
This is an interface for accessing the configuration of the {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} and {\bf Plugin}{\rm (p.\,\pageref{classKTextEditor_1_1Plugin})} classes.  


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

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
unsigned int {\bf config\-Interface\-Number} () const \label{classKTextEditor_1_1ConfigInterface_a2}

\item 
virtual void {\bf read\-Config} ()=0
\item 
virtual void {\bf write\-Config} ()=0\label{classKTextEditor_1_1ConfigInterface_a4}

\item 
virtual void {\bf read\-Config} ({\bf KConfig} $\ast$)=0
\item 
virtual void {\bf write\-Config} ({\bf KConfig} $\ast$)=0\label{classKTextEditor_1_1ConfigInterface_a6}

\item 
virtual void {\bf read\-Session\-Config} ({\bf KConfig} $\ast$)=0
\item 
virtual void {\bf write\-Session\-Config} ({\bf KConfig} $\ast$)=0\label{classKTextEditor_1_1ConfigInterface_a8}

\item 
virtual void {\bf config\-Dialog} ()=0
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf set\-Config\-Interface\-DCOPSuffix} (const {\bf QCString} \&suffix)\label{classKTextEditor_1_1ConfigInterface_b0}

\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf Private\-Config\-Interface}\label{classKTextEditor_1_1ConfigInterface_n0}

\end{CompactItemize}


\subsection{Detailed Description}
This is an interface for accessing the configuration of the {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} and {\bf Plugin}{\rm (p.\,\pageref{classKTextEditor_1_1Plugin})} classes. 



Definition at line 34 of file configinterface.h.

\subsection{Member Function Documentation}
\index{KTextEditor::ConfigInterface@{KText\-Editor::Config\-Interface}!readConfig@{readConfig}}
\index{readConfig@{readConfig}!KTextEditor::ConfigInterface@{KText\-Editor::Config\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Config\-Interface::read\-Config ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1ConfigInterface_a3}


Read/Write the config to the standard place where this editor part saves it config, say: read/save default values for that editor part, which means for all current open documents. 

\index{KTextEditor::ConfigInterface@{KText\-Editor::Config\-Interface}!readConfig@{readConfig}}
\index{readConfig@{readConfig}!KTextEditor::ConfigInterface@{KText\-Editor::Config\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Config\-Interface::read\-Config ({\bf KConfig} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1ConfigInterface_a5}


Read/Write the config of the part to a given kconfig object to store the settings in a different place than the standard. 

\index{KTextEditor::ConfigInterface@{KText\-Editor::Config\-Interface}!readSessionConfig@{readSessionConfig}}
\index{readSessionConfig@{readSessionConfig}!KTextEditor::ConfigInterface@{KText\-Editor::Config\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Config\-Interface::read\-Session\-Config ({\bf KConfig} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1ConfigInterface_a7}


Read/Write session config of only this document/view/plugin. 

\index{KTextEditor::ConfigInterface@{KText\-Editor::Config\-Interface}!configDialog@{configDialog}}
\index{configDialog@{configDialog}!KTextEditor::ConfigInterface@{KText\-Editor::Config\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Config\-Interface::config\-Dialog ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1ConfigInterface_a9}


Shows a config dialog for the part, changes will be applied to the part, but not saved anywhere automagically, call write\-Config to save it. 



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