<?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" xml:lang="en">
<head>
<title>KTextEditor.SmartCursor</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>SmartCursor Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Inherits: <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a><br />
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<dl class="abstract" compact><dt><b>Abstract class:</b></dt>
<dd>This class can be used as a base class for new classes, but can not be instantiated directly.</dd></dl>
<p>A Cursor which is bound to a specific Document, and maintains its position.
</p>
<p>
A SmartCursor is an extension of the basic Cursor class. It maintains its
position in the document and provides a number of convenience methods,
including those for accessing and manipulating the content of the associated
Document. As a result of this, SmartCursor%s may not be copied, as they need
to maintain a connection to the associated Document.
</p>
<p>
To receive notifications when the position of the cursor changes, or other
similar notifications, see either SmartCursorNotifier for QObject signal
notification via notifier(), or SmartCursorWatcher for virtual inheritance
notification via setWatcher().
</p>
<p>
Create a new SmartCursor like this:
<pre class="fragment">
// Retrieve the SmartInterface
KTextEditor.SmartInterface* smart =
qobject_cast<KTextEditor.SmartInterface*>( yourDocument );
if ( smart ) {
KTextEditor.SmartCursor* cursor = smart->newSmartCursor();
}
</pre>
</p>
<p>
When finished with a SmartCursor, simply delete it.
</p>
<p>
\sa Cursor, SmartCursorNotifier, SmartCursorWatcher, and SmartInterface.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Hamish Rodda <rodda@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#AdvanceMode">AdvanceMode</a> </td><td class="memItemRight" valign="bottom">{ ByCharacter, ByCursorPosition }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#InsertBehavior">InsertBehavior</a> </td><td class="memItemRight" valign="bottom">{ StayOnInsert, MoveOnInsert }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#SmartCursor">__init__</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> position, <a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> doc, <a href="../ktexteditor/KTextEditor.SmartCursor.html#InsertBehavior">KTextEditor.SmartCursor.InsertBehavior</a> insertBehavior)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#SmartCursor">__init__</a> (self, <a href="../ktexteditor/KTextEditor.SmartCursor.html">KTextEditor.SmartCursor</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#advance">advance</a> (self, int distance, <a href="../ktexteditor/KTextEditor.SmartCursor.html#AdvanceMode">KTextEditor.SmartCursor.AdvanceMode</a> mode=KTextEditor.SmartCursor.ByCharacter)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#atEndOfDocument">atEndOfDocument</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#atEndOfLine">atEndOfLine</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QChar </td><td class="memItemRight" valign="bottom"><a class="el" href="#character">character</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deleteNotifier">deleteNotifier</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#document">document</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasNotifier">hasNotifier</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.SmartCursor.html#InsertBehavior">KTextEditor.SmartCursor.InsertBehavior</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertBehavior">insertBehavior</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertText">insertText</a> (self, QStringList text, bool block=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSmartCursor">isSmartCursor</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isValid">isValid</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.SmartCursorNotifier.html">KTextEditor.SmartCursorNotifier</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#notifier">notifier</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setInsertBehavior">setInsertBehavior</a> (self, <a href="../ktexteditor/KTextEditor.SmartCursor.html#InsertBehavior">KTextEditor.SmartCursor.InsertBehavior</a> insertBehavior)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setWatcher">setWatcher</a> (self, <a href="../ktexteditor/KTextEditor.SmartCursorWatcher.html">KTextEditor.SmartCursorWatcher</a> watcher=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.SmartRange.html">KTextEditor.SmartRange</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#smartRange">smartRange</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.SmartCursor.html">KTextEditor.SmartCursor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#toSmartCursor">toSmartCursor</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.SmartCursorWatcher.html">KTextEditor.SmartCursorWatcher</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#watcher">watcher</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="SmartCursor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>doc</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.SmartCursor.html#InsertBehavior">KTextEditor.SmartCursor.InsertBehavior</a> </td>
<td class="paramname"><em>insertBehavior</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl> </p>
<p>
Constructor for subclasses to utilise. Protected to prevent direct
instantiation.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> 3rd party developers: you do not (and should not) need to subclass
the Smart* classes; instead, use the SmartInterface to create instances.
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>position</em> </td><td> the cursor position to assign
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>doc</em> </td><td> the Document this cursor is associated with
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>insertBehavior</em> </td><td> the behavior of this cursor when on the position of an insert.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="SmartCursor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.SmartCursor.html">KTextEditor.SmartCursor</a> </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
Copy constructor: Disable copying of this class.
</dd></dl>
</p></div></div><a class="anchor" name="advance"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool advance</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>distance</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.SmartCursor.html#AdvanceMode">KTextEditor.SmartCursor.AdvanceMode</a> </td>
<td class="paramname"><em>mode=KTextEditor.SmartCursor.ByCharacter</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Move cursor by specified <b>distance</b> along the document buffer.
</p>
<p>
E.g.:
<pre class="fragment">
cursor.advance(1);
</pre>
will move the cursor forward by one character, or, if the cursor is already
on the end of the line, will move it to the start of the next line.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> Negative numbers should be accepted, and move backwards.
</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd> Not all <b>mode%s</b> are required to be supported.
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>distance</em> </td><td> distance to advance (or go back if <b>distance</b> is negative)
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mode</em> </td><td> whether to move by character, or by number of valid cursor positions
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the position could be reached within the document, otherwise false
(the cursor should not move if <b>distance</b> is beyond the end of the document).
</dd></dl>
</p></div></div><a class="anchor" name="atEndOfDocument"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool atEndOfDocument</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Determine if this cursor is located at the end of the document.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the cursor is situated at the end of the document, otherwise false.
</dd></dl>
</p></div></div><a class="anchor" name="atEndOfLine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool atEndOfLine</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Determine if this cursor is located at the end of the current line.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the cursor is situated at the end of the line, otherwise false.
</dd></dl>
</p></div></div><a class="anchor" name="character"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QChar character</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the character in the document immediately after this position,
ie. from this position to this position plus Cursor(0,1).
</p></div></div><a class="anchor" name="deleteNotifier"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> deleteNotifier</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Deletes the current SmartCursorNotifier.
</p>
<p>
When finished with a notifier, call this method to save memory, and potentially
editor logic processing time, by having the SmartCursorNotifier deleted.
</p></div></div><a class="anchor" name="document"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the document to which this cursor is attached.
</p></div></div><a class="anchor" name="hasNotifier"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasNotifier</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Determine if a notifier already exists for this smart cursor.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if a notifier already exists, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="insertBehavior"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.SmartCursor.html#InsertBehavior">KTextEditor.SmartCursor.InsertBehavior</a> insertBehavior</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns how this cursor behaves when text is inserted at the cursor.
Defaults to moving on insert.
</p></div></div><a class="anchor" name="insertText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool insertText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>block=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Insert <b>text</b> into the associated Document.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> text to insert
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> insert this text as a visual block of text rather than a linear sequence
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="isSmartCursor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isSmartCursor</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns that this cursor is a SmartCursor.
</p></div></div><a class="anchor" name="isValid"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isValid</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>\reimp
\sa Document.cursorInText()
</p></div></div><a class="anchor" name="notifier"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.SmartCursorNotifier.html">KTextEditor.SmartCursorNotifier</a> notifier</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Returns the current SmartCursorNotifier. If one does not already exist,
it will be created.
</p>
<p>
Connect to the notifier to receive signals indicating change of state of this cursor.
The notifier is created at the time it is first requested. If you have finished with
notifications for a reasonable period of time you can save memory, and potentially
editor logic processing time, by calling deleteNotifier().
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the current SmartCursorNotifier for this SmartCursor.
If one does not already exist, it will be created.
</dd></dl>
</p></div></div><a class="anchor" name="setInsertBehavior"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setInsertBehavior</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.SmartCursor.html#InsertBehavior">KTextEditor.SmartCursor.InsertBehavior</a> </td>
<td class="paramname"><em>insertBehavior</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Change the behavior of the cursor when text is inserted at the cursor.
</p>
<p>
If <b>moveOnInsert</b> is true, the cursor will end up at the end of the insert.
</p></div></div><a class="anchor" name="setWatcher"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setWatcher</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.SmartCursorWatcher.html">KTextEditor.SmartCursorWatcher</a> </td>
<td class="paramname"><em>watcher=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Provide a SmartCursorWatcher to receive calls indicating change of state of this cursor.
To finish receiving notifications, call this function with <b>watcher</b> set to 0L.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>watcher</em> </td><td> the class which will receive notifications about changes to this cursor.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="smartRange"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.SmartRange.html">KTextEditor.SmartRange</a> smartRange</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the range that this cursor belongs to, if any.
</p>
<p>
\sa Cursor.range()
</p></div></div><a class="anchor" name="toSmartCursor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.SmartCursor.html">KTextEditor.SmartCursor</a> toSmartCursor</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns this cursor as a SmartCursor
</p></div></div><a class="anchor" name="watcher"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.SmartCursorWatcher.html">KTextEditor.SmartCursorWatcher</a> watcher</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Returns a pointer to the current SmartCursorWatcher, if one has been set.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the current SmartCursorWatcher pointer if one exists, otherwise null.
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="AdvanceMode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">AdvanceMode</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Defines the ways in which the cursor can be advanced.
Important for languages where multiple characters are required to
form one letter.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ByCharacter</em> </td><td><tr><td valign="top"><em>ByCursorPosition</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="InsertBehavior"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">InsertBehavior</td>
</tr>
</table>
</div>
<div class="memdoc"><p>
Behavior
</p>
<p>
The following functions relate to the behavior of this SmartCursor.
\{
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>DoNotExpand</em> = 0</td><td><tr><td valign="top"><em>ExpandLeft</em> = 0x1</td><td><tr><td valign="top"><em>ExpandRight</em> = 0x2</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" 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>
</body>
</html>
