<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kate: KateVarIndent Class Reference (kate)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kate</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">KateVarIndent Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KateVarIndent" --><!-- doxytag: inherits="KateNormalIndent" -->
<p>This indenter uses document variables to determine when to add/remove indents.
<a href="classKateVarIndent.html#details">More...</a></p>
<p><code>#include <<a class="el" href="kateautoindent_8h_source.html">kateautoindent.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KateVarIndent:</div>
<div class="dyncontent">
<div class="center">
<img src="classKateVarIndent.png" usemap="#KateVarIndent_map" alt=""/>
<map id="KateVarIndent_map" name="KateVarIndent_map">
<area href="classKateNormalIndent.html" title="Provides Auto-Indent functionality for katepart." alt="KateNormalIndent" shape="rect" coords="0,112,111,136"/>
<area href="classKateAutoIndent.html" title="Provides Auto-Indent functionality for katepart." alt="KateAutoIndent" shape="rect" coords="0,56,111,80"/>
<area href="qobject.html" alt="QObject" shape="rect" coords="0,0,111,24"/>
</map>
</div></div>
<p><a href="classKateVarIndent-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateVarIndent.html#a4db2de2e74959b12d82c93794a62a3f1">pairs</a> { <b>Parens</b> = 1,
<b>Braces</b> = 2,
<b>Brackets</b> = 4,
<b>AngleBrackets</b> = 8
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e747a6db320afc1aa441cf6124903db"></a><!-- doxytag: member="KateVarIndent::KateVarIndent" ref="a1e747a6db320afc1aa441cf6124903db" args="(KateDocument *doc)" -->
 </td><td class="memItemRight" valign="bottom"><b>KateVarIndent</b> (KateDocument *doc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateVarIndent.html#ab699ad41266a595195effc451b5f3456">processNewline</a> (<a class="el" href="classKateDocCursor.html">KateDocCursor</a> &cur, bool needContinue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateVarIndent.html#a17874e7702cf3a40adeda6e04aea0cc7">processChar</a> (<a class="elRef" href="qchar.html">QChar</a> c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateVarIndent.html#a61f4fcc39cc7db212dda5201d83a92a0">processLine</a> (<a class="el" href="classKateDocCursor.html">KateDocCursor</a> &line)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateVarIndent.html#a1db10aa1b19e8fef0cde5c80c7d54700">processSection</a> (const <a class="el" href="classKateDocCursor.html">KateDocCursor</a> &begin, const <a class="el" href="classKateDocCursor.html">KateDocCursor</a> &end)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateVarIndent.html#aebedea17461df241272363f2ab1231ae">canProcessLine</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateVarIndent.html#aed2f5ee0c92b4674b34f8ae20ff6bfe2">modeNumber</a> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This indenter uses document variables to determine when to add/remove indents. </p>
<p>It attempts to get the following variables from the document:</p>
<ul>
<li>var-indent-indent-after: A rerular expression which will cause a line to be indented by one unit, if the first non-whitespace-only line above matches.</li>
<li>var-indent-indent: A regular expression, which will cause a matching line to be indented by one unit.</li>
<li>var-indent-unindent: A regular expression which will cause the line to be unindented by one unit if matching.</li>
<li>var-indent-triggerchars: a list of characters that should cause the indentiou to be recalculated immediately when typed.</li>
<li>var-indent-handle-couples: a list of paren sets to handle. Any combination of 'parens' 'braces' and 'brackets'. Each set type is handled the following way: If there are unmatched opening instances on the above line, one indent unit is added, if there are unmatched closing instances on the current line, one indent unit is removed.</li>
<li>var-indent-couple-attribute: When looking for unmatched couple openings/closings, only characters with this attribute is considered. The value must be the attribute name from the syntax xml file, for example "Symbol". If it's not specified, attribute 0 is used (usually 'Normal Text').</li>
</ul>
<p>The idea is to provide a somewhat intelligent indentation for perl, php, bash, scheme and in general formats with humble indentation needs. </p>
<p>Definition at line <a class="el" href="kateautoindent_8h_source.html#l00492">492</a> of file <a class="el" href="kateautoindent_8h_source.html">kateautoindent.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a4db2de2e74959b12d82c93794a62a3f1"></a><!-- doxytag: member="KateVarIndent::pairs" ref="a4db2de2e74959b12d82c93794a62a3f1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKateVarIndent.html#a4db2de2e74959b12d82c93794a62a3f1">KateVarIndent::pairs</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Purely for readability, couples we know and love. </p>
<p>Definition at line <a class="el" href="kateautoindent_8h_source.html#l00500">500</a> of file <a class="el" href="kateautoindent_8h_source.html">kateautoindent.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aebedea17461df241272363f2ab1231ae"></a><!-- doxytag: member="KateVarIndent::canProcessLine" ref="aebedea17461df241272363f2ab1231ae" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool KateVarIndent::canProcessLine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set to true if an actual implementation of 'processLine' is present. </p>
<p>This is used to prevent a needless Undo action from being created. </p>
<p>Reimplemented from <a class="el" href="classKateNormalIndent.html#a1b563260dc14cd94d4e4a42d5ebd7860">KateNormalIndent</a>.</p>
<p>Definition at line <a class="el" href="kateautoindent_8h_source.html#l00516">516</a> of file <a class="el" href="kateautoindent_8h_source.html">kateautoindent.h</a>.</p>
</div>
</div>
<a class="anchor" id="aed2f5ee0c92b4674b34f8ae20ff6bfe2"></a><!-- doxytag: member="KateVarIndent::modeNumber" ref="aed2f5ee0c92b4674b34f8ae20ff6bfe2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint KateVarIndent::modeNumber </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Mode index of this mode. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>modeNumber </dd></dl>
<p>Reimplemented from <a class="el" href="classKateNormalIndent.html#a01e7004502dd41e726ff9810d3b51e4e">KateNormalIndent</a>.</p>
<p>Definition at line <a class="el" href="kateautoindent_8h_source.html#l00518">518</a> of file <a class="el" href="kateautoindent_8h_source.html">kateautoindent.h</a>.</p>
</div>
</div>
<a class="anchor" id="a17874e7702cf3a40adeda6e04aea0cc7"></a><!-- doxytag: member="KateVarIndent::processChar" ref="a17874e7702cf3a40adeda6e04aea0cc7" args="(QChar c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateVarIndent::processChar </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qchar.html">QChar</a> </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called every time a character is inserted into the document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>character inserted </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classKateNormalIndent.html#ada600364dad4e63070cf5e6fdf1e3b84">KateNormalIndent</a>.</p>
<p>Definition at line <a class="el" href="kateautoindent_8cpp_source.html#l02194">2194</a> of file <a class="el" href="kateautoindent_8cpp_source.html">kateautoindent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a61f4fcc39cc7db212dda5201d83a92a0"></a><!-- doxytag: member="KateVarIndent::processLine" ref="a61f4fcc39cc7db212dda5201d83a92a0" args="(KateDocCursor &line)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateVarIndent::processLine </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKateDocCursor.html">KateDocCursor</a> & </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Aligns/indents the given line to the proper indent position. </p>
<p>Reimplemented from <a class="el" href="classKateNormalIndent.html#a2c7df0875c48c36f48311a6906257d19">KateNormalIndent</a>.</p>
<p>Definition at line <a class="el" href="kateautoindent_8cpp_source.html#l02210">2210</a> of file <a class="el" href="kateautoindent_8cpp_source.html">kateautoindent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab699ad41266a595195effc451b5f3456"></a><!-- doxytag: member="KateVarIndent::processNewline" ref="ab699ad41266a595195effc451b5f3456" args="(KateDocCursor &cur, bool needContinue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateVarIndent::processNewline </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKateDocCursor.html">KateDocCursor</a> & </td>
<td class="paramname"><em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>needContinue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called every time a newline character is inserted in the document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cur</td><td>The position to start processing. Contains the new cursor position after the indention. </td></tr>
<tr><td class="paramname">needContinue</td><td>Used to determine whether to calculate a continue indent or not. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classKateNormalIndent.html#a9d7a2a09184561246299821eb8f3b5bb">KateNormalIndent</a>.</p>
<p>Definition at line <a class="el" href="kateautoindent_8cpp_source.html#l02186">2186</a> of file <a class="el" href="kateautoindent_8cpp_source.html">kateautoindent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1db10aa1b19e8fef0cde5c80c7d54700"></a><!-- doxytag: member="KateVarIndent::processSection" ref="a1db10aa1b19e8fef0cde5c80c7d54700" args="(const KateDocCursor &begin, const KateDocCursor &end)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateVarIndent::processSection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKateDocCursor.html">KateDocCursor</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classKateDocCursor.html">KateDocCursor</a> & </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Processes a section of text, indenting each line in between. </p>
<p>Reimplemented from <a class="el" href="classKateNormalIndent.html#a548afe658fe3838cd22afcd227f80dfb">KateNormalIndent</a>.</p>
<p>Definition at line <a class="el" href="kateautoindent_8cpp_source.html#l02347">2347</a> of file <a class="el" href="kateautoindent_8cpp_source.html">kateautoindent.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kateautoindent_8h_source.html">kateautoindent.h</a></li>
<li><a class="el" href="kateautoindent_8cpp_source.html">kateautoindent.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kate</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classIndenterConfigPage.html">indenterconfigpage</option>, <option value="classKate_1_1Command.html">kate::command</option>, <option value="classKate_1_1CommandExtension.html">kate::commandextension</option>, <option value="classKate_1_1Document.html">kate::document</option>, <option value="classKate_1_1DocumentExt.html">kate::documentext</option>, <option value="classKate_1_1View.html">kate::view</option>, <option value="classKateArbitraryHighlight.html">katearbitraryhighlight</option>, <option value="classKateAttribute.html">kateattribute</option>, <option value="classKateAutoIndent.html">kateautoindent</option>, <option value="classKateBrowserExtension.html">katebrowserextension</option>, <option value="classKateBufBlock.html">katebufblock</option>, <option value="classKateBufBlockList.html">katebufblocklist</option>, <option value="classKateBuffer.html">katebuffer</option>, <option value="classKateCmdShellCompletion.html">katecmdshellcompletion</option>, <option value="classKateCommands_1_1Character.html">katecommands::character</option>, <option value="classKateCommands_1_1CoreCommands.html">katecommands::corecommands</option>, <option value="classKateCommands_1_1Date.html">katecommands::date</option>, <option value="classKateCommands_1_1SedReplace.html">katecommands::sedreplace</option>, <option value="classKateConfig.html">kateconfig</option>, <option value="classKateDocCursor.html">katedoccursor</option>, <option value="classKateJScript.html">katejscript</option>, <option value="classKateModOnHdPrompt.html">katemodonhdprompt</option>, <option value="classKateNormalIndent.html">katenormalindent</option>, <option value="classKateRenderer.html">katerenderer</option>, <option value="classKateReplacePrompt.html">katereplaceprompt</option>, <option value="classKateScrollBar.html">katescrollbar</option>, <option value="classKateSuperCursor.html">katesupercursor</option>, <option value="classKateSuperRange.html">katesuperrange</option>, <option value="classKateSyntaxContextData.html">katesyntaxcontextdata</option>, <option value="classKateSyntaxDocument.html">katesyntaxdocument</option>, <option value="classKateSyntaxModeListItem.html">katesyntaxmodelistitem</option>, <option value="classKateTextCursor.html">katetextcursor</option>, <option value="classKateTextLine.html">katetextline</option>, <option value="classKateUndoGroup.html">kateundogroup</option>, <option value="classKateVarIndent.html">katevarindent</option>, <option value="classKateViewIndentationAction.html">kateviewindentationaction</option>, <option value="classOutputFunction.html">outputfunction</option>, <option value="classOutputObject.html">outputobject</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
