KTextEditor
markinterface.h
Go to the documentation of this file.
virtual void clearMarks()=0
Clear all marks in the entire document.
void markToolTipRequested(KTextEditor::Document *document, KTextEditor::Mark mark, QPoint position, bool &handled)
The document emits this signal whenever the mark is hovered using the mouse, and the receiver may sho...
virtual void removeMark(int line, uint markType)=0
Remove the mark mask of type markType from line.
void markClicked(KTextEditor::Document *document, KTextEditor::Mark mark, bool &handled)
The document emits this signal whenever the mark is left-clicked.
virtual const QHash< int, KTextEditor::Mark * > & marks()=0
Get a hash holding all marks in the document.
virtual void addMark(int line, uint markType)=0
Add marks of type markType to line.
virtual void setMark(int line, uint markType)=0
Set the line's mark types to markType.
virtual void setMarkPixmap(MarkTypes mark, const QPixmap &pixmap)=0
Set the mark's pixmap to pixmap.
virtual void setEditableMarks(uint markMask)=0
Set the mark mask the user is allowed to toggle to markMask.
void markContextMenuRequested(KTextEditor::Document *document, KTextEditor::Mark mark, QPoint pos, bool &handled)
The document emits this signal whenever the mark is right-clicked to show a context menu.
virtual QPixmap markPixmap(MarkTypes mark) const =0
Get the mark's pixmap.
virtual void marksChanged(KTextEditor::Document *document)=0
The document emits this signal whenever a mark mask changed.
virtual QString markDescription(MarkTypes mark) const =0
Get the mark's description to text.
virtual uint editableMarks() const =0
Get, which marks can be toggled by the user.
virtual void setMarkDescription(MarkTypes mark, const QString &text)=0
Set the mark's description to text.
virtual void markChanged(KTextEditor::Document *document, KTextEditor::Mark mark, KTextEditor::MarkInterface::MarkChangeAction action)=0
The document emits this signal whenever the mark changes.
virtual void clearMark(int line)=0
Clear all marks set in the line.
static int reservedMarkersCount()
Get the number of predefined mark types we have so far.
Definition markinterface.h:201
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Tue Mar 25 2025 00:00:00 by doxygen 1.14.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2025 The KDE developers.
Generated on Tue Mar 25 2025 00:00:00 by doxygen 1.14.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.