KSyntaxHighlighting Namespace

Syntax highlighting engine for Kate syntax definitions. More...

Header: #include <KSyntaxHighlighting>
CMake: find_package(KF6 REQUIRED COMPONENTS KSyntaxHighlighting)
target_link_libraries(mytarget PRIVATE KF6::KSyntaxHighlighting)

Namespaces

namespace WildcardMatcher

Classes

(since 5.28) class AbstractHighlighter
(since 5.28) class Definition
(since 5.28) class DefinitionDownloader
(since 5.28) class FoldingRegion
(since 5.28) class Format
(since 5.28) class Repository
(since 5.28) class State
(since 5.28) class SyntaxHighlighter
(since 5.28) class Theme

Types

(since 5.50) enum class CommentPosition { StartOfLine, AfterWhitespace }

Detailed Description

In order to access the syntax highlighting Definition files, use the class Repository.

Namespaces

namespace KSyntaxHighlighting::WildcardMatcher

Classes

class AbstractHighlighter

Abstract base class for highlighters. More...

class Definition

class DefinitionDownloader

Helper class to download definition file updates. More...

class FoldingRegion

Represents a begin or end of a folding region. More...

class Format

Describes the format to be used for a specific text fragment. The actual format used for displaying is merged from the format information in the syntax definition file, and a theme. More...

class Repository

Syntax highlighting repository. More...

class State

Opaque handle to the state of the highlighting engine. More...

class SyntaxHighlighter

A QSyntaxHighlighter implementation for use with QTextDocument. This supports partial re-highlighting during editing and tracks syntax-based code folding regions. More...

class Theme

Color theme definition used for highlighting. More...

Type Documentation

[since 5.50] enum class KSyntaxHighlighting::CommentPosition

Defines the insert position when commenting code.

ConstantValue
KSyntaxHighlighting::CommentPosition::StartOfLine0
KSyntaxHighlighting::CommentPosition::AfterWhitespace1

This enum was introduced in 5.50.

See also Definition::singleLineCommentPosition().