KTextEditor
#include <annotationinterface.h>
Public Types | |
enum | { GroupIdentifierRole = Qt::UserRole } |
Signals | |
void | lineChanged (int line) |
void | reset () |
Public Member Functions | |
virtual | ~AnnotationModel () |
virtual QVariant | data (int line, Qt::ItemDataRole role) const =0 |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
const QObjectList & | children () const |
const char * | className () const |
bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const QObject *receiver, const char *method) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
void | dumpObjectInfo () |
void | dumpObjectTree () |
QList< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) const |
QList< T > | findChildren (const QString &name) const |
bool | inherits (const char *className) const |
void | insertChild (QObject *object) |
void | installEventFilter (QObject *filterObj) |
bool | isA (const char *className) const |
bool | isWidgetType () const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () const |
QVariant | property (const char *name) const |
void | removeChild (QObject *object) |
void | removeEventFilter (QObject *obj) |
void | setName (const char *name) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const |
int | startTimer (int interval) |
QThread * | thread () const |
Additional Inherited Members | |
Static Public Member Functions inherited from QObject | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Protected Member Functions inherited from QObject | |
bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const char *signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const char *signal) |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Properties inherited from QObject | |
objectName | |
Detailed Description
An model for providing line annotation information.
Introduction
AnnotationModel is a model-like interface that can be implemented to provide annotation information for each line in a document. It provides means to retrieve several kinds of data for a given line in the document.
Implementing a AnnotationModel
The public interface of this class is loosely based on the QAbstractItemModel interfaces. It only has a single method to override which is the data() method to provide the actual data for a line and role combination.
- Since
- 4.1
Definition at line 53 of file annotationinterface.h.
Member Enumeration Documentation
anonymous enum |
Enumerator | |
---|---|
GroupIdentifierRole |
Definition at line 60 of file annotationinterface.h.
Constructor & Destructor Documentation
|
inlinevirtual |
Definition at line 58 of file annotationinterface.h.
Member Function Documentation
|
pure virtual |
data() is used to retrieve the information needed to present the annotation information from the annotation model.
The provider should return useful information for the line and the data role.
The following roles are supported:
- Qt::DisplayRole - a short display text to be placed in the border
- Qt::TooltipRole - a tooltip information, longer text possible
- Qt::BackgroundRole - a brush to be used to paint the background on the border
- Qt::ForegroundRole - a brush to be used to paint the text on the border
- AnnotationModel::GroupIdentifierRole - a string which identifies a group of items which will be highlighted on mouseover; return the same string for all items in a group (KDevelop uses a VCS revision number, for example)
- Parameters
-
line the line for which the data is to be retrieved role the role to identify which kind of annotation is to be retrieved
- Returns
- a QVariant that contains the data for the given role.
|
signal |
The model should emit the signal lineChanged() when a line has to be updated.
- Note
- Kate Part implementation details: lineChanged() repaints the whole annotation border automatically.
|
signal |
The model should emit the signal reset() when the text of almost all lines changes.
In most cases it is enough to call lineChanged().
- Note
- Kate Part implementation details: Whenever reset() is emitted Kate Part iterates over all lines of the document. Kate Part searches for the longest text to determine the annotation border's width.
- See also
- lineChanged()
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:27:18 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.