KSyntaxHighlighting::State

KSyntaxHighlighting::State Class Reference

#include <state.h>

Public Member Functions

 State ()
 
 State (const State &other)
 
bool indentationBasedFoldingEnabled () const
 
bool operator!= (const State &other) const
 
Stateoperator= (const State &rhs)
 
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

Definition at line 25 of file state.h.

Constructor & Destructor Documentation

State::State ( )

Creates an initial state, ie.

what should be used for the first line in a document.

Definition at line 75 of file state.cpp.

Member Function Documentation

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.

See also
Definition::indentationBasedFoldingEnabled()

Definition at line 105 of file state.cpp.

bool State::operator!= ( const State other) const

Compares two states for inequality.

This is the opposite of operator==().

Definition at line 100 of file state.cpp.

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.

Definition at line 94 of file state.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Oct 28 2020 23:04:06 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.