KSyntaxHighlighting::SyntaxHighlighter

Search for usage in LXR

KSyntaxHighlighting::SyntaxHighlighter Class Reference

#include <syntaxhighlighter.h>

Inheritance diagram for KSyntaxHighlighting::SyntaxHighlighter:

Public Member Functions

 SyntaxHighlighter (QObject *parent=nullptr)
 
 SyntaxHighlighter (QTextDocument *document)
 
QTextBlock findFoldingRegionEnd (const QTextBlock &startBlock) const
 
void setDefinition (const Definition &def) override
 
bool startsFoldingRegion (const QTextBlock &startBlock) const
 
- Public Member Functions inherited from QSyntaxHighlighter
 QSyntaxHighlighter (QObject *parent)
 
 QSyntaxHighlighter (QTextDocument *parent)
 
QTextDocumentdocument () const const
 
void rehighlight ()
 
void rehighlightBlock (const QTextBlock &block)
 
void setDocument (QTextDocument *doc)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from KSyntaxHighlighting::AbstractHighlighter
Definition definition () const
 
virtual void setTheme (const Theme &theme)
 
Theme theme () const
 

Protected Member Functions

void applyFolding (int offset, int length, FoldingRegion region) override
 
void applyFormat (int offset, int length, const Format &format) override
 
void highlightBlock (const QString &text) override
 
- Protected Member Functions inherited from QSyntaxHighlighter
QTextBlock currentBlock () const const
 
int currentBlockState () const const
 
QTextBlockUserDatacurrentBlockUserData () const const
 
QTextCharFormat format (int position) const const
 
int previousBlockState () const const
 
void setCurrentBlockState (int newState)
 
void setCurrentBlockUserData (QTextBlockUserData *data)
 
void setFormat (int start, int count, const QFont &font)
 
void setFormat (int start, int count, const QTextCharFormat &format)
 
void setFormat (int start, int count, const QColor &color)
 
- 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 const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from KSyntaxHighlighting::AbstractHighlighter
 AbstractHighlighter (AbstractHighlighterPrivate *dd)
 
State highlightLine (const QString &text, const State &state)
 

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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Attributes inherited from KSyntaxHighlighting::AbstractHighlighter
AbstractHighlighterPrivate * d_ptr
 

Detailed Description

A QSyntaxHighlighter implementation for use with QTextDocument.

This supports partial re-highlighting during editing and tracks syntax-based code folding regions.

Since
5.28

Definition at line 26 of file syntaxhighlighter.h.

Member Function Documentation

void SyntaxHighlighter::applyFolding ( int  offset,
int  length,
FoldingRegion  region 
)
overrideprotectedvirtual

Reimplement this to apply folding to your output.

The provided FoldingRegion region either stars or ends a code folding region in the interval [offset, offset + length).

Parameters
offsetThe start column of the FoldingRegion
lengthThe length of the matching text that starts / ends a folding region
regionThe FoldingRegion that applies to the range [offset, offset + length)
Note
The FoldingRegion region is always either of type FoldingRegion::Type::Begin or FoldingRegion::Type::End.
See also
applyFormat(), highlightLine(), FoldingRegion

Reimplemented from KSyntaxHighlighting::AbstractHighlighter.

Definition at line 162 of file syntaxhighlighter.cpp.

void SyntaxHighlighter::applyFormat ( int  offset,
int  length,
const Format format 
)
overrideprotectedvirtual

Reimplement this to apply formats to your output.

The provided format is valid for the interval [offset, offset + length).

Parameters
offsetThe start column of the interval for which format matches
lengthThe length of the matching text
formatThe Format that applies to the range [offset, offset + length)
Note
Make sure to set a valid Definition, otherwise the parameter format is invalid for the entire line passed to highlightLine() (cf. Format::isValid()).
See also
applyFolding(), highlightLine()

Implements KSyntaxHighlighting::AbstractHighlighter.

Definition at line 139 of file syntaxhighlighter.cpp.

QTextBlock SyntaxHighlighter::findFoldingRegionEnd ( const QTextBlock startBlock) const

Finds the end of the folding region starting at startBlock.

If multiple folding regions begin at startBlock, the end of the last/innermost one is returned. This returns an invalid block if no folding region end is found, which typically indicates an unterminated region and thus folding until the document end. This method performs a sequential search starting at startBlock for the matching folding region end, which is a potentially expensive operation.

See also
startsFoldingRegion

Definition at line 80 of file syntaxhighlighter.cpp.

void SyntaxHighlighter::setDefinition ( const Definition def)
overridevirtual

Sets the syntax definition used for highlighting.

Subclasses can re-implement this method to e.g. trigger re-highlighting or clear internal data structures if needed.

Reimplemented from KSyntaxHighlighting::AbstractHighlighter.

Definition at line 67 of file syntaxhighlighter.cpp.

bool SyntaxHighlighter::startsFoldingRegion ( const QTextBlock startBlock) const

Returns whether there is a folding region beginning at startBlock.

This only considers syntax-based folding regions, not indention-based ones as e.g. found in Python.

See also
findFoldingRegionEnd

Definition at line 75 of file syntaxhighlighter.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue May 11 2021 22:58:44 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.