KSyntaxHighlighting::Format Class

Member Function Documentation

Format::Format()

Creates an empty/invalid format.

Format::Format(const KSyntaxHighlighting::Format &other)

QColor Format::backgroundColor(const KSyntaxHighlighting::Theme &theme) const

Returns the background color of the combination of this format and the given theme.

bool Format::hasBackgroundColor(const KSyntaxHighlighting::Theme &theme) const

Returns true if the combination of this format and the theme theme change the background color compared to the default format.

[since 5.62] bool Format::hasBackgroundColorOverride() const

Returns true if the syntax definition file sets a value for the background color attribute and, therefore, overrides the theme and the default formatting style. If the return is true, this value is obtained by backgroundColor().

This function was introduced in 5.62.

See also backgroundColor() and hasBackgroundColor().

[since 5.62] bool Format::hasBoldOverride() const

Returns true if the syntax definition file sets a value for the bold text attribute and, therefore, overrides the theme and the default formatting style. If the return is true, this value is obtained by isBold().

This function was introduced in 5.62.

See also isBold().

[since 5.62] bool Format::hasItalicOverride() const

Returns true if the syntax definition file sets a value for the italic text attribute and, therefore, overrides the theme and the default formatting style. If the return is true, this value is obtained by isItalic().

This function was introduced in 5.62.

See also isItalic().

[since 5.62] bool Format::hasSelectedBackgroundColorOverride() const

Returns true if the syntax definition file specifies a value for the selected background color attribute. If the return is true, this value is obtained by selectedBackgroundColor().

This function was introduced in 5.62.

See also selectedBackgroundColor().

[since 5.62] bool Format::hasSelectedTextColorOverride() const

Returns true if the syntax definition file specifies a value for the selected text color attribute. If the return is true, this value is obtained by selectedTextColor().

This function was introduced in 5.62.

See also selectedTextColor().

[since 5.62] bool Format::hasStrikeThroughOverride() const

Returns true if the syntax definition file specifies a value for the struck through text attribute. If the return is true, this value is obtained by isStrikeThrough().

This function was introduced in 5.62.

See also isStrikeThrough().

bool Format::hasTextColor(const KSyntaxHighlighting::Theme &theme) const

Returns true if the combination of this format and the theme theme change the foreground color compared to the default format.

[since 5.62] bool Format::hasTextColorOverride() const

Returns true if the syntax definition file sets a value for the foreground text color attribute and, therefore, overrides the theme and the default formatting style. If the return is true, this value is obtained by textColor().

This function was introduced in 5.62.

See also textColor() and hasTextColor().

[since 5.62] bool Format::hasUnderlineOverride() const

Returns true if the syntax definition file sets a value for the underlined text attribute and, therefore, overrides the theme and the default formatting style. If the return is true, this value is obtained by isUnderline().

This function was introduced in 5.62.

See also isUnderline().

int Format::id() const

Returns a unique identifier of this format.

This is useful for efficient storing of formats in a text line. The identifier is unique per Repository instance, but will change when the repository is reloaded (which also invalidatess the corresponding Definition anyway).

bool Format::isBold(const KSyntaxHighlighting::Theme &theme) const

Returns true if the combination of this format and the given theme results in bold text formatting.

bool Format::isDefaultTextStyle(const KSyntaxHighlighting::Theme &theme) const

Returns true if the combination of this format and the theme theme do not change the default text format in any way.

This is useful for output formats where changing formatting implies cost, and thus benefit from optimizing the default case of not having any format applied. If you make use of this, make sure to set the default text style to what the corresponding theme sets for Theme::Normal.

bool Format::isItalic(const KSyntaxHighlighting::Theme &theme) const

Returns true if the combination of this format and the given theme results in italic text formatting.

bool Format::isStrikeThrough(const KSyntaxHighlighting::Theme &theme) const

Returns true if the combination of this format and the given theme results in struck through text.

bool Format::isUnderline(const KSyntaxHighlighting::Theme &theme) const

Returns true if the combination of this format and the given theme results in underlined text.

bool Format::isValid() const

Returns true if this is a valid format, ie. one that was read from a syntax definition file.

QString Format::name() const

The name of this format as used in the syntax definition file.

QColor Format::selectedBackgroundColor(const KSyntaxHighlighting::Theme &theme) const

Returns the background color of selected text of the combination of this format and the given theme.

QColor Format::selectedTextColor(const KSyntaxHighlighting::Theme &theme) const

Returns the foreground color for selected text of the combination of this format and the given theme.

bool Format::spellCheck() const

Returns whether characters with this format should be spell checked.

QColor Format::textColor(const KSyntaxHighlighting::Theme &theme) const

Returns the foreground color of the combination of this format and the given theme.

[since 5.49] KSyntaxHighlighting::Theme::TextStyle Format::textStyle() const

Returns the underlying TextStyle of this Format.

Every Theme::TextStyle is visually defined by a Theme. A Format uses one of the Theme::TextStyle%s and on top allows modifications such as setting a different foreground color etc.

This function was introduced in 5.49.

See also Theme::TextStyle.