<?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.MovingRange</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>MovingRange Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
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 range that is bound to a specific Document, and maintains its
position.
</p>
<p>
<b>Introduction </b>
</p>
<p>
A MovingRange is an extension of the basic Range class. It maintains its
position in the document. As a result of this, MovingRange%s may not be
copied, as they need to maintain a connection to the associated Document.
</p>
<p>
Create a new MovingRange like this:
<pre class="fragment">
// Retrieve the MovingInterface
KTextEditor.MovingInterface* moving =
qobject_cast<KTextEditor.MovingInterface*>( yourDocument );
if ( moving ) {
KTextEditor.MovingRange* range = moving->newMovingRange();
}
</pre>
</p>
<p>
When finished with a MovingRange, simply delete it.
If the document the cursor belong to is deleted, it will get deleted
automatically.
</p>
<p>
<b>Editing Behavior </b>
</p>
<p>
The insert behavior controls how the range reacts to characters inserted
at the range boundaries, i.e. at the start of the range or the end of the
range. Either the range boundary moves with text insertion, or it stays.
Use setInsertBehaviors() and insertBehaviors() to set and query the current
insert behavior.
</p>
<p>
When the start() and end() Cursor of a range equal, isEmpty() returns true.
Further, the empty-behavior can be changed such that the start() and end()
Cursor%s of MovingRange%s that get empty are automatically set to (-1, -1).
Use setEmptyBehavior() and emptyBehavior() to control the empty behavior.
</p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> MovingRanges may be set to (-1, -1, -1, -1) at any time, if the
user reloads a document (F5)! Use a MovingRangeFeedback to get notified
if you need to catch this case.
</dd></dl> </p>
<p>
<b>MovingRange Feedback </b>
</p>
<p>
With setFeedback() a feedback instance can be associated with the moving
range. The MovingRangeFeedback notifies about the following events:
- the text cursor (caret) entered the range,
- the text cursor (caret) left the range,
- the mouse cursor entered the range,
- the mouse cursor left the range,
- the range got empty, i.e. start() == end(),
- the range got invalid, i.e. start() == end() == (-1, -1).
</p>
<p>
If a feedback is not needed anymore, call setFeedback(0).
</p>
<p>
<b>Working with Ranges </b>
</p>
<p>
There are several convenience methods that make working with MovingRanges
very simple. For instance, use isEmpty() to check if the start() Cursor
equals the end() Cursor. Use contains(), containsLine() or containsColumn()
to check whether the MovingRange contains a Range, a Cursor, a line or
column. The same holds for overlaps(), overlapsLine() and overlapsColumn().
Besides onSingleLine() returns whether a MovingRange spans only one line.
</p>
<p>
For compatibility, a MovingRange can be explicitly converted to a simple
Range by calling toRange(), or implicitly by the Range operator.
</p>
<p>
<b>Arbitrary Highlighting </b>
</p>
<p>
With setAttribute() highlighting Attribute%s can be assigned to a
MovingRange. By default, this highlighting is used in all views of a
document. Use setView(), if the highlighting should only appear in a
specific view. Further, if the additional highlighting should not be
printed call setAttributeOnlyForViews() with the parameter true.
</p>
<p>
\sa Cursor, MovingCursor, Range, MovingInterface, MovingRangeFeedback
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Christoph Cullmann <cullmann@kde.org> </dd></dl>
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</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="#EmptyBehavior">EmptyBehavior</a> </td><td class="memItemRight" valign="bottom">{ AllowEmpty, InvalidateIfEmpty }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#InsertBehavior">InsertBehavior</a> </td><td class="memItemRight" valign="bottom">{ DoNotExpand, ExpandLeft, ExpandRight }</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="#MovingRange">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#MovingRange">__init__</a> (self, <a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<KTextEditor::Attribute> </td><td class="memItemRight" valign="bottom"><a class="el" href="#attribute">attribute</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#attributeOnlyForViews">attributeOnlyForViews</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#contains">contains</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#contains">contains</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> cursor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#containsColumn">containsColumn</a> (self, int column)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#containsLine">containsLine</a> (self, int line)</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"><a href="../ktexteditor/KTextEditor.MovingRange.html#EmptyBehavior">KTextEditor.MovingRange.EmptyBehavior</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#emptyBehavior">emptyBehavior</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.MovingCursor.html">KTextEditor.MovingCursor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#end">end</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.MovingRangeFeedback.html">KTextEditor.MovingRangeFeedback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#feedback">feedback</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange.InsertBehaviors</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertBehaviors">insertBehaviors</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isEmpty">isEmpty</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#onSingleLine">onSingleLine</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#overlaps">overlaps</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#overlapsColumn">overlapsColumn</a> (self, int column)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#overlapsLine">overlapsLine</a> (self, int line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAttribute">setAttribute</a> (self, KSharedPtr<KTextEditor::Attribute> attribute)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAttributeOnlyForViews">setAttributeOnlyForViews</a> (self, bool onlyForViews)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setEmptyBehavior">setEmptyBehavior</a> (self, <a href="../ktexteditor/KTextEditor.MovingRange.html#EmptyBehavior">KTextEditor.MovingRange.EmptyBehavior</a> emptyBehavior)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFeedback">setFeedback</a> (self, <a href="../ktexteditor/KTextEditor.MovingRangeFeedback.html">KTextEditor.MovingRangeFeedback</a> feedback)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setInsertBehaviors">setInsertBehaviors</a> (self, <a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange.InsertBehaviors</a> insertBehaviors)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRange">setRange</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRange">setRange</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> start, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> end)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setView">setView</a> (self, <a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> view)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setZDepth">setZDepth</a> (self, float zDepth)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.MovingCursor.html">KTextEditor.MovingCursor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#start">start</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#toRange">toRange</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#view">view</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#zDepth">zDepth</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="MovingRange"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</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>no copy constructor, don't allow this to be copied.
</p></div></div><a class="anchor" name="MovingRange"></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.MovingRange.html">KTextEditor.MovingRange</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>no copy constructor, don't allow this to be copied.
</p></div></div><a class="anchor" name="attribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">KSharedPtr<KTextEditor::Attribute> attribute</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>Gets the active Attribute for this range.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the active attribute
</dd></dl>
</p></div></div><a class="anchor" name="attributeOnlyForViews"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool attributeOnlyForViews</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>Is this range's attribute only visible in views, not for example prints?
Default is false.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> range visible only for views
</dd></dl>
</p></div></div><a class="anchor" name="contains"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool contains</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.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Check to see if <b>cursor</b> is contained within this range, ie >= start() and < end().
</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>cursor</em> </td><td> the position to test for containment
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the cursor is contained within this range, otherwise false.
</dd></dl>
</p></div></div><a class="anchor" name="contains"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool contains</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>cursor</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Check to see if <b>cursor</b> is contained within this range, ie >= start() and < end().
</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>cursor</em> </td><td> the position to test for containment
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the cursor is contained within this range, otherwise false.
</dd></dl>
</p></div></div><a class="anchor" name="containsColumn"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool containsColumn</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>column</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Check whether the range contains column.
</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>column</em> </td><td> column to check
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the range contains column, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="containsLine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool containsLine</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>line</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns true if this range wholly encompasses <b>line.</b>
</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>line</em> </td><td> line to check
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the line is wholly encompassed by this range, otherwise false.
</dd></dl>
</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"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Gets the document to which this range is bound.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the document
</dd></dl>
</p></div></div><a class="anchor" name="emptyBehavior"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.MovingRange.html#EmptyBehavior">KTextEditor.MovingRange.EmptyBehavior</a> emptyBehavior</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>Will this range invalidate itself if it becomes empty?
<dl class="return" compact><dt><b>Returns:</b></dt><dd> behavior on becoming empty
</dd></dl>
</p></div></div><a class="anchor" name="end"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.MovingCursor.html">KTextEditor.MovingCursor</a> end</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>Retrieve end cursor of this range, read-only.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> end cursor
</dd></dl>
</p></div></div><a class="anchor" name="feedback"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.MovingRangeFeedback.html">KTextEditor.MovingRangeFeedback</a> feedback</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>Gets the active MovingRangeFeedback for this range.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the active MovingRangeFeedback
</dd></dl>
</p></div></div><a class="anchor" name="insertBehaviors"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.MovingRange.html">KTextEditor.MovingRange.InsertBehaviors</a> insertBehaviors</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>Get current insert behaviors.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> current insert behaviors
</dd></dl>
</p></div></div><a class="anchor" name="isEmpty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isEmpty</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 true if this range contains no characters, ie. the start() and
end() positions are the same.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the range contains no characters, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="onSingleLine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool onSingleLine</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>Check whether the start() and end() cursors of this range
are on the same line.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if both the start and end positions are on the same
line, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="overlaps"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool overlaps</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.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Check whether the this range overlaps with range.
</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>range</em> </td><td> range to check against
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true, if this range overlaps with range, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="overlapsColumn"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool overlapsColumn</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>column</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Check to see if this range overlaps <b>column;</b> that is, if <b>column</b> is
between start().column() and end().column(). This function is most likely
to be useful in relation to block text editing.
</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>column</em> </td><td> the column to test
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the column is between the range's starting and ending
columns, otherwise false.
</dd></dl>
</p></div></div><a class="anchor" name="overlapsLine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool overlapsLine</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>line</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Check whether the range overlaps at least part of line.
</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>line</em> </td><td> line to check
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true, if the range overlaps at least part of line, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="setAttribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setAttribute</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">KSharedPtr<KTextEditor::Attribute> </td>
<td class="paramname"><em>attribute</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>Sets the currently active attribute for this range.
This will trigger update of the relevant view parts, if the attribute changed.
</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>attribute</em> </td><td> Attribute to assign to this range. If null, simply
removes the previous Attribute.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setAttributeOnlyForViews"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setAttributeOnlyForViews</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">bool </td>
<td class="paramname"><em>onlyForViews</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>Set if this range's attribute is only visible in views, not for example prints.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>onlyForViews</em> </td><td> attribute only valid for views
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setEmptyBehavior"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setEmptyBehavior</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.MovingRange.html#EmptyBehavior">KTextEditor.MovingRange.EmptyBehavior</a> </td>
<td class="paramname"><em>emptyBehavior</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>Set if this range will invalidate itself if it becomes empty.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>emptyBehavior</em> </td><td> behavior on becoming empty
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setFeedback"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setFeedback</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.MovingRangeFeedback.html">KTextEditor.MovingRangeFeedback</a> </td>
<td class="paramname"><em>feedback</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>Sets the currently active MovingRangeFeedback for this range.
This will trigger evaluation if feedback must be send again (for example if mouse is already inside range).
</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>attribute</em> </td><td> MovingRangeFeedback to assign to this range. If null, simply
removes the previous MovingRangeFeedback.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setInsertBehaviors"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setInsertBehaviors</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.MovingRange.html">KTextEditor.MovingRange.InsertBehaviors</a> </td>
<td class="paramname"><em>insertBehaviors</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>Set insert behaviors.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>insertBehaviors</em> </td><td> new insert behaviors
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setRange"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRange</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.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</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>
Set the range of this range
A TextRange is not allowed to be empty, as soon as start == end position, it will become
automatically invalid!
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>start</em> </td><td> new start for this clever range
<tr><td></td><td valign="top"><em>end</em> </td><td> new end for this clever range
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setRange"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRange</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>start</em>, </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>end</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>
Set the range of this range
A TextRange is not allowed to be empty, as soon as start == end position, it will become
automatically invalid!
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>start</em> </td><td> new start for this clever range
<tr><td></td><td valign="top"><em>end</em> </td><td> new end for this clever range
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setView"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setView</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.View.html">KTextEditor.View</a> </td>
<td class="paramname"><em>view</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>Sets the currently active view for this range.
This will trigger update of the relevant view parts, if the view changed.
Set view before the attribute, that will avoid not needed redraws.
</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>attribute</em> </td><td> View to assign to this range. If null, simply
removes the previous view.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setZDepth"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setZDepth</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">float </td>
<td class="paramname"><em>zDepth</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>Set the current Z-depth of this range.
Ranges with smaller Z-depth than others will win during rendering.
This will trigger update of the relevant view parts, if the depth changed.
Set depth before the attribute, that will avoid not needed redraws.
Default is 0.0.
</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>zDepth</em> </td><td> new Z-depth of this range
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="start"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.MovingCursor.html">KTextEditor.MovingCursor</a> start</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>Retrieve start cursor of this range, read-only.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> start cursor
</dd></dl>
</p></div></div><a class="anchor" name="toRange"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> toRange</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>Convert this clever range into a dumb one.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> normal range
</dd></dl>
</p></div></div><a class="anchor" name="view"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> view</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>Gets the active view for this range. Might be already invalid, internally only used for pointer comparisons.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the active view
</dd></dl>
</p></div></div><a class="anchor" name="zDepth"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">float zDepth</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>Gets the current Z-depth of this range.
Ranges with smaller Z-depth than others will win during rendering.
Default is 0.0.
</p>
<p>
Defined depths for common kind of ranges use in editor components implenting this interface,
smaller depths are more more in the foreground and will win during rendering:
- Selection == -100000.0
- Search == -10000.0
- Bracket Highlighting == -1000.0
- Folding Hover == -100.0
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> current Z-depth of this range
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="EmptyBehavior"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">EmptyBehavior</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Behavior of range if it becomes empty.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>AllowEmpty</em> = 0x0</td><td><tr><td valign="top"><em>InvalidateIfEmpty</em> = 0x1</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"><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>
