• Skip to content
  • Skip to link menu
Brand

API Documentation

  1. KDE API Reference
  2. The KDE Frameworks
  3. KTextEditor
  • KDE Home
  • Contact Us

Quick Links

Skip menu "KTextEditor"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • File List
  • Modules
  • Dependencies
  • Related Pages

Class Picker

About

Advanced embeddable text editor

Maintainer
Christoph Cullmann
Supported platforms
FreeBSD, Linux, MacOSX, Windows
Community
IRC: #kde-devel on Freenode
Mailing list: kde-frameworks-devel
Use with CMake
find_package(KF5TextEditor)
target_link_libraries(yourapp KF5::TextEditor)
Use with QMake
QT += KTextEditor 
Clone
git clone git://anongit.kde.org/ktexteditor.git
Browse source
KTextEditor on cgit.kde.org

KTextEditor

  • View on LXR
  • KTextEditor
  • InlineNoteProvider
Signals | Public Member Functions | List of all members
KTextEditor::InlineNoteProvider Class Referenceabstract

#include <inlinenoteprovider.h>

Inheritance diagram for KTextEditor::InlineNoteProvider:
Inheritance graph
[legend]

Signals

void inlineNotesChanged (int line)
 
void inlineNotesReset ()
 

Public Member Functions

 InlineNoteProvider ()
 
virtual ~InlineNoteProvider ()
 
virtual void inlineNoteActivated (const InlineNote &note, Qt::MouseButtons buttons, const QPoint &globalPos)
 
virtual void inlineNoteFocusInEvent (const InlineNote &note, const QPoint &globalPos)
 
virtual void inlineNoteFocusOutEvent (const InlineNote &note)
 
virtual void inlineNoteMouseMoveEvent (const InlineNote &note, const QPoint &globalPos)
 
virtual QVector< int > inlineNotes (int line) const =0
 
virtual QSize inlineNoteSize (const InlineNote &note) const =0
 
virtual void paintInlineNote (const InlineNote &note, QPainter &painter) const =0
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectList & children () const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
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, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
 
bool inherits (const char *className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
void objectNameChanged (const QString &objectName)
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType)
 
QThread * thread () const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

A source of inline notes for a document.

InlineNoteProvider is a object that can be queried for inline notes in the view. It emits signals when the notes change and should be queried again.

See also
InlineNoteInterface
Since
5.50

Definition at line 40 of file inlinenoteprovider.h.

Constructor & Destructor Documentation

InlineNoteProvider::InlineNoteProvider ( )

Default constructor.

Definition at line 283 of file ktexteditor.cpp.

InlineNoteProvider::~InlineNoteProvider ( )
virtual

Virtual destructor to allow inheritance.

Definition at line 287 of file ktexteditor.cpp.

Member Function Documentation

void KTextEditor::InlineNoteProvider::inlineNoteActivated ( const InlineNote &  note,
Qt::MouseButtons  buttons,
const QPoint &  globalPos 
)
virtual

Invoked when a note is activated by the user.

This method is called when a user activates a note, i.e. clicks on it. Coordinates of pos are in note coordinates, i.e. relative to the note's top-left corner (same coordinate system as the painter has in paintInlineNote()).

The default implementation does nothing.

Parameters
notethe note which was activated
buttonsthe button(s) the note was clicked with
globalPosthe point the note was clicked at in global screen coordinates

Definition at line 317 of file ktexteditor.cpp.

void KTextEditor::InlineNoteProvider::inlineNoteFocusInEvent ( const InlineNote &  note,
const QPoint &  globalPos 
)
virtual

Invoked when the mouse cursor moves into the note when it was outside before.

The default implementation does nothing.

Parameters
notethe note which was activated
globalPosthe location of the mouse cursor in global screen coordinates

Definition at line 324 of file ktexteditor.cpp.

void KTextEditor::InlineNoteProvider::inlineNoteFocusOutEvent ( const InlineNote &  note)
virtual

Invoked when the mouse cursor leaves the note.

The default implementation does nothing.

Parameters
notethe note which was deactivated

Definition at line 330 of file ktexteditor.cpp.

void KTextEditor::InlineNoteProvider::inlineNoteMouseMoveEvent ( const InlineNote &  note,
const QPoint &  globalPos 
)
virtual

Invoked when the mouse cursor moves inside the note.

The default implementation does nothing.

Parameters
notethe note which was hovered
globalPosthe location of the mouse cursor in global screen coordinates

Definition at line 335 of file ktexteditor.cpp.

virtual QVector<int> KTextEditor::InlineNoteProvider::inlineNotes ( int  line) const
pure virtual

Get list of inline notes for given line.

Should return a vector of columns on which the notes are located. 0 means the note is located before the first character of the line. 1 means the note is located after the first character, etc. If the returned number is greater than the length of the line, the note will be placed behind the text as if there were additional spaces.

Note
When returning multiple InlineNotes, use InlineNote::index() to map the InlineNote to this QVector's index.
Parameters
lineLine number
Returns
vector of columns where inline notes appear in this line
void KTextEditor::InlineNoteProvider::inlineNotesChanged ( int  line)
signal

The provider should emit the signal inlineNotesChanged() whenever one or more InlineNotes on the line changed.

virtual QSize KTextEditor::InlineNoteProvider::inlineNoteSize ( const InlineNote &  note) const
pure virtual

Width to be reserved for the note in the text.

Typically, a custom width with the current line height can be returned. If the width depends on the font size, note.font() can be used to obtain the font metrics.

Example to reserve a square size for painting:

return QSize(note.lineHeight(), lineHeight());
Note
Do not return heights that are larger than note.lineHeight(), since the painting code clips to the line height anyways.
Parameters
notethe InlineNote for which the size is queried
Returns
the required size of the InlineNote
void KTextEditor::InlineNoteProvider::inlineNotesReset ( )
signal

The provider should emit the signal inlineNotesReset() when almost all inline notes changed.

virtual void KTextEditor::InlineNoteProvider::paintInlineNote ( const InlineNote &  note,
QPainter &  painter 
) const
pure virtual

Paint the note into the line.

The method should use the given painter to render the note into the line. The painter is translated such that coordinates 0x0 mark the top left corner of the note. The method should not paint outside rectangle given by the size previously returned by inlineNoteSize().

The method is given the height of the line, the metrics of current font and the font which it may use during painting.

If wanted, you can use note.underMouse() to e.g. highlight the

Parameters
notenote to paint, containing location and index
painterpainter prepared for rendering the note

The documentation for this class was generated from the following files:
  • inlinenoteprovider.h
  • ktexteditor.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Fri Dec 6 2019 03:42:14 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal