KSyntaxHighlighting::State
#include <state.h>
Public Member Functions | |
State () | |
State (const State &other) noexcept | |
State (State &&other) noexcept | |
bool | indentationBasedFoldingEnabled () const |
bool | operator!= (const State &other) const |
State & | operator= (const State &rhs) noexcept |
State & | operator= (State &&rhs) noexcept |
bool | operator== (const State &other) const |
Detailed Description
Opaque handle to the state of the highlighting engine.
This needs to be fed into AbstractHighlighter for every line of text and allows concrete highlighter implementations to store state per line for fast re-highlighting of specific lines (e.g. during editing).
- Since
- 5.28
Constructor & Destructor Documentation
◆ State()
|
default |
Creates an initial state, ie.
what should be used for the first line in a document.
Member Function Documentation
◆ indentationBasedFoldingEnabled()
bool State::indentationBasedFoldingEnabled | ( | ) | const |
Returns whether or not indentation-based folding is enabled in this state.
When using a Definition with indentation-based folding, use this method to check if indentation-based folding has been suspended in the current line.
◆ operator!=()
bool State::operator!= | ( | const State & | other | ) | const |
Compares two states for inequality.
This is the opposite of operator==().
◆ operator==()
bool State::operator== | ( | const State & | other | ) | const |
Compares two states for equality.
For two equal states and identical text input, AbstractHighlighter guarantees to produce equal results. This can be used to only re-highlight as many lines as necessary during editing.
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.