\section{KText\-Editor::Variable\-Interface Class Reference}
\label{classKTextEditor_1_1VariableInterface}\index{KTextEditor::VariableInterface@{KTextEditor::VariableInterface}}
This interface is designed to provide access to \char`\"{}document variables\char`\"{}, for example variables defined in files like \char`\"{}kate: variable value;\char`\"{} or the emacs style \char`\"{}-$\ast$- variable: value -$\ast$-\char`\"{}. {\bf KText\-Editor}{\rm (p.\,\pageref{namespaceKTextEditor})} interface to {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} Variables.  


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

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

\item 
virtual {\bf QString} {\bf variable} (const {\bf QString} \&name) const =0
\item 
virtual void {\bf variable\-Changed} (const {\bf QString} \&variable, const {\bf QString} \&value)=0
\end{CompactItemize}


\subsection{Detailed Description}
This interface is designed to provide access to \char`\"{}document variables\char`\"{}, for example variables defined in files like \char`\"{}kate: variable value;\char`\"{} or the emacs style \char`\"{}-$\ast$- variable: value -$\ast$-\char`\"{}. {\bf KText\-Editor}{\rm (p.\,\pageref{namespaceKTextEditor})} interface to {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} Variables. 

The purpose is to allow KTE plugins to use variables. A document implementing this interface should return values for variable that it does not otherwise know how to use, since they could be of interrest to plugins. A document implementing this interface must emit the {\bf variable\-Changed()}{\rm (p.\,\pageref{classKTextEditor_1_1VariableInterface_a4})} signal whenever a variable is set that it will return a value for.



Definition at line 41 of file variableinterface.h.

\subsection{Member Function Documentation}
\index{KTextEditor::VariableInterface@{KText\-Editor::Variable\-Interface}!variable@{variable}}
\index{variable@{variable}!KTextEditor::VariableInterface@{KText\-Editor::Variable\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QString} KText\-Editor::Variable\-Interface::variable (const {\bf QString} \& {\em name}) const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1VariableInterface_a3}


\begin{Desc}
\item[Returns:]the value of the variable {\tt name}, or an empty string if the variable is not set or has no value. \end{Desc}
\index{KTextEditor::VariableInterface@{KText\-Editor::Variable\-Interface}!variableChanged@{variableChanged}}
\index{variableChanged@{variableChanged}!KTextEditor::VariableInterface@{KText\-Editor::Variable\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Variable\-Interface::variable\-Changed (const {\bf QString} \& {\em variable}, const {\bf QString} \& {\em value})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1VariableInterface_a4}


Signal: emitted when a variable is set. 



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