KTextEditor
#include <annotationinterface.h>
Public Member Functions | |
virtual | ~AnnotationViewInterface () |
virtual void | annotationActivated (KTextEditor::View *view, int line)=0 |
virtual void | annotationBorderVisibilityChanged (KTextEditor::View *view, bool visible)=0 |
virtual void | annotationContextMenuAboutToShow (KTextEditor::View *view, QMenu *menu, int line)=0 |
virtual bool | isAnnotationBorderVisible () const =0 |
virtual void | setAnnotationBorderVisible (bool visible)=0 |
Public Member Functions inherited from KTextEditor::AnnotationInterface | |
virtual | ~AnnotationInterface () |
virtual AnnotationModel * | annotationModel () const =0 |
virtual void | setAnnotationModel (AnnotationModel *model)=0 |
Detailed Description
Annotation interface for the View.
Introduction
The AnnotationViewInterface allows to do two things:
- (1) show/hide the annotation border along with the possibility to add actions into its context menu.
- (2) set a separate AnnotationModel for the View: Not that this interface inherits the AnnotationInterface.
For a more detailed explanation about whether you want an AnnotationModel in the Document or the View, read the detailed documentation about the AnnotationInterface.
Accessing the AnnotationViewInterface
The AnnotationViewInterface is an extension interface for a View, i.e. the View inherits the interface provided that the used KTextEditor library implements the interface. Use qobject_cast to access the interface:
- Since
- 4.1
Definition at line 210 of file annotationinterface.h.
Constructor & Destructor Documentation
|
inlinevirtual |
Definition at line 213 of file annotationinterface.h.
Member Function Documentation
|
pure virtual |
This signal is emitted when an entry on the annotation border was activated, for example by clicking or double-clicking it.
This follows the KDE wide setting for activation via click or double-clcik
- Parameters
-
view the view to which the activated border belongs to line the document line that the activated posistion belongs to
|
pure virtual |
This signal is emitted when the annotation border is shown or hidden.
- Parameters
-
view the view to which the border belongs to visible the current visibility state
|
pure virtual |
This signal is emitted before a context menu is shown on the annotation border for the given line and view.
- Note
- Kate Part implementation detail: In Kate Part, the menu has an entry to hide the annotation border.
- Parameters
-
view the view that the annotation border belongs to menu the context menu that will be shown line the annotated line for which the context menu is shown
|
pure virtual |
Checks whether the View's annotation border is visible.
|
pure virtual |
This function can be used to show or hide the annotation border The annotation border is hidden by default.
- Parameters
-
visible if true the annotation border is shown, otherwise hidden
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:52:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.