<?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: KateSuperRange 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-slots">Public Slots</a> |
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">KateSuperRange Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KateSuperRange" --><!-- doxytag: inherits="QObject,KateRange" -->
<p>Represents a range of text, from the start() to the end().
<a href="classKateSuperRange.html#details">More...</a></p>
<p><code>#include <<a class="el" href="katesupercursor_8h_source.html">katesupercursor.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KateSuperRange:</div>
<div class="dyncontent">
<div class="center">
<img src="classKateSuperRange.png" usemap="#KateSuperRange_map" alt=""/>
<map id="KateSuperRange_map" name="KateSuperRange_map">
<area href="qobject.html" alt="QObject" shape="rect" coords="0,0,107,24"/>
</map>
</div></div>
<p><a href="classKateSuperRange-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="classKateSuperRange.html#a89149476b5c161ecb5f3756ec25c474a">InsertBehaviour</a> { <a class="el" href="classKateSuperRange.html#a89149476b5c161ecb5f3756ec25c474aa05cb2a5ea7eab44a88ea308efcabd22e">DoNotExpand</a> = 0,
<a class="el" href="classKateSuperRange.html#a89149476b5c161ecb5f3756ec25c474aaec1f9f466caa013f9a3c7d52d48793a0">ExpandLeft</a> = 0x1,
<a class="el" href="classKateSuperRange.html#a89149476b5c161ecb5f3756ec25c474aad42d3b564ff103c895c1212b30e6b7c0">ExpandRight</a> = 0x2
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a090bafc30c7e24d73ed7a823b0e71cbc"></a><!-- doxytag: member="KateSuperRange::slotTagRange" ref="a090bafc30c7e24d73ed7a823b0e71cbc" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>slotTagRange</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a9f7597f4e740659ab3b621a34b91f044">positionChanged</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#ab140a974594efee158eda0a12f6aab35">positionUnChanged</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a4d8b73683db7cbd1e1d59548549b50d1">contentsChanged</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#aa335ab38cc87db719a87ea468bebf9ee">boundaryDeleted</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a5dd1b8f854f1bf53ea6e320d9a19cd6a">eliminated</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#aade151f414400009575a7149dac828ea">tagRange</a> (<a class="el" href="classKateSuperRange.html">KateSuperRange</a> *range)</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#af63e9f5ef64031ea5a52a2a2658c3c98">KateSuperRange</a> (<a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> *start, <a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> *end, <a class="elRef" href="qobject.html">QObject</a> *<a class="elRef" href="qobject.html#parent">parent</a>=0L, const char *name=0L)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15979a29cefb48b086f8fc3e54a277a8"></a><!-- doxytag: member="KateSuperRange::KateSuperRange" ref="a15979a29cefb48b086f8fc3e54a277a8" args="(KateDocument *doc, const KateRange &range, QObject *parent=0L, const char *name=0L)" -->
 </td><td class="memItemRight" valign="bottom"><b>KateSuperRange</b> (KateDocument *doc, const KateRange &range, <a class="elRef" href="qobject.html">QObject</a> *<a class="elRef" href="qobject.html#parent">parent</a>=0L, const char *name=0L)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72fc718552d70baa985309eec47553bb"></a><!-- doxytag: member="KateSuperRange::KateSuperRange" ref="a72fc718552d70baa985309eec47553bb" args="(KateDocument *doc, const KateTextCursor &start, const KateTextCursor &end, QObject *parent=0L, const char *name=0L)" -->
 </td><td class="memItemRight" valign="bottom"><b>KateSuperRange</b> (KateDocument *doc, const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> &start, const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> &end, <a class="elRef" href="qobject.html">QObject</a> *<a class="elRef" href="qobject.html#parent">parent</a>=0L, const char *name=0L)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecabcd0b49943134eab68c8b8acb7cd0"></a><!-- doxytag: member="KateSuperRange::start" ref="aecabcd0b49943134eab68c8b8acb7cd0" args="()" -->
virtual <a class="el" href="classKateTextCursor.html">KateTextCursor</a> & </td><td class="memItemRight" valign="bottom"><b>start</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a438588a618cd33297d3115b04cedf729"></a><!-- doxytag: member="KateSuperRange::end" ref="a438588a618cd33297d3115b04cedf729" args="()" -->
virtual <a class="el" href="classKateTextCursor.html">KateTextCursor</a> & </td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5da661a4c60988f7e469bf37918309ce"></a><!-- doxytag: member="KateSuperRange::start" ref="a5da661a4c60988f7e469bf37918309ce" args="() const " -->
virtual const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> & </td><td class="memItemRight" valign="bottom"><b>start</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98fd139c37e9798dd6a57543d7f48b9f"></a><!-- doxytag: member="KateSuperRange::end" ref="a98fd139c37e9798dd6a57543d7f48b9f" args="() const " -->
virtual const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> & </td><td class="memItemRight" valign="bottom"><b>end</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7440eb9d724e9aeea2719375eef3fa42"></a><!-- doxytag: member="KateSuperRange::allowZeroLength" ref="a7440eb9d724e9aeea2719375eef3fa42" args="(bool yes=true)" -->
void </td><td class="memItemRight" valign="bottom"><b>allowZeroLength</b> (bool yes=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a81f48cf289666659c81e40af6daa091e">superStart</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f0286d9cd26479a6da591288b36b630"></a><!-- doxytag: member="KateSuperRange::superStart" ref="a4f0286d9cd26479a6da591288b36b630" args="() const " -->
const <a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> & </td><td class="memItemRight" valign="bottom"><b>superStart</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a3eaea490295753d3e8fdc24a5decb4d3">superEnd</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55f15a76ca089610f3e4a8657a5c5905"></a><!-- doxytag: member="KateSuperRange::superEnd" ref="a55f15a76ca089610f3e4a8657a5c5905" args="() const " -->
const <a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> & </td><td class="memItemRight" valign="bottom"><b>superEnd</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#af8ae5b9b48e8b8578b4b83f4b780c271">behaviour</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#aff7c2f189f9aecd2844e03fd0d23324a">setBehaviour</a> (int behaviour)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a1238c7631c4dc233cd5cfe6617a45b48">isValid</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#ab3f85b287b5ea00886e28438bb0db154">owns</a> (const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> &cursor) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a5a16395cbacac54a701edd91f27799fc">includes</a> (const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> &cursor) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#ac84d65dee30f47c8d21525cf423788ca">includes</a> (uint lineNum) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#aaf261d63baf31b031f61e3fda95ec0cf">includesWholeLine</a> (uint lineNum) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a9b8ec7ac735f0ad6638328806caefa88">boundaryAt</a> (const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> &cursor) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKateSuperRange.html#a11d731cd64fe5da3ca0aeacb307b35a4">boundaryOn</a> (uint lineNum) const </td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d8ba92b530bacf4d96dd12b1357d619"></a><!-- doxytag: member="KateSuperRange::KateSuperRangeList" ref="a3d8ba92b530bacf4d96dd12b1357d619" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>KateSuperRangeList</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Represents a range of text, from the start() to the end(). </p>
<p>Also tracks its position and emits useful signals. </p>
<p>Definition at line <a class="el" href="katesupercursor_8h_source.html#l00168">168</a> of file <a class="el" href="katesupercursor_8h_source.html">katesupercursor.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a89149476b5c161ecb5f3756ec25c474a"></a><!-- doxytag: member="KateSuperRange::InsertBehaviour" ref="a89149476b5c161ecb5f3756ec25c474a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKateSuperRange.html#a89149476b5c161ecb5f3756ec25c474a">KateSuperRange::InsertBehaviour</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine how the range reacts to characters inserted immediately outside the range. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a89149476b5c161ecb5f3756ec25c474aa05cb2a5ea7eab44a88ea308efcabd22e"></a><!-- doxytag: member="DoNotExpand" ref="a89149476b5c161ecb5f3756ec25c474aa05cb2a5ea7eab44a88ea308efcabd22e" args="" -->DoNotExpand</em> </td><td>
<p>Don't expand to encapsulate new characters in either direction. This is the default. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a89149476b5c161ecb5f3756ec25c474aaec1f9f466caa013f9a3c7d52d48793a0"></a><!-- doxytag: member="ExpandLeft" ref="a89149476b5c161ecb5f3756ec25c474aaec1f9f466caa013f9a3c7d52d48793a0" args="" -->ExpandLeft</em> </td><td>
<p>Expand to encapsulate new characters to the left of the range. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a89149476b5c161ecb5f3756ec25c474aad42d3b564ff103c895c1212b30e6b7c0"></a><!-- doxytag: member="ExpandRight" ref="a89149476b5c161ecb5f3756ec25c474aad42d3b564ff103c895c1212b30e6b7c0" args="" -->ExpandRight</em> </td><td>
<p>Expand to encapsulate new characters to the right of the range. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="katesupercursor_8h_source.html#l00176">176</a> of file <a class="el" href="katesupercursor_8h_source.html">katesupercursor.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af63e9f5ef64031ea5a52a2a2658c3c98"></a><!-- doxytag: member="KateSuperRange::KateSuperRange" ref="af63e9f5ef64031ea5a52a2a2658c3c98" args="(KateSuperCursor *start, KateSuperCursor *end, QObject *parent=0L, const char *name=0L)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KateSuperRange::KateSuperRange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> * </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> * </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qobject.html">QObject</a> * </td>
<td class="paramname"><em>parent</em> = <code>0L</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0L</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Takes posession of <code>start</code> and <code>end</code>. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00280">280</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af8ae5b9b48e8b8578b4b83f4b780c271"></a><!-- doxytag: member="KateSuperRange::behaviour" ref="af8ae5b9b48e8b8578b4b83f4b780c271" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int KateSuperRange::behaviour </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns how this range reacts to characters inserted immediately outside the range. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00393">393</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9b8ec7ac735f0ad6638328806caefa88"></a><!-- doxytag: member="KateSuperRange::boundaryAt" ref="a9b8ec7ac735f0ad6638328806caefa88" args="(const KateTextCursor &cursor) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateSuperRange::boundaryAt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> & </td>
<td class="paramname"><em>cursor</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether <code>cursor</code> is the site of a boundary of this range. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00437">437</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa335ab38cc87db719a87ea468bebf9ee"></a><!-- doxytag: member="KateSuperRange::boundaryDeleted" ref="aa335ab38cc87db719a87ea468bebf9ee" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateSuperRange::boundaryDeleted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Either cursor's surrounding characters were both deleted. </p>
</div>
</div>
<a class="anchor" id="a11d731cd64fe5da3ca0aeacb307b35a4"></a><!-- doxytag: member="KateSuperRange::boundaryOn" ref="a11d731cd64fe5da3ca0aeacb307b35a4" args="(uint lineNum) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateSuperRange::boundaryOn </td>
<td>(</td>
<td class="paramtype">uint </td>
<td class="paramname"><em>lineNum</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether there is a boundary of this range on <code>line</code>. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00442">442</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4d8b73683db7cbd1e1d59548549b50d1"></a><!-- doxytag: member="KateSuperRange::contentsChanged" ref="a4d8b73683db7cbd1e1d59548549b50d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateSuperRange::contentsChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The contents of the range changed. </p>
</div>
</div>
<a class="anchor" id="a5dd1b8f854f1bf53ea6e320d9a19cd6a"></a><!-- doxytag: member="KateSuperRange::eliminated" ref="a5dd1b8f854f1bf53ea6e320d9a19cd6a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateSuperRange::eliminated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The range now contains no characters (ie. </p>
<p>the start and end cursors are the same).</p>
<p>To eliminate this range under different conditions, connect the other signal directly to this signal. </p>
</div>
</div>
<a class="anchor" id="a5a16395cbacac54a701edd91f27799fc"></a><!-- doxytag: member="KateSuperRange::includes" ref="a5a16395cbacac54a701edd91f27799fc" args="(const KateTextCursor &cursor) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateSuperRange::includes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> & </td>
<td class="paramname"><em>cursor</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the range includes <code>cursor</code> 's character. </p>
<p>Returns false if <code>cursor</code> == end(). </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00422">422</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac84d65dee30f47c8d21525cf423788ca"></a><!-- doxytag: member="KateSuperRange::includes" ref="ac84d65dee30f47c8d21525cf423788ca" args="(uint lineNum) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateSuperRange::includes </td>
<td>(</td>
<td class="paramtype">uint </td>
<td class="paramname"><em>lineNum</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the range includes <code>line</code>. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00427">427</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaf261d63baf31b031f61e3fda95ec0cf"></a><!-- doxytag: member="KateSuperRange::includesWholeLine" ref="aaf261d63baf31b031f61e3fda95ec0cf" args="(uint lineNum) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateSuperRange::includesWholeLine </td>
<td>(</td>
<td class="paramtype">uint </td>
<td class="paramname"><em>lineNum</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the range totally encompasses <code>line</code>. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00432">432</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1238c7631c4dc233cd5cfe6617a45b48"></a><!-- doxytag: member="KateSuperRange::isValid" ref="a1238c7631c4dc233cd5cfe6617a45b48" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateSuperRange::isValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start and end must be valid and start <= end. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00404">404</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab3f85b287b5ea00886e28438bb0db154"></a><!-- doxytag: member="KateSuperRange::owns" ref="ab3f85b287b5ea00886e28438bb0db154" args="(const KateTextCursor &cursor) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KateSuperRange::owns </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKateTextCursor.html">KateTextCursor</a> & </td>
<td class="paramname"><em>cursor</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is for use where the ranges are used in a heirachy, ie. </p>
<p>their parents are KateSuperRanges which completely encapsulate them.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>constrain children when their position changes deliberately; eliminate() children when they are equivalent to their parents</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the range contains the cursor and no children also contain it; false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00409">409</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9f7597f4e740659ab3b621a34b91f044"></a><!-- doxytag: member="KateSuperRange::positionChanged" ref="a9f7597f4e740659ab3b621a34b91f044" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateSuperRange::positionChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>More interesting signals that aren't worth implementing here: firstCharDeleted: start()::charDeleted() lastCharDeleted: end()::previousCharDeleted() </p>
<p>The range's position changed. </p>
</div>
</div>
<a class="anchor" id="ab140a974594efee158eda0a12f6aab35"></a><!-- doxytag: member="KateSuperRange::positionUnChanged" ref="ab140a974594efee158eda0a12f6aab35" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateSuperRange::positionUnChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The range's position was unchanged. </p>
</div>
</div>
<a class="anchor" id="aff7c2f189f9aecd2844e03fd0d23324a"></a><!-- doxytag: member="KateSuperRange::setBehaviour" ref="aff7c2f189f9aecd2844e03fd0d23324a" args="(int behaviour)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateSuperRange::setBehaviour </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>behaviour</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine how the range should react to characters inserted immediately outside the range. </p>
<p>TODO does this need a custom function to enable determining of the behavior based on the text that is inserted / deleted?</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classKateSuperRange.html#a89149476b5c161ecb5f3756ec25c474a" title="Determine how the range reacts to characters inserted immediately outside the range.">InsertBehaviour</a> </dd></dl>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00398">398</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3eaea490295753d3e8fdc24a5decb4d3"></a><!-- doxytag: member="KateSuperRange::superEnd" ref="a3eaea490295753d3e8fdc24a5decb4d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> & KateSuperRange::superEnd </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the super end cursor. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00383">383</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a81f48cf289666659c81e40af6daa091e"></a><!-- doxytag: member="KateSuperRange::superStart" ref="a81f48cf289666659c81e40af6daa091e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKateSuperCursor.html">KateSuperCursor</a> & KateSuperRange::superStart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the super start cursor. </p>
<p>Definition at line <a class="el" href="katesupercursor_8cpp_source.html#l00373">373</a> of file <a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aade151f414400009575a7149dac828ea"></a><!-- doxytag: member="KateSuperRange::tagRange" ref="aade151f414400009575a7149dac828ea" args="(KateSuperRange *range)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KateSuperRange::tagRange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKateSuperRange.html">KateSuperRange</a> * </td>
<td class="paramname"><em>range</em></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates the region needs re-drawing. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="katesupercursor_8h_source.html">katesupercursor.h</a></li>
<li><a class="el" href="katesupercursor_8cpp_source.html">katesupercursor.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>
