KTextEditor
annotationinterface.h
Go to the documentation of this file.
62 };
250 virtual void annotationContextMenuAboutToShow( KTextEditor::View* view, QMenu* menu, int line ) = 0;
275Q_DECLARE_INTERFACE(KTextEditor::AnnotationViewInterface, "org.kde.KTextEditor.AnnotationViewInterface")
A Document extension interface for handling Annotations.
Definition: annotationinterface.h:158
virtual AnnotationModel * annotationModel() const =0
returns the currently set AnnotationModel or 0 if there's none set
virtual void setAnnotationModel(AnnotationModel *model)=0
Sets a new AnnotationModel for this document to provide annotation information for each line.
virtual ~AnnotationInterface()
Definition: annotationinterface.h:160
An model for providing line annotation information.
Definition: annotationinterface.h:54
virtual QVariant data(int line, Qt::ItemDataRole role) const =0
data() is used to retrieve the information needed to present the annotation information from the anno...
virtual ~AnnotationModel()
Definition: annotationinterface.h:58
void reset()
The model should emit the signal reset() when the text of almost all lines changes.
void lineChanged(int line)
The model should emit the signal lineChanged() when a line has to be updated.
Annotation interface for the View.
Definition: annotationinterface.h:218
virtual void annotationActivated(KTextEditor::View *view, int line)=0
This signal is emitted when an entry on the annotation border was activated, for example by clicking ...
virtual void setAnnotationBorderVisible(bool visible)=0
This function can be used to show or hide the annotation border The annotation border is hidden by de...
virtual void annotationContextMenuAboutToShow(KTextEditor::View *view, QMenu *menu, int line)=0
This signal is emitted before a context menu is shown on the annotation border for the given line and...
virtual ~AnnotationViewInterface()
Definition: annotationinterface.h:220
virtual bool isAnnotationBorderVisible() const =0
Checks whether the View's annotation border is visible.
virtual void annotationBorderVisibilityChanged(KTextEditor::View *view, bool visible)=0
This signal is emitted when the annotation border is shown or hidden.
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.