Kate
KateSmartManager Class Reference
Manages SmartCursors and SmartRanges. More...
#include <katesmartmanager.h>

Signals | |
void | signalRangeDeleted (KateSmartRange *range) |
Public Member Functions | |
void | clear (bool includingInternal) |
int | currentRevision () const |
void | deleteCursors (bool includingInternal) |
void | deleteRanges (bool includingInternal) |
KateDocument * | doc () const |
KateSmartGroup * | groupForLine (int line) const |
bool | isClearing () const |
KateSmartManager (KateDocument *parent) | |
KateSmartCursor * | newSmartCursor (const KTextEditor::Cursor &position=KTextEditor::Cursor(), KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::MoveOnInsert, bool internal=true) |
KateSmartRange * | newSmartRange (KateSmartCursor *start, KateSmartCursor *end, KTextEditor::SmartRange *parent=0L, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::DoNotExpand, bool internal=true) |
KateSmartRange * | newSmartRange (const KTextEditor::Range &range=KTextEditor::Range(), KTextEditor::SmartRange *parent=0L, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::DoNotExpand, bool internal=true) |
void | rangeDeleted (KateSmartRange *range) |
void | rangeGotParent (KateSmartRange *range) |
void | rangeLostParent (KateSmartRange *range) |
void | releaseRevision (int revision) const |
KTextEditor::Range | translateFromRevision (const KTextEditor::Range &range, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::ExpandLeft|KTextEditor::SmartRange::ExpandRight) const |
KTextEditor::Cursor | translateFromRevision (const KTextEditor::Cursor &cursor, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::StayOnInsert) const |
void | unbindSmartRange (KTextEditor::SmartRange *range) |
void | useRevision (int revision=-1) |
virtual | ~KateSmartManager () |
Detailed Description
Manages SmartCursors and SmartRanges.
- Todo:
- potential performance optimization: use separate sets for internal and non-internal cursors + ranges
- Todo:
- potential performance optimization: bypass unhooking routines when clearing
Definition at line 42 of file katesmartmanager.h.
Constructor & Destructor Documentation
KateSmartManager::KateSmartManager | ( | KateDocument * | parent | ) | [explicit] |
Definition at line 153 of file katesmartmanager.cpp.
KateSmartManager::~KateSmartManager | ( | ) | [virtual] |
Definition at line 164 of file katesmartmanager.cpp.
Member Function Documentation
void KateSmartManager::clear | ( | bool | includingInternal | ) |
Definition at line 686 of file katesmartmanager.cpp.
int KateSmartManager::currentRevision | ( | ) | const |
Definition at line 716 of file katesmartmanager.cpp.
void KateSmartManager::deleteCursors | ( | bool | includingInternal | ) |
Definition at line 638 of file katesmartmanager.cpp.
void KateSmartManager::deleteRanges | ( | bool | includingInternal | ) |
Definition at line 670 of file katesmartmanager.cpp.
KateDocument * KateSmartManager::doc | ( | ) | const |
Definition at line 178 of file katesmartmanager.cpp.
KateSmartGroup * KateSmartManager::groupForLine | ( | int | line | ) | const |
Definition at line 287 of file katesmartmanager.cpp.
bool KateSmartManager::isClearing | ( | ) | const [inline] |
The process of clearing works as follows:
- SmartCursors and SmartRanges emit the relevant signals as usual
- The smart manager takes care of deleting the ranges and the cursors which are not bound to ranges (those cursors get deleted by the ranges themselves)
- isClearing() is set to true while cursors only are being deleted (not cursors as part of a range)
- The smart manager takes care of cleaning its internal lists of cursors it deletes (deleted SmartCursors should not tell the smart manager that they have been deleted, ie when isClearing() is true).
Definition at line 63 of file katesmartmanager.h.
KateSmartCursor* KateSmartManager::newSmartCursor | ( | const KTextEditor::Cursor & | position = KTextEditor::Cursor() , |
|
KTextEditor::SmartCursor::InsertBehavior | insertBehavior = KTextEditor::SmartCursor::MoveOnInsert , |
|||
bool | internal = true | |||
) |
KateSmartRange* KateSmartManager::newSmartRange | ( | KateSmartCursor * | start, | |
KateSmartCursor * | end, | |||
KTextEditor::SmartRange * | parent = 0L , |
|||
KTextEditor::SmartRange::InsertBehaviors | insertBehavior = KTextEditor::SmartRange::DoNotExpand , |
|||
bool | internal = true | |||
) |
KateSmartRange* KateSmartManager::newSmartRange | ( | const KTextEditor::Range & | range = KTextEditor::Range() , |
|
KTextEditor::SmartRange * | parent = 0L , |
|||
KTextEditor::SmartRange::InsertBehaviors | insertBehavior = KTextEditor::SmartRange::DoNotExpand , |
|||
bool | internal = true | |||
) |
void KateSmartManager::rangeDeleted | ( | KateSmartRange * | range | ) |
This is called regardless of whether a range was deleted via clear(), or deleteRanges(), or otherwise.
Definition at line 625 of file katesmartmanager.cpp.
void KateSmartManager::rangeGotParent | ( | KateSmartRange * | range | ) |
Definition at line 613 of file katesmartmanager.cpp.
void KateSmartManager::rangeLostParent | ( | KateSmartRange * | range | ) |
Definition at line 619 of file katesmartmanager.cpp.
void KateSmartManager::releaseRevision | ( | int | revision | ) | const |
Definition at line 711 of file katesmartmanager.cpp.
void KateSmartManager::signalRangeDeleted | ( | KateSmartRange * | range | ) | [signal] |
KTextEditor::Range KateSmartManager::translateFromRevision | ( | const KTextEditor::Range & | range, | |
KTextEditor::SmartRange::InsertBehaviors | insertBehavior = KTextEditor::SmartRange::ExpandLeft|KTextEditor::SmartRange::ExpandRight | |||
) | const |
KTextEditor::Cursor KateSmartManager::translateFromRevision | ( | const KTextEditor::Cursor & | cursor, | |
KTextEditor::SmartCursor::InsertBehavior | insertBehavior = KTextEditor::SmartCursor::StayOnInsert | |||
) | const |
void KateSmartManager::unbindSmartRange | ( | KTextEditor::SmartRange * | range | ) |
void KateSmartManager::useRevision | ( | int | revision = -1 |
) |
Definition at line 695 of file katesmartmanager.cpp.
The documentation for this class was generated from the following files: