<?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: KateDocCursor 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-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">KateDocCursor Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KateDocCursor" --><!-- doxytag: inherits="KateTextCursor" -->
<p>Cursor class with a pointer to its document.
<a href="classKateDocCursor.html#details">More...</a></p>
<p><code>#include <<a class="el" href="katecursor_8h_source.html">katecursor.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KateDocCursor:</div>
<div class="dyncontent">
<div class="center">
<img src="classKateDocCursor.png" usemap="#KateDocCursor_map" alt=""/>
<map id="KateDocCursor_map" name="KateDocCursor_map">
<area href="classKateTextCursor.html" title="Simple cursor class with no document pointer." alt="KateTextCursor" shape="rect" coords="0,0,110,24"/>
<area href="classKateSuperCursor.html" title="Possible additional features:" alt="KateSuperCursor" shape="rect" coords="0,112,110,136"/>
</map>
</div></div>
<p><a href="classKateDocCursor-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="ac8a24f84ad2dc6a775b68c9c39bb22eb"></a><!-- doxytag: member="KateDocCursor::KateDocCursor" ref="ac8a24f84ad2dc6a775b68c9c39bb22eb" args="(KateDocument *doc)" -->
 </td><td class="memItemRight" valign="bottom"><b>KateDocCursor</b> (KateDocument *doc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea160e8d44cdf4abc713e66909848ce4"></a><!-- doxytag: member="KateDocCursor::KateDocCursor" ref="aea160e8d44cdf4abc713e66909848ce4" args="(int line, int col, KateDocument *doc)" -->
 </td><td class="memItemRight" valign="bottom"><b>KateDocCursor</b> (int line, int col, KateDocument *doc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adabdae836411d9a437d0719f7d762542"></a><!-- doxytag: member="KateDocCursor::validPosition" ref="adabdae836411d9a437d0719f7d762542" args="(uint line, uint col)" -->
bool </td><td class="memItemRight" valign="bottom"><b>validPosition</b> (uint line, uint col)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8da3141f1fbff7c7a94b5d2b9d5cbebe"></a><!-- doxytag: member="KateDocCursor::validPosition" ref="a8da3141f1fbff7c7a94b5d2b9d5cbebe" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>validPosition</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b1dfba24908499bf241a6936608d57e"></a><!-- doxytag: member="KateDocCursor::gotoNextLine" ref="a9b1dfba24908499bf241a6936608d57e" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>gotoNextLine</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade7f994232c24cc28751c3703197c56f"></a><!-- doxytag: member="KateDocCursor::gotoPreviousLine" ref="ade7f994232c24cc28751c3703197c56f" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>gotoPreviousLine</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cf81a0840cf26ed9c8174b3eb9d3824"></a><!-- doxytag: member="KateDocCursor::gotoEndOfNextLine" ref="a7cf81a0840cf26ed9c8174b3eb9d3824" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>gotoEndOfNextLine</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4fe6f7240694f0199abfb198c51fa295"></a><!-- doxytag: member="KateDocCursor::gotoEndOfPreviousLine" ref="a4fe6f7240694f0199abfb198c51fa295" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>gotoEndOfPreviousLine</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a701b2d44ce3888b1b5ead6d4ae07a550"></a><!-- doxytag: member="KateDocCursor::nbCharsOnLineAfter" ref="a701b2d44ce3888b1b5ead6d4ae07a550" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>nbCharsOnLineAfter</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a212f3c74c26e696513f5aaef1a238183"></a><!-- doxytag: member="KateDocCursor::moveForward" ref="a212f3c74c26e696513f5aaef1a238183" args="(uint nbChar)" -->
bool </td><td class="memItemRight" valign="bottom"><b>moveForward</b> (uint nbChar)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2614183e90a6da3dafbbd76e420b217"></a><!-- doxytag: member="KateDocCursor::moveBackward" ref="aa2614183e90a6da3dafbbd76e420b217" args="(uint nbChar)" -->
bool </td><td class="memItemRight" valign="bottom"><b>moveBackward</b> (uint nbChar)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bf08cd632ad7059b77ef447e9487330"></a><!-- doxytag: member="KateDocCursor::position" ref="a0bf08cd632ad7059b77ef447e9487330" args="(uint *line, uint *col) const " -->
void </td><td class="memItemRight" valign="bottom"><b>position</b> (uint *line, uint *col) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a548be0b2e2dbd227bad76367b8f6ed46"></a><!-- doxytag: member="KateDocCursor::setPosition" ref="a548be0b2e2dbd227bad76367b8f6ed46" args="(uint line, uint col)" -->
bool </td><td class="memItemRight" valign="bottom"><b>setPosition</b> (uint line, uint col)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa02529c612cc2608d8246da7554bc7b7"></a><!-- doxytag: member="KateDocCursor::insertText" ref="aa02529c612cc2608d8246da7554bc7b7" args="(const QString &text)" -->
bool </td><td class="memItemRight" valign="bottom"><b>insertText</b> (const <a class="elRef" href="qstring.html">QString</a> &text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d95fed8494af1091d443845984c9895"></a><!-- doxytag: member="KateDocCursor::removeText" ref="a5d95fed8494af1091d443845984c9895" args="(uint numberOfCharacters)" -->
bool </td><td class="memItemRight" valign="bottom"><b>removeText</b> (uint numberOfCharacters)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad56ec6b59e32fa2949a4d5b77c263fae"></a><!-- doxytag: member="KateDocCursor::currentChar" ref="ad56ec6b59e32fa2949a4d5b77c263fae" args="() const " -->
<a class="elRef" href="qchar.html">QChar</a> </td><td class="memItemRight" valign="bottom"><b>currentChar</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05d85ebf8984a43b09f4458e7f670afe"></a><!-- doxytag: member="KateDocCursor::currentAttrib" ref="a05d85ebf8984a43b09f4458e7f670afe" args="() const " -->
uchar </td><td class="memItemRight" valign="bottom"><b>currentAttrib</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateDocCursor.html#aa4056e73624bab804e4b7d188dcef584">nextNonSpaceChar</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateDocCursor.html#a1f3c897bc29aa2e94d741907714d3d14">previousNonSpaceChar</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba523ef76eb45eb4b9ea8690414203a6"></a><!-- doxytag: member="KateDocCursor::m_doc" ref="aba523ef76eb45eb4b9ea8690414203a6" args="" -->
KateDocument * </td><td class="memItemRight" valign="bottom"><b>m_doc</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Cursor class with a pointer to its document. </p>
<p>Definition at line <a class="el" href="katecursor_8h_source.html#l00092">92</a> of file <a class="el" href="katecursor_8h_source.html">katecursor.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa4056e73624bab804e4b7d188dcef584"></a><!-- doxytag: member="KateDocCursor::nextNonSpaceChar" ref="aa4056e73624bab804e4b7d188dcef584" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateDocCursor::nextNonSpaceChar </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find the position (line and col) of the next char that is not a space. </p>
<p>If found <a class="el" href="classKateDocCursor.html" title="Cursor class with a pointer to its document.">KateDocCursor</a> points to the found character. Otherwise to a invalid Position such that validPosition() returns false. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the specified or a following character is not a space Otherwise false. </dd></dl>
<p>Definition at line <a class="el" href="katecursor_8cpp_source.html#l00165">165</a> of file <a class="el" href="katecursor_8cpp_source.html">katecursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1f3c897bc29aa2e94d741907714d3d14"></a><!-- doxytag: member="KateDocCursor::previousNonSpaceChar" ref="a1f3c897bc29aa2e94d741907714d3d14" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateDocCursor::previousNonSpaceChar </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find the position (line and col) of the previous char that is not a space. </p>
<p>If found <a class="el" href="classKateDocCursor.html" title="Cursor class with a pointer to its document.">KateDocCursor</a> points to the found character. Otherwise to a invalid Position such that validPosition() returns false. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the specified or a preceding character is not a space Otherwise false. </dd></dl>
<p>Definition at line <a class="el" href="katecursor_8cpp_source.html#l00178">178</a> of file <a class="el" href="katecursor_8cpp_source.html">katecursor.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="katecursor_8h_source.html">katecursor.h</a></li>
<li><a class="el" href="katecursor_8cpp_source.html">katecursor.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>
