KTextEditor::Attribute Class
class KTextEditor::AttributeA class which provides customized text decorations. More...
| Header: | #include <KTextEditor/Attribute> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS TextEditor)target_link_libraries(mytarget PRIVATE KF6::TextEditor) |
| Inherits: | QSharedData and |
Public Types
| enum | ActivationType { ActivateMouseIn, ActivateCaretIn } |
| Ptr |
Public Functions
| Attribute() | |
| Attribute(const QString &name, KSyntaxHighlighting::Theme::TextStyle style) | |
| bool | backgroundFillWhitespace() const |
| void | clear() |
| KSyntaxHighlighting::Theme::TextStyle | defaultStyle() const |
| KTextEditor::Attribute::Ptr | dynamicAttribute(KTextEditor::Attribute::ActivationType type) const |
| bool | fontBold() const |
| bool | hasAnyProperty() const |
| QString | name() const |
| QBrush | outline() const |
| QBrush | selectedBackground() const |
| QBrush | selectedForeground() const |
| void | setBackgroundFillWhitespace(bool fillWhitespace) |
| void | setDefaultStyle(KSyntaxHighlighting::Theme::TextStyle style) |
| void | setDynamicAttribute(KTextEditor::Attribute::ActivationType type, KTextEditor::Attribute::Ptr attribute) |
| void | setFontBold(bool bold = true) |
| void | setName(const QString &name) |
| void | setOutline(const QBrush &brush) |
| void | setSelectedBackground(const QBrush &brush) |
| void | setSelectedForeground(const QBrush &foreground) |
| void | setSkipSpellChecking(bool skipspellchecking) |
| bool | skipSpellChecking() const |
| KTextEditor::Attribute & | operator+=(const KTextEditor::Attribute &a) |
| KTextEditor::Attribute & | operator=(const KTextEditor::Attribute &a) |
Detailed Description
The Attribute class extends QTextCharFormat, the class which Qt uses internally to provide formatting information to characters in a text document.
In addition to its inherited properties, it provides support for:
- several customized text formatting properties
- dynamic highlighting of associated ranges of text
- binding of actions with associated ranges of text (note: not currently implemented)
Implementations are not required to support all properties. In particular, several properties are not supported for dynamic highlighting (notably: font() and fontBold()).
Unfortunately, as QTextFormat's setProperty() is not virtual, changes that are made to this attribute cannot automatically be redrawn. Once you have finished changing properties, you should call changed() to force redrawing of affected ranges of text.
See also MovingInterface.
Member Type Documentation
enum Attribute::ActivationType
Several automatic activation mechanisms exist for associated attributes. Using this you can conveniently have your ranges highlighted when either the mouse or cursor enter the range.
| Constant | Value | Description |
|---|---|---|
KTextEditor::Attribute::ActivateMouseIn | 0 | Activate attribute on mouse in |
KTextEditor::Attribute::ActivateCaretIn | 1 | Activate attribute on caret in |
Attribute::Ptr
Shared data pointer for Attribute
Member Function Documentation
Attribute::Attribute()
Default constructor.
The resulting Attribute has no properties set to begin with.
Attribute::Attribute(const QString &name, KSyntaxHighlighting::Theme::TextStyle style)
Construct attribute with given name & default style properties.
name is the attribute name
style is the attribute default style
bool Attribute::backgroundFillWhitespace() const
Determine whether background color is drawn over whitespace. Defaults to true if not set.
Returns whether the background color should be drawn over whitespace
See also setBackgroundFillWhitespace().
void Attribute::clear()
Clear all set properties.
KSyntaxHighlighting::Theme::TextStyle Attribute::defaultStyle() const
Default style of this attribute
Returns default style
See also setDefaultStyle().
KTextEditor::Attribute::Ptr Attribute::dynamicAttribute(KTextEditor::Attribute::ActivationType type) const
Returns the attribute to use when the event referred to by type occurs.
type the activation type for which to return the Attribute.
See also setDynamicAttribute().
bool Attribute::fontBold() const
Find out if the font weight is set to QFont::Bold.
Returns true if the font weight is exactly QFont::Bold, otherwise false
See also setFontBold() and QTextCharFormat::fontWeight().
bool Attribute::hasAnyProperty() const
Determine if any properties are set.
Returns true if any properties are set, otherwise false
QString Attribute::name() const
Returns the attribute name.
See also setName().
QBrush Attribute::outline() const
Get the brush used to draw an outline around text, if any.
Returns brush to be used to draw an outline, or Qt::NoBrush if no outline is set.
See also setOutline().
QBrush Attribute::selectedBackground() const
Get the brush used to draw the background of selected text, if any.
Returns brush to be used to draw the background of selected text, or Qt::NoBrush if not set
See also setSelectedBackground().
QBrush Attribute::selectedForeground() const
Get the brush used to draw text when it is selected, if any.
Returns brush to be used to draw selected text, or Qt::NoBrush if not set
See also setSelectedForeground().
void Attribute::setBackgroundFillWhitespace(bool fillWhitespace)
Set whether background color is drawn over whitespace. Defaults to true if not set.
Use clearProperty(BackgroundFillWhitespace) to clear.
fillWhitespace specifies whether the background should be drawn over whitespace.
See also backgroundFillWhitespace().
void Attribute::setDefaultStyle(KSyntaxHighlighting::Theme::TextStyle style)
Sets the default text style of this attribute.
style is the new default text style
See also defaultStyle().
void Attribute::setDynamicAttribute(KTextEditor::Attribute::ActivationType type, KTextEditor::Attribute::Ptr attribute)
Sets the attribute to use when the event referred to by type occurs.
Note: Nested dynamic attributes are ignored.
type is the activation type to set the attribute for
attribute is the attribute to assign. As attribute is refcounted, ownership is not an issue.
See also dynamicAttribute().
void Attribute::setFontBold(bool bold = true)
Set the font weight to QFont::Bold. If bold is false, the weight will be set to 0 (normal).
bold specifies whether the font weight should be bold or not.
See also fontBold() and QTextCharFormat::setFontWeight().
void Attribute::setName(const QString &name)
Sets the attribute name
name is the new attribute name
See also name().
void Attribute::setOutline(const QBrush &brush)
Set a brush to be used to draw an outline around text.
Use clearProperty(Outline) to clear.
brush is the brush to be used to draw an outline.
See also outline().
void Attribute::setSelectedBackground(const QBrush &brush)
Set a brush to be used to draw the background of selected text, if any.
Use clearProperty(SelectedBackground) to clear.
brush is the brush to be used to draw the background of selected text
See also selectedBackground().
void Attribute::setSelectedForeground(const QBrush &foreground)
Set a brush to be used to draw selected text.
foreground is the brush to be used to draw selected text.
See also selectedForeground() and clearProperty().
void Attribute::setSkipSpellChecking(bool skipspellchecking)
Set if we should spellchecking be skipped?
skipspellchecking if true then spellchecking should be skipped
See also skipSpellChecking().
bool Attribute::skipSpellChecking() const
Should spellchecking be skipped?
Returns true if spellchecking should be skipped
See also setSkipSpellChecking().
KTextEditor::Attribute &Attribute::operator+=(const KTextEditor::Attribute &a)
Addition assignment operator. Use this to merge another Attribute with this Attribute. Where both attributes have a particular property set, the property in a will be used.
a is the attribute to merge into this attribute.
KTextEditor::Attribute &Attribute::operator=(const KTextEditor::Attribute &a)
Replacement assignment operator. Use this to overwrite this Attribute with another Attribute.
a is the attribute to assign to this attribute.