KTextEditor
smartinterface.h
Go to the documentation of this file.
197 virtual KTextEditor::Cursor translateFromRevision(const KTextEditor::Cursor& cursor, KTextEditor::SmartCursor::InsertBehavior insertBehavior = KTextEditor::SmartCursor::StayOnInsert) const;
205 virtual KTextEditor::Range translateFromRevision(const KTextEditor::Range& range, KTextEditor::SmartRange::InsertBehaviors insertBehavior = KTextEditor::SmartRange::ExpandLeft | KTextEditor::SmartRange::ExpandRight) const;
224 virtual SmartCursor* newSmartCursor(const Cursor& position = Cursor::start(), SmartCursor::InsertBehavior insertBehavior = SmartCursor::MoveOnInsert) = 0;
239 SmartCursor* newSmartCursor(int line, int column, SmartCursor::InsertBehavior insertBehavior = SmartCursor::MoveOnInsert);
292 SmartRange* newSmartRange(int startLine, int startColumn, int endLine, int endColumn, SmartRange* parent = 0L, SmartRange::InsertBehaviors insertBehavior = SmartRange::DoNotExpand);
302 virtual SmartRange* newSmartRange(SmartCursor* start, SmartCursor* end, SmartRange* parent = 0L, SmartRange::InsertBehaviors insertBehavior = SmartRange::DoNotExpand) = 0;
375 virtual void addHighlightToView(View* view, SmartRange* topRange, bool supportDynamic = false) = 0;
An object representing a section of text, from one Cursor to another.
Definition: range.h:55
A Cursor which is bound to a specific Document, and maintains its position.
Definition: smartcursor.h:66
A Document extension interface for handling SmartCursors and SmartRanges.
Definition: smartinterface.h:119
virtual void addActionsToDocument(SmartRange *topRange)=0
virtual void unbindSmartRange(SmartRange *range)=0
Delete a SmartRange without deleting the SmartCursors which make up its start() and end().
virtual SmartRange * newSmartRange(const Range &range=Range(), SmartRange *parent=0L, SmartRange::InsertBehaviors insertBehavior=SmartRange::DoNotExpand)=0
Creates a new SmartRange.
virtual void clearViewActions(View *view)=0
virtual SmartCursor * newSmartCursor(const Cursor &position=Cursor::start(), SmartCursor::InsertBehavior insertBehavior=SmartCursor::MoveOnInsert)=0
Creates a new SmartCursor.
virtual const QList< SmartRange * > viewHighlights(View *view) const =0
Return a list of SmartRanges which are currently registered as providing arbitrary highlighting infor...
virtual void clearSmartInterface()=0
Clears or deletes all instances of smart objects, ie:
virtual void deleteCursors()=0
Delete all SmartCursors from this document, with the exception of those cursors currently bound to ra...
virtual const QList< SmartRange * > viewActions(View *view) const =0
virtual const QList< SmartRange * > documentHighlights() const =0
Return a list of SmartRanges which are currently registered as providing arbitrary highlighting infor...
virtual void removeHighlightFromDocument(SmartRange *topRange)=0
Remove a SmartRange tree from providing arbitrary highlighting information to all of the views of a d...
virtual const QList< SmartRange * > documentActions() const =0
virtual void useRevision(int revision)=0
Tell the smart interface to work against the given revision when creating cursors and ranges.
virtual void addActionsToView(View *view, SmartRange *topRange)=0
virtual SmartRange * newSmartRange(SmartCursor *start, SmartCursor *end, SmartRange *parent=0L, SmartRange::InsertBehaviors insertBehavior=SmartRange::DoNotExpand)=0
Creates a new SmartRange from pre-existing SmartCursors.
virtual void attributeDynamic(Attribute::Ptr a)=0
virtual void releaseRevision(int revision) const =0
Release a revision token provided by currentRevision().
virtual KTextEditor::Range translateFromRevision(const KTextEditor::Range &range, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::ExpandLeft|KTextEditor::SmartRange::ExpandRight) const
Translate the given range against the revision specified through useRevision(), using the given inser...
virtual void removeActionsFromView(View *view, SmartRange *topRange)=0
virtual void attributeNotDynamic(Attribute::Ptr a)=0
virtual void addHighlightToDocument(SmartRange *topRange, bool supportDynamic=false)=0
Register a SmartRange tree as providing arbitrary highlighting information, and that it should be ren...
virtual void deleteRanges()=0
Delete all SmartRanges from this document.
virtual void clearViewHighlights(View *view)=0
Clear the highlight ranges from a View.
virtual void removeHighlightFromView(View *view, SmartRange *topRange)=0
Remove a SmartRange tree from providing arbitrary highlighting information to a specific view of a do...
virtual void removeActionsFromDocument(SmartRange *topRange)=0
virtual void clearDocumentActions()=0
virtual void addHighlightToView(View *view, SmartRange *topRange, bool supportDynamic=false)=0
Register a SmartRange tree as providing arbitrary highlighting information, and that it should be ren...
virtual int currentRevision() const =0
Retrieve a token representing the current version of the document.
virtual void clearDocumentHighlights()=0
Clear the highlight ranges from a Document.
A Range which is bound to a specific Document, and maintains its position.
Definition: smartrange.h:95
@ ExpandRight
Expand to encapsulate new characters to the right of the range.
Definition: smartrange.h:106
@ ExpandLeft
Expand to encapsulate new characters to the left of the range.
Definition: smartrange.h:104
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.