\section{Kate\-Auto\-Indent Class Reference}
\label{classKateAutoIndent}\index{KateAutoIndent@{KateAutoIndent}}
Provides Auto-Indent functionality for katepart.  


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

Inheritance diagram for Kate\-Auto\-Indent:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=66pt]{classKateAutoIndent__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Kate\-Auto\-Indent} (Kate\-Document $\ast$doc)
\item 
virtual {\bf $\sim$Kate\-Auto\-Indent} ()
\item 
virtual void {\bf update\-Config} ()
\item 
virtual bool {\bf can\-Process\-New\-Line} () const 
\item 
virtual void {\bf process\-Newline} ({\bf Kate\-Doc\-Cursor} \&, bool)
\item 
virtual void {\bf process\-Char} ({\bf QChar})
\item 
virtual void {\bf process\-Line} ({\bf Kate\-Doc\-Cursor} \&)
\item 
virtual void {\bf process\-Section} ({\bf Kate\-Doc\-Cursor} \&, {\bf Kate\-Doc\-Cursor} \&)
\item 
virtual bool {\bf can\-Process\-Line} () const 
\item 
virtual uint {\bf mode\-Number} () const 
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static {\bf Kate\-Auto\-Indent} $\ast$ {\bf create\-Indenter} (Kate\-Document $\ast$doc, uint mode)
\item 
static {\bf QString\-List} {\bf list\-Modes} ()
\item 
static {\bf QString} {\bf mode\-Name} (uint mode)
\item 
static {\bf QString} {\bf mode\-Description} (uint mode)
\item 
static uint {\bf mode\-Number} (const {\bf QString} \&name)
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
Kate\-Document $\ast$ {\bf doc}\label{classKateAutoIndent_p0}

\end{CompactItemize}


\subsection{Detailed Description}
Provides Auto-Indent functionality for katepart. 

This baseclass is a real dummy, does nothing beside remembering the document it belongs too, only to have the object around 



Definition at line 35 of file kateautoindent.h.

\subsection{Constructor \& Destructor Documentation}
\index{KateAutoIndent@{Kate\-Auto\-Indent}!KateAutoIndent@{KateAutoIndent}}
\index{KateAutoIndent@{KateAutoIndent}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Kate\-Auto\-Indent::Kate\-Auto\-Indent (Kate\-Document $\ast$ {\em doc})}\label{classKateAutoIndent_a0}


Constructor. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em doc}]parent document \end{description}
\end{Desc}


Definition at line 120 of file kateautoindent.cpp.

Referenced by create\-Indenter().\index{KateAutoIndent@{Kate\-Auto\-Indent}!~KateAutoIndent@{$\sim$KateAutoIndent}}
\index{~KateAutoIndent@{$\sim$KateAutoIndent}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Kate\-Auto\-Indent::$\sim${\bf Kate\-Auto\-Indent} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKateAutoIndent_a1}


Virtual Destructor for the baseclass. 



Definition at line 124 of file kateautoindent.cpp.

\subsection{Member Function Documentation}
\index{KateAutoIndent@{Kate\-Auto\-Indent}!createIndenter@{createIndenter}}
\index{createIndenter@{createIndenter}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Kate\-Auto\-Indent} $\ast$ Kate\-Auto\-Indent::create\-Indenter (Kate\-Document $\ast$ {\em doc}, uint {\em mode})\hspace{0.3cm}{\tt  [static]}}\label{classKateAutoIndent_e0}


Create an indenter. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em doc}]document for the indenter \item[{\em mode}]indention mode wanted \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]created autoindention object \end{Desc}


Definition at line 33 of file kateautoindent.cpp.

References Kate\-Auto\-Indent().\index{KateAutoIndent@{Kate\-Auto\-Indent}!listModes@{listModes}}
\index{listModes@{listModes}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} Kate\-Auto\-Indent::list\-Modes ()\hspace{0.3cm}{\tt  [static]}}\label{classKateAutoIndent_e1}


List all possible modes by name. 

\begin{Desc}
\item[Returns:]list of modes \end{Desc}


Definition at line 51 of file kateautoindent.cpp.

References mode\-Description().\index{KateAutoIndent@{Kate\-Auto\-Indent}!modeName@{modeName}}
\index{modeName@{modeName}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Kate\-Auto\-Indent::mode\-Name (uint {\em mode})\hspace{0.3cm}{\tt  [static]}}\label{classKateAutoIndent_e2}


Return the mode name given the mode. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mode}]mode index \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]name for this mode index \end{Desc}


Definition at line 66 of file kateautoindent.cpp.

Referenced by mode\-Number().\index{KateAutoIndent@{Kate\-Auto\-Indent}!modeDescription@{modeDescription}}
\index{modeDescription@{modeDescription}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Kate\-Auto\-Indent::mode\-Description (uint {\em mode})\hspace{0.3cm}{\tt  [static]}}\label{classKateAutoIndent_e3}


Return the mode description. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mode}]mode index \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]mode index \end{Desc}


Definition at line 84 of file kateautoindent.cpp.

Referenced by list\-Modes().\index{KateAutoIndent@{Kate\-Auto\-Indent}!modeNumber@{modeNumber}}
\index{modeNumber@{modeNumber}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint Kate\-Auto\-Indent::mode\-Number (const {\bf QString} \& {\em name})\hspace{0.3cm}{\tt  [static]}}\label{classKateAutoIndent_e4}


Maps name -$>$ index. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]mode name \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]mode index \end{Desc}


Definition at line 102 of file kateautoindent.cpp.

References mode\-Name().\index{KateAutoIndent@{Kate\-Auto\-Indent}!updateConfig@{updateConfig}}
\index{updateConfig@{updateConfig}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate\-Auto\-Indent::update\-Config ()\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKateAutoIndent_a2}


Update indenter's configuration (indention width, attributes etc.). 



Reimplemented in {\bf Kate\-Normal\-Indent} {\rm (p.\,\pageref{classKateNormalIndent_a2})}.

Definition at line 91 of file kateautoindent.h.\index{KateAutoIndent@{Kate\-Auto\-Indent}!canProcessNewLine@{canProcessNewLine}}
\index{canProcessNewLine@{canProcessNewLine}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool Kate\-Auto\-Indent::can\-Process\-New\-Line () const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKateAutoIndent_a3}


does this indenter support process\-New\-Line 

\begin{Desc}
\item[Returns:]can you do it? \end{Desc}


Reimplemented in {\bf Kate\-Normal\-Indent} {\rm (p.\,\pageref{classKateNormalIndent_a3})}.

Definition at line 97 of file kateautoindent.h.\index{KateAutoIndent@{Kate\-Auto\-Indent}!processNewline@{processNewline}}
\index{processNewline@{processNewline}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate\-Auto\-Indent::process\-Newline ({\bf Kate\-Doc\-Cursor} \&, bool)\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKateAutoIndent_a4}


Called every time a newline character is inserted in the document. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cur}]The position to start processing. Contains the new cursor position after the indention. \item[{\em need\-Continue}]Used to determine whether to calculate a continue indent or not. \end{description}
\end{Desc}


Reimplemented in {\bf Kate\-Normal\-Indent} {\rm (p.\,\pageref{classKateNormalIndent_a4})}, and {\bf Kate\-Var\-Indent} {\rm (p.\,\pageref{classKateVarIndent_a2})}.

Definition at line 105 of file kateautoindent.h.\index{KateAutoIndent@{Kate\-Auto\-Indent}!processChar@{processChar}}
\index{processChar@{processChar}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate\-Auto\-Indent::process\-Char ({\bf QChar})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKateAutoIndent_a5}


Called every time a character is inserted into the document. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em c}]character inserted \end{description}
\end{Desc}


Reimplemented in {\bf Kate\-Normal\-Indent} {\rm (p.\,\pageref{classKateNormalIndent_a5})}, and {\bf Kate\-Var\-Indent} {\rm (p.\,\pageref{classKateVarIndent_a3})}.

Definition at line 111 of file kateautoindent.h.\index{KateAutoIndent@{Kate\-Auto\-Indent}!processLine@{processLine}}
\index{processLine@{processLine}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate\-Auto\-Indent::process\-Line ({\bf Kate\-Doc\-Cursor} \&)\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKateAutoIndent_a6}


Aligns/indents the given line to the proper indent position. 



Reimplemented in {\bf Kate\-Normal\-Indent} {\rm (p.\,\pageref{classKateNormalIndent_a6})}, and {\bf Kate\-Var\-Indent} {\rm (p.\,\pageref{classKateVarIndent_a4})}.

Definition at line 116 of file kateautoindent.h.\index{KateAutoIndent@{Kate\-Auto\-Indent}!processSection@{processSection}}
\index{processSection@{processSection}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate\-Auto\-Indent::process\-Section ({\bf Kate\-Doc\-Cursor} \&, {\bf Kate\-Doc\-Cursor} \&)\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKateAutoIndent_a7}


Processes a section of text, indenting each line in between. 



Reimplemented in {\bf Kate\-Normal\-Indent} {\rm (p.\,\pageref{classKateNormalIndent_a7})}, and {\bf Kate\-Var\-Indent} {\rm (p.\,\pageref{classKateVarIndent_a5})}.

Definition at line 121 of file kateautoindent.h.\index{KateAutoIndent@{Kate\-Auto\-Indent}!canProcessLine@{canProcessLine}}
\index{canProcessLine@{canProcessLine}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool Kate\-Auto\-Indent::can\-Process\-Line () const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKateAutoIndent_a8}


Set to true if an actual implementation of 'process\-Line' is present. 

This is used to prevent a needless Undo action from being created. 

Reimplemented in {\bf Kate\-Normal\-Indent} {\rm (p.\,\pageref{classKateNormalIndent_a8})}, and {\bf Kate\-Var\-Indent} {\rm (p.\,\pageref{classKateVarIndent_a6})}.

Definition at line 127 of file kateautoindent.h.\index{KateAutoIndent@{Kate\-Auto\-Indent}!modeNumber@{modeNumber}}
\index{modeNumber@{modeNumber}!KateAutoIndent@{Kate\-Auto\-Indent}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual uint Kate\-Auto\-Indent::mode\-Number () const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKateAutoIndent_a9}


Mode index of this mode. 

\begin{Desc}
\item[Returns:]mode\-Number \end{Desc}


Reimplemented in {\bf Kate\-Normal\-Indent} {\rm (p.\,\pageref{classKateNormalIndent_a9})}, and {\bf Kate\-Var\-Indent} {\rm (p.\,\pageref{classKateVarIndent_a7})}.

Definition at line 133 of file kateautoindent.h.

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