.TH "KateAutoIndent" kde3 "11 Jun 2005" "Version Version 3.4.1" "kate Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KateAutoIndent \- Provides Auto-Indent functionality for katepart.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kateautoindent.h>\fP
.PP
Inherited by \fBKateNormalIndent\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKateAutoIndent\fP (KateDocument *doc)"
.br
.ti -1c
.RI "virtual \fB~KateAutoIndent\fP ()"
.br
.ti -1c
.RI "virtual void \fBupdateConfig\fP ()"
.br
.ti -1c
.RI "virtual bool \fBcanProcessNewLine\fP () const "
.br
.ti -1c
.RI "virtual void \fBprocessNewline\fP (\fBKateDocCursor\fP &, bool)"
.br
.ti -1c
.RI "virtual void \fBprocessChar\fP (\fBQChar\fP)"
.br
.ti -1c
.RI "virtual void \fBprocessLine\fP (\fBKateDocCursor\fP &)"
.br
.ti -1c
.RI "virtual void \fBprocessSection\fP (\fBKateDocCursor\fP &, \fBKateDocCursor\fP &)"
.br
.ti -1c
.RI "virtual bool \fBcanProcessLine\fP () const "
.br
.ti -1c
.RI "virtual uint \fBmodeNumber\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBKateAutoIndent\fP * \fBcreateIndenter\fP (KateDocument *doc, uint mode)"
.br
.ti -1c
.RI "static \fBQStringList\fP \fBlistModes\fP ()"
.br
.ti -1c
.RI "static \fBQString\fP \fBmodeName\fP (uint mode)"
.br
.ti -1c
.RI "static \fBQString\fP \fBmodeDescription\fP (uint mode)"
.br
.ti -1c
.RI "static uint \fBmodeNumber\fP (const \fBQString\fP &name)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "KateDocument * \fBdoc\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
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 
.PP
Definition at line 35 of file kateautoindent.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KateAutoIndent::KateAutoIndent (KateDocument * doc)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIdoc\fP parent document 
.RE
.PP

.PP
Definition at line 120 of file kateautoindent.cpp.
.PP
Referenced by createIndenter().
.SS "KateAutoIndent::~\fBKateAutoIndent\fP ()\fC [virtual]\fP"
.PP
Virtual Destructor for the baseclass. 
.PP
Definition at line 124 of file kateautoindent.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKateAutoIndent\fP * KateAutoIndent::createIndenter (KateDocument * doc, uint mode)\fC [static]\fP"
.PP
Create an indenter. 
.PP
\fBParameters:\fP
.RS 4
\fIdoc\fP document for the indenter 
.br
\fImode\fP indention mode wanted 
.RE
.PP
\fBReturns:\fP
.RS 4
created autoindention object 
.RE
.PP

.PP
Definition at line 33 of file kateautoindent.cpp.
.PP
References KateAutoIndent().
.SS "\fBQStringList\fP KateAutoIndent::listModes ()\fC [static]\fP"
.PP
List all possible modes by name. 
.PP
\fBReturns:\fP
.RS 4
list of modes 
.RE
.PP

.PP
Definition at line 51 of file kateautoindent.cpp.
.PP
References modeDescription().
.SS "\fBQString\fP KateAutoIndent::modeName (uint mode)\fC [static]\fP"
.PP
Return the mode name given the mode. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP mode index 
.RE
.PP
\fBReturns:\fP
.RS 4
name for this mode index 
.RE
.PP

.PP
Definition at line 66 of file kateautoindent.cpp.
.PP
Referenced by modeNumber().
.SS "\fBQString\fP KateAutoIndent::modeDescription (uint mode)\fC [static]\fP"
.PP
Return the mode description. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP mode index 
.RE
.PP
\fBReturns:\fP
.RS 4
mode index 
.RE
.PP

.PP
Definition at line 84 of file kateautoindent.cpp.
.PP
Referenced by listModes().
.SS "uint KateAutoIndent::modeNumber (const \fBQString\fP & name)\fC [static]\fP"
.PP
Maps name -> index. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP mode name 
.RE
.PP
\fBReturns:\fP
.RS 4
mode index 
.RE
.PP

.PP
Definition at line 102 of file kateautoindent.cpp.
.PP
References modeName().
.SS "virtual void KateAutoIndent::updateConfig ()\fC [inline, virtual]\fP"
.PP
Update indenter's configuration (indention width, attributes etc.). 
.PP
Reimplemented in \fBKateNormalIndent\fP.
.PP
Definition at line 91 of file kateautoindent.h.
.SS "virtual bool KateAutoIndent::canProcessNewLine () const\fC [inline, virtual]\fP"
.PP
does this indenter support processNewLine 
.PP
\fBReturns:\fP
.RS 4
can you do it? 
.RE
.PP

.PP
Reimplemented in \fBKateNormalIndent\fP.
.PP
Definition at line 97 of file kateautoindent.h.
.SS "virtual void KateAutoIndent::processNewline (\fBKateDocCursor\fP &, bool)\fC [inline, virtual]\fP"
.PP
Called every time a newline character is inserted in the document. 
.PP
\fBParameters:\fP
.RS 4
\fIcur\fP The position to start processing. Contains the new cursor position after the indention. 
.br
\fIneedContinue\fP Used to determine whether to calculate a continue indent or not. 
.RE
.PP

.PP
Reimplemented in \fBKateNormalIndent\fP, and \fBKateVarIndent\fP.
.PP
Definition at line 105 of file kateautoindent.h.
.SS "virtual void KateAutoIndent::processChar (\fBQChar\fP)\fC [inline, virtual]\fP"
.PP
Called every time a character is inserted into the document. 
.PP
\fBParameters:\fP
.RS 4
\fIc\fP character inserted 
.RE
.PP

.PP
Reimplemented in \fBKateNormalIndent\fP, and \fBKateVarIndent\fP.
.PP
Definition at line 111 of file kateautoindent.h.
.SS "virtual void KateAutoIndent::processLine (\fBKateDocCursor\fP &)\fC [inline, virtual]\fP"
.PP
Aligns/indents the given line to the proper indent position. 
.PP
Reimplemented in \fBKateNormalIndent\fP, and \fBKateVarIndent\fP.
.PP
Definition at line 116 of file kateautoindent.h.
.SS "virtual void KateAutoIndent::processSection (\fBKateDocCursor\fP &, \fBKateDocCursor\fP &)\fC [inline, virtual]\fP"
.PP
Processes a section of text, indenting each line in between. 
.PP
Reimplemented in \fBKateNormalIndent\fP, and \fBKateVarIndent\fP.
.PP
Definition at line 121 of file kateautoindent.h.
.SS "virtual bool KateAutoIndent::canProcessLine () const\fC [inline, virtual]\fP"
.PP
Set to true if an actual implementation of 'processLine' is present. 
.PP
This is used to prevent a needless Undo action from being created. 
.PP
Reimplemented in \fBKateNormalIndent\fP, and \fBKateVarIndent\fP.
.PP
Definition at line 127 of file kateautoindent.h.
.SS "virtual uint KateAutoIndent::modeNumber () const\fC [inline, virtual]\fP"
.PP
Mode index of this mode. 
.PP
\fBReturns:\fP
.RS 4
modeNumber 
.RE
.PP

.PP
Reimplemented in \fBKateNormalIndent\fP, and \fBKateVarIndent\fP.
.PP
Definition at line 133 of file kateautoindent.h.

.SH "Author"
.PP 
Generated automatically by Doxygen for kate Library from the source code.
