KSyntaxHighlighting::Definition Class

Member Function Documentation

Definition::Definition()

Default constructor, creating an empty (invalid) Definition instance. isValid() for this instance returns false.

Use the Repository instead to obtain valid instances.

Definition::Definition(const KSyntaxHighlighting::Definition &other)

Copy constructor.

Both this definition as well as other share the Definition data.

[noexcept, since 5.86] Definition::Definition(KSyntaxHighlighting::Definition &&other)

Move constructor. This definition takes the Definition data from other.

This function was introduced in 5.86.

[since 6.1] QStringList Definition::alternativeNames() const

Alternate names the syntax can be referred to by.

This function was introduced in 6.1.

QString Definition::author() const

Name and email of the author of this syntax definition.

[since 5.50] QList<QPair<QChar, QString>> Definition::characterEncodings() const

Returns a list of character/string mapping that can be used for spell checking. This is useful for instance when spell checking LaTeX, where the string "{A} represents the character Ä.

This function was introduced in 5.50.

QList<QString> Definition::extensions() const

File extensions associated with this syntax definition. The returned list contains wildcards.

QString Definition::filePath() const

Returns the full path to the definition XML file containing the syntax definition. Note that this can be a path to QRC content.

[since 5.50] bool Definition::foldingEnabled() const

Returns whether the highlighting supports code folding. Code folding is supported either if the highlighting defines code folding regions or if indentationBasedFoldingEnabled() returns true.

This function was introduced in 5.50.

See also indentationBasedFoldingEnabled().

QStringList Definition::foldingIgnoreList() const

If indentationBasedFoldingEnabled() returns true, this function returns a list of regular expressions that represent empty lines. That is, all lines matching entirely one of the regular expressions should be treated as empty lines when calculating the indentation-based folding ranges.

See also indentationBasedFoldingEnabled().

[since 5.49] QList<KSyntaxHighlighting::Format> Definition::formats() const

Returns a list of all Format items used by this definition. The order of the Format items equals the order of the itemDatas in the xml file.

This function was introduced in 5.49.

[since 5.49] QList<KSyntaxHighlighting::Definition> Definition::includedDefinitions() const

Returns a list of Definitions that are referenced with the IncludeRules rule. The returned list does not include this Definition. In case no other Definitions are referenced via IncludeRules, the returned list is empty.

This function was introduced in 5.49.

bool Definition::indentationBasedFoldingEnabled() const

Returns whether indentation-based folding is enabled. An example for indentation-based folding is Python. When indentation-based folding is enabled, make sure to also check foldingIgnoreList() for lines that should be treated as empty.

See also foldingIgnoreList() and State::indentationBasedFoldingEnabled().

QString Definition::indenter() const

Indentation style to be used for this syntax.

bool Definition::isHidden() const

Returns true if this is an internal definition that should not be displayed to the user.

bool Definition::isValid() const

Checks whether this object refers to a valid syntax definition.

[since 5.50] bool Definition::isWordDelimiter(QChar c) const

Returns whether the character c is a word delimiter. A delimiter defines whether a characters is a word boundary. Internally, delimiters are used for matching keyword lists. As example, typically the dot '.' is a word delimiter. However, if you have a keyword in a keyword list that contains a dot, you have to add the dot to the weakDeliminator attribute of the general section in your highlighting definition. Similarly, sometimes additional delimiters are required, which can be specified in additionalDeliminator.

Checking whether a character is a delimiter is useful for instance if text is selected with double click. Typically, the whole word should be selected in this case. Similarly to the example above, the dot '.' usually acts as word delimiter. However, using this function you can implement text selection in such a way that keyword lists are correctly selected.

This function was introduced in 5.50.

See also isWordWrapDelimiter().

[since 5.50] bool Definition::isWordWrapDelimiter(QChar c) const

Returns whether it is safe to break a line at before the character . This is useful when wrapping a line e.g. by applying static word wrap.

As example, consider the LaTeX code

\command1\command2

Applying static word wrap could lead to the following code:

\command1\
command2

command2 without a leading backslash is invalid in LaTeX. If '\' is set as word wrap delimiter, isWordWrapDelimiter('\') then returns true, meaning that it is safe to break the line before . The resulting code then would be

\command1
\command2

This function was introduced in 5.50.

See also isWordDelimiter().

[since 5.49] QStringList Definition::keywordList(const QString &name) const

Returns the list of keywords for the keyword list name.

This function was introduced in 5.49.

See also keywordLists() and setKeywordList().

[since 5.49] QStringList Definition::keywordLists() const

Returns the section names of keywords.

This function was introduced in 5.49.

See also keywordList().

QString Definition::license() const

License of this syntax definition.

QList<QString> Definition::mimeTypes() const

Mime types associated with this syntax definition.

[since 5.50] QPair<QString, QString> Definition::multiLineCommentMarker() const

Returns the markers that start and end multiline comments. For instance, in XML this is defined as "<!–" and "–>".

This function was introduced in 5.50.

QString Definition::name() const

Name of the syntax. Used for internal references, prefer translatedName() for display.

int Definition::priority() const

Returns the definition priority. A Definition with higher priority wins over Definitions with lower priorities.

QString Definition::section() const

The group this syntax definition belongs to. For display, consider translatedSection().

[since 5.62] bool Definition::setKeywordList(const QString &name, const QStringList &content)

Set the contents of the keyword list name to content. Only existing keywordLists() can be changed. For non-existent keyword lists, false is returned.

Whenever you change a keyword list, make sure to trigger a rehighlight of your documents. In case you are using QSyntaxHighlighter via SyntaxHighlighter, this can be done by calling SyntaxHighlighter::rehighlight().

This function was introduced in 5.62.

See also keywordList() and keywordLists().

[since 5.50] QString Definition::singleLineCommentMarker() const

Returns the marker that starts a single line comment. For instance, in C++ the single line comment marker is "//".

This function was introduced in 5.50.

See also singleLineCommentPosition() and ;.

[since 5.50] KSyntaxHighlighting::CommentPosition Definition::singleLineCommentPosition() const

Returns the insert position of the comment marker for sinle line comments.

This function was introduced in 5.50.

See also singleLineCommentMarker() and ;.

QString Definition::style() const

Generalized language style, used for indentation.

QString Definition::translatedName() const

Translated name for display.

QString Definition::translatedSection() const

Translated group name for display.

int Definition::version() const

Returns the definition version.

bool Definition::operator!=(const KSyntaxHighlighting::Definition &other) const

Checks two definitions for inequality.

[noexcept, since 5.86] KSyntaxHighlighting::Definition &Definition::operator=(KSyntaxHighlighting::Definition &&other)

Move assignment operator.

This definition takes the Definition data from other.

This function was introduced in 5.86.

KSyntaxHighlighting::Definition &Definition::operator=(const KSyntaxHighlighting::Definition &rhs)

Copy assignment operator.

Both this definition as well as rhs share the Definition data.

bool Definition::operator==(const KSyntaxHighlighting::Definition &other) const

Checks two definitions for equality.