.TH "KateSuperRange" kde3 "11 Jun 2005" "Version Version 3.4.1" "kate Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KateSuperRange \- Represents a range of text, from the start() to the end().  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <katesupercursor.h>\fP
.PP
Inherits \fBQObject\fP, and KateRange.
.PP
Inherited by KateArbitraryHighlightRange.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBInsertBehaviour\fP { \fBDoNotExpand\fP =  0, \fBExpandLeft\fP =  0x1, \fBExpandRight\fP =  0x2 }"
.br
.in -1c
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBslotTagRange\fP ()"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBpositionChanged\fP ()"
.br
.ti -1c
.RI "void \fBpositionUnChanged\fP ()"
.br
.ti -1c
.RI "void \fBcontentsChanged\fP ()"
.br
.ti -1c
.RI "void \fBboundaryDeleted\fP ()"
.br
.ti -1c
.RI "void \fBeliminated\fP ()"
.br
.ti -1c
.RI "void \fBtagRange\fP (\fBKateSuperRange\fP *range)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKateSuperRange\fP (\fBKateSuperCursor\fP *start, \fBKateSuperCursor\fP *end, \fBQObject\fP *\fBparent\fP=0L, const char *\fBname\fP=0L)"
.br
.ti -1c
.RI "\fBKateSuperRange\fP (KateDocument *doc, const KateRange &range, \fBQObject\fP *\fBparent\fP=0L, const char *\fBname\fP=0L)"
.br
.ti -1c
.RI "\fBKateSuperRange\fP (KateDocument *doc, const \fBKateTextCursor\fP &start, const \fBKateTextCursor\fP &end, \fBQObject\fP *\fBparent\fP=0L, const char *\fBname\fP=0L)"
.br
.ti -1c
.RI "virtual \fBKateTextCursor\fP & \fBstart\fP ()"
.br
.ti -1c
.RI "virtual \fBKateTextCursor\fP & \fBend\fP ()"
.br
.ti -1c
.RI "virtual const \fBKateTextCursor\fP & \fBstart\fP () const "
.br
.ti -1c
.RI "virtual const \fBKateTextCursor\fP & \fBend\fP () const "
.br
.ti -1c
.RI "void \fBallowZeroLength\fP (bool yes=true)"
.br
.ti -1c
.RI "\fBKateSuperCursor\fP & \fBsuperStart\fP ()"
.br
.ti -1c
.RI "const \fBKateSuperCursor\fP & \fBsuperStart\fP () const "
.br
.ti -1c
.RI "\fBKateSuperCursor\fP & \fBsuperEnd\fP ()"
.br
.ti -1c
.RI "const \fBKateSuperCursor\fP & \fBsuperEnd\fP () const "
.br
.ti -1c
.RI "int \fBbehaviour\fP () const "
.br
.ti -1c
.RI "void \fBsetBehaviour\fP (int behaviour)"
.br
.ti -1c
.RI "virtual bool \fBisValid\fP () const "
.br
.ti -1c
.RI "bool \fBowns\fP (const \fBKateTextCursor\fP &cursor) const "
.br
.ti -1c
.RI "bool \fBincludes\fP (const \fBKateTextCursor\fP &cursor) const "
.br
.ti -1c
.RI "bool \fBincludes\fP (uint lineNum) const "
.br
.ti -1c
.RI "bool \fBincludesWholeLine\fP (uint lineNum) const "
.br
.ti -1c
.RI "bool \fBboundaryAt\fP (const \fBKateTextCursor\fP &cursor) const "
.br
.ti -1c
.RI "bool \fBboundaryOn\fP (uint lineNum) const "
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKateSuperRangeList\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Represents a range of text, from the start() to the end(). 

Also tracks its position and emits useful signals. 
.PP
Definition at line 168 of file katesupercursor.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKateSuperRange::InsertBehaviour\fP"
.PP
Determine how the range reacts to characters inserted immediately outside the range. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIDoNotExpand \fP\fP
Don't expand to encapsulate new characters in either direction. This is the default. 
.TP
\fB\fIExpandLeft \fP\fP
Expand to encapsulate new characters to the left of the range. 
.TP
\fB\fIExpandRight \fP\fP
Expand to encapsulate new characters to the right of the range. 
.PP
Definition at line 176 of file katesupercursor.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KateSuperRange::KateSuperRange (\fBKateSuperCursor\fP * start, \fBKateSuperCursor\fP * end, \fBQObject\fP * parent = \fC0L\fP, const char * name = \fC0L\fP)"
.PP
Constructor. 
.PP
Takes posession of \fCstart\fP and \fCend\fP. 
.PP
Definition at line 275 of file katesupercursor.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKateSuperCursor\fP & KateSuperRange::superStart ()"
.PP
Returns the super start cursor. 
.PP
Definition at line 368 of file katesupercursor.cpp.
.PP
Referenced by boundaryAt(), boundaryOn(), includes(), includesWholeLine(), and isValid().
.SS "\fBKateSuperCursor\fP & KateSuperRange::superEnd ()"
.PP
Returns the super end cursor. 
.PP
Definition at line 378 of file katesupercursor.cpp.
.PP
Referenced by boundaryAt(), boundaryOn(), includes(), includesWholeLine(), and isValid().
.SS "int KateSuperRange::behaviour () const"
.PP
Returns how this range reacts to characters inserted immediately outside the range. 
.PP
Definition at line 388 of file katesupercursor.cpp.
.PP
References DoNotExpand, ExpandLeft, ExpandRight, and KateSuperCursor::moveOnInsert().
.SS "void KateSuperRange::setBehaviour (int behaviour)"
.PP
Determine how the range should react to characters inserted immediately outside the range. 
.PP
TODO does this need a custom function to enable determining of the behavior based on the text that is inserted / deleted?
.PP
\fBSee also:\fP
.RS 4
\fBInsertBehaviour\fP 
.RE
.PP

.PP
Definition at line 393 of file katesupercursor.cpp.
.PP
References ExpandLeft, ExpandRight, and KateSuperCursor::setMoveOnInsert().
.SS "bool KateSuperRange::isValid () const\fC [virtual]\fP"
.PP
Start and end must be valid and start <= end. 
.PP
Definition at line 399 of file katesupercursor.cpp.
.PP
References superEnd(), and superStart().
.PP
Referenced by boundaryAt(), boundaryOn(), includes(), and includesWholeLine().
.SS "bool KateSuperRange::owns (const \fBKateTextCursor\fP & cursor) const"
.PP
This is for use where the ranges are used in a heirachy, ie. 
.PP
their parents are KateSuperRanges which completely encapsulate them.
.PP
\fBReturns:\fP
.RS 4
true if the range contains the cursor and no children also contain it; false otherwise. 
.RE
.PP

.PP
Definition at line 404 of file katesupercursor.cpp.
.PP
References QObject::children(), and includes().
.SS "bool KateSuperRange::includes (const \fBKateTextCursor\fP & cursor) const"
.PP
Returns true if the range includes \fCcursor\fP 's character. 
.PP
Returns false if \fCcursor\fP == end(). 
.PP
Definition at line 417 of file katesupercursor.cpp.
.PP
References isValid(), superEnd(), and superStart().
.PP
Referenced by owns().
.SS "bool KateSuperRange::includes (uint lineNum) const"
.PP
Returns true if the range includes \fCline\fP. 
.PP
Definition at line 422 of file katesupercursor.cpp.
.PP
References isValid(), KateTextCursor::line(), superEnd(), and superStart().
.SS "bool KateSuperRange::includesWholeLine (uint lineNum) const"
.PP
Returns true if the range totally encompasses \fCline\fP. 
.PP
Definition at line 427 of file katesupercursor.cpp.
.PP
References KateSuperCursor::atEndOfLine(), KateSuperCursor::atStartOfLine(), isValid(), KateTextCursor::line(), superEnd(), and superStart().
.SS "bool KateSuperRange::boundaryAt (const \fBKateTextCursor\fP & cursor) const"
.PP
Returns whether \fCcursor\fP is the site of a boundary of this range. 
.PP
Definition at line 432 of file katesupercursor.cpp.
.PP
References isValid(), superEnd(), and superStart().
.SS "bool KateSuperRange::boundaryOn (uint lineNum) const"
.PP
Returns whether there is a boundary of this range on \fCline\fP. 
.PP
Definition at line 437 of file katesupercursor.cpp.
.PP
References isValid(), KateTextCursor::line(), superEnd(), and superStart().
.SS "void KateSuperRange::positionChanged ()\fC [signal]\fP"
.PP
The range's position changed. 
.PP
.SS "void KateSuperRange::positionUnChanged ()\fC [signal]\fP"
.PP
The range's position was unchanged. 
.PP
.SS "void KateSuperRange::contentsChanged ()\fC [signal]\fP"
.PP
The contents of the range changed. 
.PP
.SS "void KateSuperRange::boundaryDeleted ()\fC [signal]\fP"
.PP
Either cursor's surrounding characters were both deleted. 
.PP
.SS "void KateSuperRange::eliminated ()\fC [signal]\fP"
.PP
The range now contains no characters (ie. 
.PP
the start and end cursors are the same).
.PP
To eliminate this range under different conditions, connect the other signal directly to this signal. 
.SS "void KateSuperRange::tagRange (\fBKateSuperRange\fP * range)\fC [signal]\fP"
.PP
Indicates the region needs re-drawing. 
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kate Library from the source code.
