KSyntaxHighlighting::SyntaxHighlighter
#include <syntaxhighlighter.h>
Public Member Functions | |
SyntaxHighlighter (QObject *parent=nullptr) | |
SyntaxHighlighter (QTextDocument *document) | |
QTextBlock | findFoldingRegionEnd (const QTextBlock &startBlock) const |
void | setDefinition (const Definition &def) override |
void | setTheme (const Theme &theme) override |
bool | startsFoldingRegion (const QTextBlock &startBlock) const |
Public Member Functions inherited from QSyntaxHighlighter | |
QSyntaxHighlighter (QObject *parent) | |
QSyntaxHighlighter (QTextDocument *parent) | |
QTextDocument * | document () const const |
void | rehighlight () |
void | rehighlightBlock (const QTextBlock &block) |
void | setDocument (QTextDocument *doc) |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () 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 () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
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 | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Public Member Functions inherited from KSyntaxHighlighting::AbstractHighlighter | |
Definition | definition () const |
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 |
QTextBlockUserData * | currentBlockUserData () 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 QColor &color) |
void | setFormat (int start, int count, const QFont &font) |
void | setFormat (int start, int count, const QTextCharFormat &format) |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Protected Member Functions inherited from KSyntaxHighlighting::AbstractHighlighter | |
KSYNTAXHIGHLIGHTING_NO_EXPORT | AbstractHighlighter (AbstractHighlighterPrivate *dd) |
State | highlightLine (QStringView text, const State &state) |
Additional Inherited Members | |
Public Types inherited from QObject | |
typedef | QObjectList |
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 *context, Functor functor, 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) |
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
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.
Constructor & Destructor Documentation
◆ SyntaxHighlighter() [1/2]
|
explicit |
Definition at line 112 of file syntaxhighlighter.cpp.
◆ SyntaxHighlighter() [2/2]
|
explicit |
Definition at line 119 of file syntaxhighlighter.cpp.
◆ ~SyntaxHighlighter()
|
override |
Definition at line 126 of file syntaxhighlighter.cpp.
Member Function Documentation
◆ applyFolding()
|
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
-
offset The start column of the FoldingRegion length The length of the matching text that starts / ends a folding region region The 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 249 of file syntaxhighlighter.cpp.
◆ applyFormat()
|
overrideprotectedvirtual |
Reimplement this to apply formats to your output.
The provided format
is valid for the interval [offset
, offset
+ length
).
- Parameters
-
offset The start column of the interval for which format
matcheslength The length of the matching text format The 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 225 of file syntaxhighlighter.cpp.
◆ findFoldingRegionEnd()
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 158 of file syntaxhighlighter.cpp.
◆ highlightBlock()
|
overrideprotectedvirtual |
Implements QSyntaxHighlighter.
Definition at line 188 of file syntaxhighlighter.cpp.
◆ setDefinition()
|
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 130 of file syntaxhighlighter.cpp.
◆ setTheme()
|
overridevirtual |
Sets the theme used for highlighting.
Subclasses can re-implement this method to e.g. trigger re-highlighing or to do general palette color setup.
Reimplemented from KSyntaxHighlighting::AbstractHighlighter.
Definition at line 144 of file syntaxhighlighter.cpp.
◆ startsFoldingRegion()
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 153 of file syntaxhighlighter.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:03:33 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.