KateSuperRange Class Reference
Represents a range of text, from the start() to the end(). More...
#include <katesupercursor.h>
Inheritance diagram for KateSuperRange:

Public Types | |
enum | InsertBehaviour { DoNotExpand = 0, ExpandLeft = 0x1, ExpandRight = 0x2 } |
Public Slots | |
void | slotTagRange () |
Signals | |
void | positionChanged () |
void | positionUnChanged () |
void | contentsChanged () |
void | boundaryDeleted () |
void | eliminated () |
void | tagRange (KateSuperRange *range) |
Public Member Functions | |
KateSuperRange (KateSuperCursor *start, KateSuperCursor *end, QObject *parent=0L, const char *name=0L) | |
KateSuperRange (KateDocument *doc, const KateRange &range, QObject *parent=0L, const char *name=0L) | |
KateSuperRange (KateDocument *doc, const KateTextCursor &start, const KateTextCursor &end, QObject *parent=0L, const char *name=0L) | |
virtual KateTextCursor & | start () |
virtual KateTextCursor & | end () |
virtual const KateTextCursor & | start () const |
virtual const KateTextCursor & | end () const |
KateSuperCursor & | superStart () |
const KateSuperCursor & | superStart () const |
KateSuperCursor & | superEnd () |
const KateSuperCursor & | superEnd () const |
int | behaviour () const |
void | setBehaviour (int behaviour) |
virtual bool | isValid () const |
bool | owns (const KateTextCursor &cursor) const |
bool | includes (const KateTextCursor &cursor) const |
bool | includes (uint lineNum) const |
bool | includesWholeLine (uint lineNum) const |
bool | boundaryAt (const KateTextCursor &cursor) const |
bool | boundaryOn (uint lineNum) const |
Detailed Description
Represents a range of text, from the start() to the end().Also tracks its position and emits useful signals.
Definition at line 168 of file katesupercursor.h.
Member Enumeration Documentation
|
Determine how the range reacts to characters inserted immediately outside the range.
Definition at line 176 of file katesupercursor.h. |
Constructor & Destructor Documentation
|
Constructor.
Takes posession of Definition at line 275 of file katesupercursor.cpp. References KateSuperRange(). Referenced by KateSuperRange(). |
Member Function Documentation
|
Returns the super start cursor.
Definition at line 363 of file katesupercursor.cpp. Referenced by boundaryAt(), boundaryOn(), includes(), includesWholeLine(), and isValid(). |
|
Returns the super end cursor.
Definition at line 373 of file katesupercursor.cpp. Referenced by boundaryAt(), boundaryOn(), includes(), includesWholeLine(), and isValid(). |
|
Returns how this range reacts to characters inserted immediately outside the range.
Definition at line 383 of file katesupercursor.cpp. References DoNotExpand, ExpandLeft, ExpandRight, and KateSuperCursor::moveOnInsert(). |
|
Determine how the range should react to characters inserted immediately outside the range. TODO does this need a custom function to enable determining of the behavior based on the text that is inserted / deleted?
Definition at line 388 of file katesupercursor.cpp. References ExpandLeft, ExpandRight, setBehaviour(), and KateSuperCursor::setMoveOnInsert(). Referenced by setBehaviour(). |
|
Start and end must be valid and start <= end.
Definition at line 394 of file katesupercursor.cpp. References superEnd(), and superStart(). Referenced by boundaryAt(), boundaryOn(), includes(), and includesWholeLine(). |
|
This is for use where the ranges are used in a heirachy, ie. their parents are KateSuperRanges which completely encapsulate them.
Definition at line 399 of file katesupercursor.cpp. References includes(), and owns(). Referenced by owns(). |
|
Returns true if the range includes
Returns false if Definition at line 412 of file katesupercursor.cpp. References includes(), isValid(), superEnd(), and superStart(). Referenced by includes(), and owns(). |
|
Returns true if the range includes
Definition at line 417 of file katesupercursor.cpp. References includes(), isValid(), KateTextCursor::line(), superEnd(), and superStart(). |
|
Returns true if the range totally encompasses
Definition at line 422 of file katesupercursor.cpp. References KateSuperCursor::atEndOfLine(), KateSuperCursor::atStartOfLine(), includesWholeLine(), isValid(), KateTextCursor::line(), superEnd(), and superStart(). Referenced by includesWholeLine(). |
|
Returns whether
Definition at line 427 of file katesupercursor.cpp. References boundaryAt(), isValid(), superEnd(), and superStart(). Referenced by boundaryAt(). |
|
Returns whether there is a boundary of this range on
Definition at line 432 of file katesupercursor.cpp. References boundaryOn(), isValid(), KateTextCursor::line(), superEnd(), and superStart(). Referenced by boundaryOn(). |
|
The range's position changed.
|
|
The range's position was unchanged.
|
|
The contents of the range changed.
|
|
Either cursor's surrounding characters were both deleted.
|
|
The range now contains no characters (ie. the start and end cursors are the same). To eliminate this range under different conditions, connect the other signal directly to this signal. |
|
Indicates the region needs re-drawing.
|
The documentation for this class was generated from the following files: