Struct qt_gui::QTextCharFormat

#[repr(C)]
pub struct QTextCharFormat { /* fields omitted */ }

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

C++ class: QTextCharFormat.

C++ documentation:

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

The character format of text in a document specifies the visual properties of the text, as well as information about its role in a hypertext document.

The font used can be set by supplying a font to the setFont() function, and each aspect of its appearance can be adjusted to give the desired effect. setFontFamily() and setFontPointSize() define the font's family (e.g. Times) and printed size; setFontWeight() and setFontItalic() provide control over the style of the font. setFontUnderline(), setFontOverline(), setFontStrikeOut(), and setFontFixedPitch() provide additional effects for text.

The color is set with setForeground(). If the text is intended to be used as an anchor (for hyperlinks), this can be enabled with setAnchor(). The setAnchorHref() and setAnchorNames() functions are used to specify the information about the hyperlink's destination and the anchor's name.

Methods

impl QTextCharFormat

pub unsafe fn anchor_href(&self) -> CppBox<QString>

Returns the text format's hypertext link, or an empty string if none has been set.

Calls C++ function: QString QTextCharFormat::anchorHref() const.

C++ documentation:

Returns the text format's hypertext link, or an empty string if none has been set.

See also setAnchorHref().

pub unsafe fn anchor_name(&self) -> CppBox<QString>

This function is deprecated. Use anchorNames() instead.

Calls C++ function: QString QTextCharFormat::anchorName() const.

C++ documentation:

This function is deprecated. Use anchorNames() instead.

Returns the anchor name associated with this text format, or an empty string if none has been set. If the anchor name is set, text with this format can be the destination of a hypertext link.

See also setAnchorName().

pub unsafe fn anchor_names(&self) -> CppBox<QStringList>

Returns the anchor names associated with this text format, or an empty string list if none has been set. If the anchor names are set, text with this format can be the destination of a hypertext link.

Calls C++ function: QStringList QTextCharFormat::anchorNames() const.

C++ documentation:

Returns the anchor names associated with this text format, or an empty string list if none has been set. If the anchor names are set, text with this format can be the destination of a hypertext link.

This function was introduced in Qt 4.3.

See also setAnchorNames().

pub unsafe fn copy_from(
    &mut self,
    other: impl CastInto<Ref<QTextCharFormat>>
) -> MutRef<QTextCharFormat>

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

Calls C++ function: QTextCharFormat& QTextCharFormat::operator=(const QTextCharFormat& other).

C++ documentation:

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

The character format of text in a document specifies the visual properties of the text, as well as information about its role in a hypertext document.

The font used can be set by supplying a font to the setFont() function, and each aspect of its appearance can be adjusted to give the desired effect. setFontFamily() and setFontPointSize() define the font's family (e.g. Times) and printed size; setFontWeight() and setFontItalic() provide control over the style of the font. setFontUnderline(), setFontOverline(), setFontStrikeOut(), and setFontFixedPitch() provide additional effects for text.

The color is set with setForeground(). If the text is intended to be used as an anchor (for hyperlinks), this can be enabled with setAnchor(). The setAnchorHref() and setAnchorNames() functions are used to specify the information about the hyperlink's destination and the anchor's name.

pub unsafe fn font(&self) -> CppBox<QFont>

Returns the font for this character format.

Calls C++ function: QFont QTextCharFormat::font() const.

C++ documentation:

Returns the font for this character format.

See also setFont().

pub unsafe fn font_capitalization(&self) -> Capitalization

Returns the current capitalization type of the font.

Calls C++ function: QFont::Capitalization QTextCharFormat::fontCapitalization() const.

C++ documentation:

Returns the current capitalization type of the font.

This function was introduced in Qt 4.4.

See also setFontCapitalization().

pub unsafe fn font_families(&self) -> CppBox<QVariant>

Returns the text format's font families.

Calls C++ function: QVariant QTextCharFormat::fontFamilies() const.

C++ documentation:

Returns the text format's font families.

This function was introduced in Qt 5.13.

See also setFontFamilies() and font().

This item is available if cpp_lib_version="5.13.0".

pub unsafe fn font_family(&self) -> CppBox<QString>

Returns the text format's font family.

Calls C++ function: QString QTextCharFormat::fontFamily() const.

C++ documentation:

Returns the text format's font family.

See also setFontFamily() and font().

pub unsafe fn font_fixed_pitch(&self) -> bool

Returns true if the text format's font is fixed pitch; otherwise returns false.

Calls C++ function: bool QTextCharFormat::fontFixedPitch() const.

C++ documentation:

Returns true if the text format's font is fixed pitch; otherwise returns false.

See also setFontFixedPitch() and font().

pub unsafe fn font_hinting_preference(&self) -> HintingPreference

Returns the hinting preference set for this text format.

Calls C++ function: QFont::HintingPreference QTextCharFormat::fontHintingPreference() const.

C++ documentation:

Returns the hinting preference set for this text format.

This function was introduced in Qt 4.8.

See also setFontHintingPreference(), font(), and QFont::hintingPreference().

pub unsafe fn font_italic(&self) -> bool

Returns true if the text format's font is italic; otherwise returns false.

Calls C++ function: bool QTextCharFormat::fontItalic() const.

C++ documentation:

Returns true if the text format's font is italic; otherwise returns false.

See also setFontItalic() and font().

pub unsafe fn font_kerning(&self) -> bool

Returns true if the font kerning is enabled.

Calls C++ function: bool QTextCharFormat::fontKerning() const.

C++ documentation:

Returns true if the font kerning is enabled.

This function was introduced in Qt 4.5.

See also setFontKerning() and font().

pub unsafe fn font_letter_spacing(&self) -> c_double

Returns the current letter spacing.

Calls C++ function: double QTextCharFormat::fontLetterSpacing() const.

C++ documentation:

Returns the current letter spacing.

This function was introduced in Qt 4.4.

See also setFontLetterSpacing(), setFontLetterSpacingType(), and fontLetterSpacingType().

pub unsafe fn font_letter_spacing_type(&self) -> SpacingType

Returns the letter spacing type of this format..

Calls C++ function: QFont::SpacingType QTextCharFormat::fontLetterSpacingType() const.

C++ documentation:

Returns the letter spacing type of this format..

This function was introduced in Qt 5.0.

See also setFontLetterSpacingType(), setFontLetterSpacing(), and fontLetterSpacing().

pub unsafe fn font_overline(&self) -> bool

Returns true if the text format's font is overlined; otherwise returns false.

Calls C++ function: bool QTextCharFormat::fontOverline() const.

C++ documentation:

Returns true if the text format's font is overlined; otherwise returns false.

See also setFontOverline() and font().

pub unsafe fn font_point_size(&self) -> c_double

Returns the font size used to display text in this format.

Calls C++ function: double QTextCharFormat::fontPointSize() const.

C++ documentation:

Returns the font size used to display text in this format.

See also setFontPointSize() and font().

pub unsafe fn font_stretch(&self) -> c_int

Returns the current font stretching.

Calls C++ function: int QTextCharFormat::fontStretch() const.

C++ documentation:

Returns the current font stretching.

This function was introduced in Qt 5.0.

See also setFontStretch().

pub unsafe fn font_strike_out(&self) -> bool

Returns true if the text format's font is struck out (has a horizontal line drawn through it); otherwise returns false.

Calls C++ function: bool QTextCharFormat::fontStrikeOut() const.

C++ documentation:

Returns true if the text format's font is struck out (has a horizontal line drawn through it); otherwise returns false.

See also setFontStrikeOut() and font().

pub unsafe fn font_style_hint(&self) -> StyleHint

Returns the font style hint.

Calls C++ function: QFont::StyleHint QTextCharFormat::fontStyleHint() const.

C++ documentation:

Returns the font style hint.

This function was introduced in Qt 4.5.

See also setFontStyleHint() and font().

pub unsafe fn font_style_name(&self) -> CppBox<QVariant>

Returns the text format's font style name.

Calls C++ function: QVariant QTextCharFormat::fontStyleName() const.

C++ documentation:

Returns the text format's font style name.

This function was introduced in Qt 5.13.

See also setFontStyleName(), font(), and QFont::styleName().

This item is available if cpp_lib_version="5.13.0".

pub unsafe fn font_style_strategy(&self) -> StyleStrategy

Returns the current font style strategy.

Calls C++ function: QFont::StyleStrategy QTextCharFormat::fontStyleStrategy() const.

C++ documentation:

Returns the current font style strategy.

This function was introduced in Qt 4.5.

See also setFontStyleStrategy() and font().

pub unsafe fn font_underline(&self) -> bool

Returns true if the text format's font is underlined; otherwise returns false.

Calls C++ function: bool QTextCharFormat::fontUnderline() const.

C++ documentation:

Returns true if the text format's font is underlined; otherwise returns false.

See also setFontUnderline() and font().

pub unsafe fn font_weight(&self) -> c_int

Returns the text format's font weight.

Calls C++ function: int QTextCharFormat::fontWeight() const.

C++ documentation:

Returns the text format's font weight.

See also setFontWeight(), font(), and QFont::Weight.

pub unsafe fn font_word_spacing(&self) -> c_double

Returns the current word spacing value.

Calls C++ function: double QTextCharFormat::fontWordSpacing() const.

C++ documentation:

Returns the current word spacing value.

This function was introduced in Qt 4.4.

See also setFontWordSpacing().

pub unsafe fn is_anchor(&self) -> bool

Returns true if the text is formatted as an anchor; otherwise returns false.

Calls C++ function: bool QTextCharFormat::isAnchor() const.

C++ documentation:

Returns true if the text is formatted as an anchor; otherwise returns false.

See also setAnchor(), setAnchorHref(), and setAnchorNames().

pub unsafe fn is_valid(&self) -> bool

Returns true if this character format is valid; otherwise returns false.

Calls C++ function: bool QTextCharFormat::isValid() const.

C++ documentation:

Returns true if this character format is valid; otherwise returns false.

pub unsafe fn new() -> CppBox<QTextCharFormat>

Constructs a new character format object.

Calls C++ function: [constructor] void QTextCharFormat::QTextCharFormat().

C++ documentation:

Constructs a new character format object.

pub unsafe fn new_copy(
    other: impl CastInto<Ref<QTextCharFormat>>
) -> CppBox<QTextCharFormat>

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

Calls C++ function: [constructor] void QTextCharFormat::QTextCharFormat(const QTextCharFormat& other).

C++ documentation:

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

The character format of text in a document specifies the visual properties of the text, as well as information about its role in a hypertext document.

The font used can be set by supplying a font to the setFont() function, and each aspect of its appearance can be adjusted to give the desired effect. setFontFamily() and setFontPointSize() define the font's family (e.g. Times) and printed size; setFontWeight() and setFontItalic() provide control over the style of the font. setFontUnderline(), setFontOverline(), setFontStrikeOut(), and setFontFixedPitch() provide additional effects for text.

The color is set with setForeground(). If the text is intended to be used as an anchor (for hyperlinks), this can be enabled with setAnchor(). The setAnchorHref() and setAnchorNames() functions are used to specify the information about the hyperlink's destination and the anchor's name.

pub unsafe fn set_anchor(&mut self, anchor: bool)

If anchor is true, text with this format represents an anchor, and is formatted in the appropriate way; otherwise the text is formatted normally. (Anchors are hyperlinks which are often shown underlined and in a different color from plain text.)

Calls C++ function: void QTextCharFormat::setAnchor(bool anchor).

C++ documentation:

If anchor is true, text with this format represents an anchor, and is formatted in the appropriate way; otherwise the text is formatted normally. (Anchors are hyperlinks which are often shown underlined and in a different color from plain text.)

The way the text is rendered is independent of whether or not the format has a valid anchor defined. Use setAnchorHref(), and optionally setAnchorNames() to create a hypertext link.

See also isAnchor().

pub unsafe fn set_anchor_href(&mut self, value: impl CastInto<Ref<QString>>)

Sets the hypertext link for the text format to the given value. This is typically a URL like "http://example.com/index.html".

Calls C++ function: void QTextCharFormat::setAnchorHref(const QString& value).

C++ documentation:

Sets the hypertext link for the text format to the given value. This is typically a URL like "http://example.com/index.html".

The anchor will be displayed with the value as its display text; if you want to display different text call setAnchorNames().

To format the text as a hypertext link use setAnchor().

See also anchorHref().

pub unsafe fn set_anchor_name(&mut self, name: impl CastInto<Ref<QString>>)

This function is deprecated. Use setAnchorNames() instead.

Calls C++ function: void QTextCharFormat::setAnchorName(const QString& name).

C++ documentation:

This function is deprecated. Use setAnchorNames() instead.

Sets the text format's anchor name. For the anchor to work as a hyperlink, the destination must be set with setAnchorHref() and the anchor must be enabled with setAnchor().

See also anchorName().

pub unsafe fn set_anchor_names(
    &mut self,
    names: impl CastInto<Ref<QStringList>>
)

Sets the text format's anchor names. For the anchor to work as a hyperlink, the destination must be set with setAnchorHref() and the anchor must be enabled with setAnchor().

Calls C++ function: void QTextCharFormat::setAnchorNames(const QStringList& names).

C++ documentation:

Sets the text format's anchor names. For the anchor to work as a hyperlink, the destination must be set with setAnchorHref() and the anchor must be enabled with setAnchor().

This function was introduced in Qt 4.3.

See also anchorNames().

pub unsafe fn set_font_2a(
    &mut self,
    font: impl CastInto<Ref<QFont>>,
    behavior: FontPropertiesInheritanceBehavior
)

Sets the text format's font.

Calls C++ function: void QTextCharFormat::setFont(const QFont& font, QTextCharFormat::FontPropertiesInheritanceBehavior behavior).

C++ documentation:

Sets the text format's font.

If behavior is QTextCharFormat::FontPropertiesAll, the font property that has not been explicitly set is treated like as it were set with default value; If behavior is QTextCharFormat::FontPropertiesSpecifiedOnly, the font property that has not been explicitly set is ignored and the respective property value remains unchanged.

This function was introduced in Qt 5.3.

See also font().

pub unsafe fn set_font_1a(&mut self, font: impl CastInto<Ref<QFont>>)

This is an overloaded function.

Calls C++ function: void QTextCharFormat::setFont(const QFont& font).

C++ documentation:

This is an overloaded function.

Sets the text format's font.

See also font().

pub unsafe fn set_font_capitalization(&mut self, capitalization: Capitalization)

Sets the capitalization of the text that apppears in this font to capitalization.

Calls C++ function: void QTextCharFormat::setFontCapitalization(QFont::Capitalization capitalization).

C++ documentation:

Sets the capitalization of the text that apppears in this font to capitalization.

A font's capitalization makes the text appear in the selected capitalization mode.

This function was introduced in Qt 4.4.

See also fontCapitalization().

pub unsafe fn set_font_families(
    &mut self,
    families: impl CastInto<Ref<QStringList>>
)

Sets the text format's font families.

Calls C++ function: void QTextCharFormat::setFontFamilies(const QStringList& families).

C++ documentation:

Sets the text format's font families.

This function was introduced in Qt 5.13.

See also fontFamilies() and setFont().

This item is available if cpp_lib_version="5.13.0".

pub unsafe fn set_font_family(&mut self, family: impl CastInto<Ref<QString>>)

Sets the text format's font family.

Calls C++ function: void QTextCharFormat::setFontFamily(const QString& family).

C++ documentation:

Sets the text format's font family.

See also fontFamily() and setFont().

pub unsafe fn set_font_fixed_pitch(&mut self, fixed_pitch: bool)

If fixedPitch is true, sets the text format's font to be fixed pitch; otherwise a non-fixed pitch font is used.

Calls C++ function: void QTextCharFormat::setFontFixedPitch(bool fixedPitch).

C++ documentation:

If fixedPitch is true, sets the text format's font to be fixed pitch; otherwise a non-fixed pitch font is used.

See also fontFixedPitch() and setFont().

pub unsafe fn set_font_hinting_preference(
    &mut self,
    hinting_preference: HintingPreference
)

Sets the hinting preference of the text format's font to be hintingPreference.

Calls C++ function: void QTextCharFormat::setFontHintingPreference(QFont::HintingPreference hintingPreference).

C++ documentation:

Sets the hinting preference of the text format's font to be hintingPreference.

This function was introduced in Qt 4.8.

See also fontHintingPreference(), setFont(), and QFont::setHintingPreference().

pub unsafe fn set_font_italic(&mut self, italic: bool)

If italic is true, sets the text format's font to be italic; otherwise the font will be non-italic.

Calls C++ function: void QTextCharFormat::setFontItalic(bool italic).

C++ documentation:

If italic is true, sets the text format's font to be italic; otherwise the font will be non-italic.

See also fontItalic() and setFont().

pub unsafe fn set_font_kerning(&mut self, enable: bool)

Enables kerning for this font if enable is true; otherwise disables it.

Calls C++ function: void QTextCharFormat::setFontKerning(bool enable).

C++ documentation:

Enables kerning for this font if enable is true; otherwise disables it.

When kerning is enabled, glyph metrics do not add up anymore, even for Latin text. In other words, the assumption that width('a') + width('b') is equal to width("ab") is not neccesairly true.

This function was introduced in Qt 4.5.

See also fontKerning() and setFont().

pub unsafe fn set_font_letter_spacing(&mut self, spacing: c_double)

Sets the letter spacing of this format to the given spacing. The meaning of the value depends on the font letter spacing type.

Calls C++ function: void QTextCharFormat::setFontLetterSpacing(double spacing).

C++ documentation:

Sets the letter spacing of this format to the given spacing. The meaning of the value depends on the font letter spacing type.

For percentage spacing a value of 100 indicates default spacing; a value of 200 doubles the amount of space a letter takes.

This function was introduced in Qt 4.4.

See also fontLetterSpacing(), setFontLetterSpacingType(), and fontLetterSpacingType().

pub unsafe fn set_font_letter_spacing_type(
    &mut self,
    letter_spacing_type: SpacingType
)

Sets the letter spacing type of this format to letterSpacingType.

Calls C++ function: void QTextCharFormat::setFontLetterSpacingType(QFont::SpacingType letterSpacingType).

C++ documentation:

Sets the letter spacing type of this format to letterSpacingType.

This function was introduced in Qt 5.0.

See also fontLetterSpacingType(), setFontLetterSpacing(), and fontLetterSpacing().

pub unsafe fn set_font_overline(&mut self, overline: bool)

If overline is true, sets the text format's font to be overlined; otherwise the font is displayed non-overlined.

Calls C++ function: void QTextCharFormat::setFontOverline(bool overline).

C++ documentation:

If overline is true, sets the text format's font to be overlined; otherwise the font is displayed non-overlined.

See also fontOverline() and setFont().

pub unsafe fn set_font_point_size(&mut self, size: c_double)

Sets the text format's font size.

Calls C++ function: void QTextCharFormat::setFontPointSize(double size).

C++ documentation:

Sets the text format's font size.

See also fontPointSize() and setFont().

pub unsafe fn set_font_stretch(&mut self, factor: c_int)

Sets the stretch factor for the font to factor.

Calls C++ function: void QTextCharFormat::setFontStretch(int factor).

C++ documentation:

Sets the stretch factor for the font to factor.

The stretch factor changes the width of all characters in the font by factor percent. For example, setting factor to 150 results in all characters in the font being 1.5 times (ie. 150%) wider. The default stretch factor is 100. The minimum stretch factor is 1, and the maximum stretch factor is 4000.

The stretch factor is only applied to outline fonts. The stretch factor is ignored for bitmap fonts.

This function was introduced in Qt 5.0.

See also fontStretch().

pub unsafe fn set_font_strike_out(&mut self, strike_out: bool)

If strikeOut is true, sets the text format's font with strike-out enabled (with a horizontal line through it); otherwise it is displayed without strikeout.

Calls C++ function: void QTextCharFormat::setFontStrikeOut(bool strikeOut).

C++ documentation:

If strikeOut is true, sets the text format's font with strike-out enabled (with a horizontal line through it); otherwise it is displayed without strikeout.

See also fontStrikeOut() and setFont().

pub unsafe fn set_font_style_hint_2a(
    &mut self,
    hint: StyleHint,
    strategy: StyleStrategy
)

Sets the font style hint and strategy.

Calls C++ function: void QTextCharFormat::setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy = …).

C++ documentation:

Sets the font style hint and strategy.

Qt does not support style hints on X11 since this information is not provided by the window system.

This function was introduced in Qt 4.5.

See also fontStyleHint(), setFont(), and QFont::setStyleHint().

pub unsafe fn set_font_style_hint_1a(&mut self, hint: StyleHint)

Sets the font style hint and strategy.

Calls C++ function: void QTextCharFormat::setFontStyleHint(QFont::StyleHint hint).

C++ documentation:

Sets the font style hint and strategy.

Qt does not support style hints on X11 since this information is not provided by the window system.

This function was introduced in Qt 4.5.

See also fontStyleHint(), setFont(), and QFont::setStyleHint().

pub unsafe fn set_font_style_name(
    &mut self,
    style_name: impl CastInto<Ref<QString>>
)

Sets the text format's font styleName.

Calls C++ function: void QTextCharFormat::setFontStyleName(const QString& styleName).

C++ documentation:

Sets the text format's font styleName.

This function was introduced in Qt 5.13.

See also fontStyleName(), setFont(), and QFont::setStyleName().

This item is available if cpp_lib_version="5.13.0".

pub unsafe fn set_font_style_strategy(&mut self, strategy: StyleStrategy)

Sets the font style strategy.

Calls C++ function: void QTextCharFormat::setFontStyleStrategy(QFont::StyleStrategy strategy).

C++ documentation:

Sets the font style strategy.

This function was introduced in Qt 4.5.

See also fontStyleStrategy(), setFont(), and QFont::setStyleStrategy().

pub unsafe fn set_font_underline(&mut self, underline: bool)

If underline is true, sets the text format's font to be underlined; otherwise it is displayed non-underlined.

Calls C++ function: void QTextCharFormat::setFontUnderline(bool underline).

C++ documentation:

If underline is true, sets the text format's font to be underlined; otherwise it is displayed non-underlined.

See also fontUnderline() and setFont().

pub unsafe fn set_font_weight(&mut self, weight: c_int)

Sets the text format's font weight to weight.

Calls C++ function: void QTextCharFormat::setFontWeight(int weight).

C++ documentation:

Sets the text format's font weight to weight.

See also fontWeight(), setFont(), and QFont::Weight.

pub unsafe fn set_font_word_spacing(&mut self, spacing: c_double)

Sets the word spacing of this format to the given spacing, in pixels.

Calls C++ function: void QTextCharFormat::setFontWordSpacing(double spacing).

C++ documentation:

Sets the word spacing of this format to the given spacing, in pixels.

This function was introduced in Qt 4.4.

See also fontWordSpacing().

pub unsafe fn set_table_cell_column_span(
    &mut self,
    table_cell_column_span: c_int
)

Calls C++ function: void QTextCharFormat::setTableCellColumnSpan(int tableCellColumnSpan).

pub unsafe fn set_table_cell_row_span(&mut self, table_cell_row_span: c_int)

Calls C++ function: void QTextCharFormat::setTableCellRowSpan(int tableCellRowSpan).

pub unsafe fn set_text_outline(&mut self, pen: impl CastInto<Ref<QPen>>)

Sets the pen used to draw the outlines of characters to the given pen.

Calls C++ function: void QTextCharFormat::setTextOutline(const QPen& pen).

C++ documentation:

Sets the pen used to draw the outlines of characters to the given pen.

See also textOutline().

pub unsafe fn set_tool_tip(&mut self, tip: impl CastInto<Ref<QString>>)

Sets the tool tip for a fragment of text to the given text.

Calls C++ function: void QTextCharFormat::setToolTip(const QString& tip).

C++ documentation:

Sets the tool tip for a fragment of text to the given text.

This function was introduced in Qt 4.3.

See also toolTip().

pub unsafe fn set_underline_color(&mut self, color: impl CastInto<Ref<QColor>>)

Sets the underline color used for the characters with this format to the color specified.

Calls C++ function: void QTextCharFormat::setUnderlineColor(const QColor& color).

C++ documentation:

Sets the underline color used for the characters with this format to the color specified.

See also underlineColor().

pub unsafe fn set_underline_style(&mut self, style: UnderlineStyle)

Sets the style of underlining the text to style.

Calls C++ function: void QTextCharFormat::setUnderlineStyle(QTextCharFormat::UnderlineStyle style).

C++ documentation:

Sets the style of underlining the text to style.

This function was introduced in Qt 4.2.

See also underlineStyle().

pub unsafe fn set_vertical_alignment(&mut self, alignment: VerticalAlignment)

Sets the vertical alignment used for the characters with this format to the alignment specified.

Calls C++ function: void QTextCharFormat::setVerticalAlignment(QTextCharFormat::VerticalAlignment alignment).

C++ documentation:

Sets the vertical alignment used for the characters with this format to the alignment specified.

See also verticalAlignment().

pub unsafe fn table_cell_column_span(&self) -> c_int

Calls C++ function: int QTextCharFormat::tableCellColumnSpan() const.

pub unsafe fn table_cell_row_span(&self) -> c_int

Calls C++ function: int QTextCharFormat::tableCellRowSpan() const.

pub unsafe fn text_outline(&self) -> CppBox<QPen>

Returns the pen used to draw the outlines of characters in this format.

Calls C++ function: QPen QTextCharFormat::textOutline() const.

C++ documentation:

Returns the pen used to draw the outlines of characters in this format.

See also setTextOutline().

pub unsafe fn tool_tip(&self) -> CppBox<QString>

Returns the tool tip that is displayed for a fragment of text.

Calls C++ function: QString QTextCharFormat::toolTip() const.

C++ documentation:

Returns the tool tip that is displayed for a fragment of text.

This function was introduced in Qt 4.3.

See also setToolTip().

pub unsafe fn underline_color(&self) -> CppBox<QColor>

Returns the color used to underline the characters with this format.

Calls C++ function: QColor QTextCharFormat::underlineColor() const.

C++ documentation:

Returns the color used to underline the characters with this format.

See also setUnderlineColor().

pub unsafe fn underline_style(&self) -> UnderlineStyle

Returns the style of underlining the text.

Calls C++ function: QTextCharFormat::UnderlineStyle QTextCharFormat::underlineStyle() const.

C++ documentation:

Returns the style of underlining the text.

This function was introduced in Qt 4.2.

See also setUnderlineStyle().

pub unsafe fn vertical_alignment(&self) -> VerticalAlignment

Returns the vertical alignment used for characters with this format.

Calls C++ function: QTextCharFormat::VerticalAlignment QTextCharFormat::verticalAlignment() const.

C++ documentation:

Returns the vertical alignment used for characters with this format.

See also setVerticalAlignment().

Methods from Deref<Target = QTextFormat>

pub unsafe fn background(&self) -> CppBox<QBrush>

Returns the brush used to paint the document's background.

Calls C++ function: QBrush QTextFormat::background() const.

C++ documentation:

Returns the brush used to paint the document's background.

See also setBackground(), clearBackground(), and foreground().

pub unsafe fn bool_property(&self, property_id: c_int) -> bool

Returns the value of the property specified by propertyId. If the property isn't of QTextFormat::Bool type, false is returned instead.

Calls C++ function: bool QTextFormat::boolProperty(int propertyId) const.

C++ documentation:

Returns the value of the property specified by propertyId. If the property isn't of QTextFormat::Bool type, false is returned instead.

See also setProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(), lengthProperty(), lengthVectorProperty(), and Property.

pub unsafe fn brush_property(&self, property_id: c_int) -> CppBox<QBrush>

Returns the value of the property given by propertyId; if the property isn't of QVariant::Brush type, Qt::NoBrush is returned instead.

Calls C++ function: QBrush QTextFormat::brushProperty(int propertyId) const.

C++ documentation:

Returns the value of the property given by propertyId; if the property isn't of QVariant::Brush type, Qt::NoBrush is returned instead.

See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), lengthProperty(), lengthVectorProperty(), and Property.

pub unsafe fn clear_background(&mut self)

Clears the brush used to paint the document's background. The default brush will be used.

Calls C++ function: void QTextFormat::clearBackground().

C++ documentation:

Clears the brush used to paint the document's background. The default brush will be used.

See also background(), setBackground(), and clearForeground().

pub unsafe fn clear_foreground(&mut self)

Clears the brush used to paint the document's foreground. The default brush will be used.

Calls C++ function: void QTextFormat::clearForeground().

C++ documentation:

Clears the brush used to paint the document's foreground. The default brush will be used.

See also foreground(), setForeground(), and clearBackground().

pub unsafe fn clear_property(&mut self, property_id: c_int)

Clears the value of the property given by propertyId

Calls C++ function: void QTextFormat::clearProperty(int propertyId).

C++ documentation:

Clears the value of the property given by propertyId

See also Property.

pub unsafe fn color_property(&self, property_id: c_int) -> CppBox<QColor>

Returns the value of the property given by propertyId; if the property isn't of QVariant::Color type, an invalid color is returned instead.

Calls C++ function: QColor QTextFormat::colorProperty(int propertyId) const.

C++ documentation:

Returns the value of the property given by propertyId; if the property isn't of QVariant::Color type, an invalid color is returned instead.

See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), lengthProperty(), lengthVectorProperty(), and Property.

pub unsafe fn copy_from(
    &mut self,
    rhs: impl CastInto<Ref<QTextFormat>>
) -> MutRef<QTextFormat>

Assigns the other text format to this text format, and returns a reference to this text format.

Calls C++ function: QTextFormat& QTextFormat::operator=(const QTextFormat& rhs).

C++ documentation:

Assigns the other text format to this text format, and returns a reference to this text format.

pub unsafe fn double_property(&self, property_id: c_int) -> c_double

Returns the value of the property specified by propertyId. If the property isn't of QVariant::Double or QMetaType::Float type, 0 is returned instead.

Calls C++ function: double QTextFormat::doubleProperty(int propertyId) const.

C++ documentation:

Returns the value of the property specified by propertyId. If the property isn't of QVariant::Double or QMetaType::Float type, 0 is returned instead.

See also setProperty(), boolProperty(), intProperty(), stringProperty(), colorProperty(), lengthProperty(), lengthVectorProperty(), and Property.

pub unsafe fn foreground(&self) -> CppBox<QBrush>

Returns the brush used to render foreground details, such as text, frame outlines, and table borders.

Calls C++ function: QBrush QTextFormat::foreground() const.

C++ documentation:

Returns the brush used to render foreground details, such as text, frame outlines, and table borders.

See also setForeground(), clearForeground(), and background().

pub unsafe fn has_property(&self, property_id: c_int) -> bool

Returns true if the text format has a property with the given propertyId; otherwise returns false.

Calls C++ function: bool QTextFormat::hasProperty(int propertyId) const.

C++ documentation:

Returns true if the text format has a property with the given propertyId; otherwise returns false.

See also properties() and Property.

pub unsafe fn int_property(&self, property_id: c_int) -> c_int

Returns the value of the property specified by propertyId. If the property is not of QTextFormat::Integer type, 0 is returned instead.

Calls C++ function: int QTextFormat::intProperty(int propertyId) const.

C++ documentation:

Returns the value of the property specified by propertyId. If the property is not of QTextFormat::Integer type, 0 is returned instead.

See also setProperty(), boolProperty(), doubleProperty(), stringProperty(), colorProperty(), lengthProperty(), lengthVectorProperty(), and Property.

pub unsafe fn is_block_format(&self) -> bool

Returns true if this text format is a BlockFormat; otherwise returns false.

Calls C++ function: bool QTextFormat::isBlockFormat() const.

C++ documentation:

Returns true if this text format is a BlockFormat; otherwise returns false.

pub unsafe fn is_char_format(&self) -> bool

Returns true if this text format is a CharFormat; otherwise returns false.

Calls C++ function: bool QTextFormat::isCharFormat() const.

C++ documentation:

Returns true if this text format is a CharFormat; otherwise returns false.

pub unsafe fn is_empty(&self) -> bool

Returns true if the format does not store any properties; false otherwise.

Calls C++ function: bool QTextFormat::isEmpty() const.

C++ documentation:

Returns true if the format does not store any properties; false otherwise.

This function was introduced in Qt 5.3.

See also propertyCount() and properties().

pub unsafe fn is_frame_format(&self) -> bool

Returns true if this text format is a FrameFormat; otherwise returns false.

Calls C++ function: bool QTextFormat::isFrameFormat() const.

C++ documentation:

Returns true if this text format is a FrameFormat; otherwise returns false.

pub unsafe fn is_image_format(&self) -> bool

Returns true if this text format is an image format; otherwise returns false.

Calls C++ function: bool QTextFormat::isImageFormat() const.

C++ documentation:

Returns true if this text format is an image format; otherwise returns false.

pub unsafe fn is_list_format(&self) -> bool

Returns true if this text format is a ListFormat; otherwise returns false.

Calls C++ function: bool QTextFormat::isListFormat() const.

C++ documentation:

Returns true if this text format is a ListFormat; otherwise returns false.

pub unsafe fn is_table_cell_format(&self) -> bool

Returns true if this text format is a TableCellFormat; otherwise returns false.

Calls C++ function: bool QTextFormat::isTableCellFormat() const.

C++ documentation:

Returns true if this text format is a TableCellFormat; otherwise returns false.

This function was introduced in Qt 4.4.

pub unsafe fn is_table_format(&self) -> bool

Returns true if this text format is a TableFormat; otherwise returns false.

Calls C++ function: bool QTextFormat::isTableFormat() const.

C++ documentation:

Returns true if this text format is a TableFormat; otherwise returns false.

pub unsafe fn is_valid(&self) -> bool

Returns true if the format is valid (i.e. is not InvalidFormat); otherwise returns false.

Calls C++ function: bool QTextFormat::isValid() const.

C++ documentation:

Returns true if the format is valid (i.e. is not InvalidFormat); otherwise returns false.

pub unsafe fn layout_direction(&self) -> LayoutDirection

Returns the document's layout direction.

Calls C++ function: Qt::LayoutDirection QTextFormat::layoutDirection() const.

C++ documentation:

Returns the document's layout direction.

See also setLayoutDirection().

pub unsafe fn length_property(&self, property_id: c_int) -> CppBox<QTextLength>

Returns the value of the property given by propertyId.

Calls C++ function: QTextLength QTextFormat::lengthProperty(int propertyId) const.

C++ documentation:

Returns the value of the property given by propertyId.

See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(), lengthVectorProperty(), and Property.

pub unsafe fn length_vector_property(
    &self,
    property_id: c_int
) -> CppBox<QVectorOfQTextLength>

Returns the value of the property given by propertyId. If the property isn't of QTextFormat::LengthVector type, an empty length vector is returned instead.

Calls C++ function: QVector<QTextLength> QTextFormat::lengthVectorProperty(int propertyId) const.

C++ documentation:

Returns the value of the property given by propertyId. If the property isn't of QTextFormat::LengthVector type, an empty length vector is returned instead.

See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(), lengthProperty(), and Property.

pub unsafe fn merge(&mut self, other: impl CastInto<Ref<QTextFormat>>)

Merges the other format with this format; where there are conflicts the other format takes precedence.

Calls C++ function: void QTextFormat::merge(const QTextFormat& other).

C++ documentation:

Merges the other format with this format; where there are conflicts the other format takes precedence.

pub unsafe fn object_index(&self) -> c_int

Returns the index of the format object, or -1 if the format object is invalid.

Calls C++ function: int QTextFormat::objectIndex() const.

C++ documentation:

Returns the index of the format object, or -1 if the format object is invalid.

See also setObjectIndex().

pub unsafe fn object_type(&self) -> c_int

Returns the text format's object type.

Calls C++ function: int QTextFormat::objectType() const.

C++ documentation:

Returns the text format's object type.

See also ObjectTypes and setObjectType().

pub unsafe fn pen_property(&self, property_id: c_int) -> CppBox<QPen>

Returns the value of the property given by propertyId; if the property isn't of QVariant::Pen type, Qt::NoPen is returned instead.

Calls C++ function: QPen QTextFormat::penProperty(int propertyId) const.

C++ documentation:

Returns the value of the property given by propertyId; if the property isn't of QVariant::Pen type, Qt::NoPen is returned instead.

See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), lengthProperty(), lengthVectorProperty(), and Property.

pub unsafe fn properties(&self) -> CppBox<QMapOfIntQVariant>

Returns a map with all properties of this text format.

Calls C++ function: QMap<int, QVariant> QTextFormat::properties() const.

C++ documentation:

Returns a map with all properties of this text format.

pub unsafe fn property(&self, property_id: c_int) -> CppBox<QVariant>

Returns the property specified by the given propertyId.

Calls C++ function: QVariant QTextFormat::property(int propertyId) const.

C++ documentation:

Returns the property specified by the given propertyId.

See also setProperty() and Property.

pub unsafe fn property_count(&self) -> c_int

Returns the number of properties stored in the format.

Calls C++ function: int QTextFormat::propertyCount() const.

C++ documentation:

Returns the number of properties stored in the format.

This function was introduced in Qt 4.3.

pub unsafe fn set_background(&mut self, brush: impl CastInto<Ref<QBrush>>)

Sets the brush use to paint the document's background to the brush specified.

Calls C++ function: void QTextFormat::setBackground(const QBrush& brush).

C++ documentation:

Sets the brush use to paint the document's background to the brush specified.

See also background(), clearBackground(), and setForeground().

pub unsafe fn set_foreground(&mut self, brush: impl CastInto<Ref<QBrush>>)

Sets the foreground brush to the specified brush. The foreground brush is mostly used to render text.

Calls C++ function: void QTextFormat::setForeground(const QBrush& brush).

C++ documentation:

Sets the foreground brush to the specified brush. The foreground brush is mostly used to render text.

See also foreground(), clearForeground(), and setBackground().

pub unsafe fn set_layout_direction(&mut self, direction: LayoutDirection)

Sets the document's layout direction to the specified direction.

Calls C++ function: void QTextFormat::setLayoutDirection(Qt::LayoutDirection direction).

C++ documentation:

Sets the document's layout direction to the specified direction.

See also layoutDirection().

pub unsafe fn set_object_index(&mut self, object: c_int)

Sets the format object's object index.

Calls C++ function: void QTextFormat::setObjectIndex(int object).

C++ documentation:

Sets the format object's object index.

See also objectIndex().

pub unsafe fn set_object_type(&mut self, type_: c_int)

Sets the text format's object type to type.

Calls C++ function: void QTextFormat::setObjectType(int type).

C++ documentation:

Sets the text format's object type to type.

See also ObjectTypes and objectType().

pub unsafe fn set_property_int_q_variant(
    &mut self,
    property_id: c_int,
    value: impl CastInto<Ref<QVariant>>
)

Sets the property specified by the propertyId to the given value.

Calls C++ function: void QTextFormat::setProperty(int propertyId, const QVariant& value).

C++ documentation:

Sets the property specified by the propertyId to the given value.

See also property() and Property.

pub unsafe fn set_property_int_q_vector_of_q_text_length(
    &mut self,
    property_id: c_int,
    lengths: impl CastInto<Ref<QVectorOfQTextLength>>
)

Sets the value of the property given by propertyId to value.

Calls C++ function: void QTextFormat::setProperty(int propertyId, const QVector<QTextLength>& lengths).

C++ documentation:

Sets the value of the property given by propertyId to value.

See also lengthVectorProperty() and Property.

pub unsafe fn string_property(&self, property_id: c_int) -> CppBox<QString>

Returns the value of the property given by propertyId; if the property isn't of QVariant::String type, an empty string is returned instead.

Calls C++ function: QString QTextFormat::stringProperty(int propertyId) const.

C++ documentation:

Returns the value of the property given by propertyId; if the property isn't of QVariant::String type, an empty string is returned instead.

See also setProperty(), boolProperty(), intProperty(), doubleProperty(), colorProperty(), lengthProperty(), lengthVectorProperty(), and Property.

pub unsafe fn swap(&mut self, other: impl CastInto<MutRef<QTextFormat>>)

Swaps this text format with other. This function is very fast and never fails.

Calls C++ function: void QTextFormat::swap(QTextFormat& other).

C++ documentation:

Swaps this text format with other. This function is very fast and never fails.

This function was introduced in Qt 5.0.

pub unsafe fn to_block_format(&self) -> CppBox<QTextBlockFormat>

Returns this format as a block format.

Calls C++ function: QTextBlockFormat QTextFormat::toBlockFormat() const.

C++ documentation:

Returns this format as a block format.

pub unsafe fn to_char_format(&self) -> CppBox<QTextCharFormat>

Returns this format as a character format.

Calls C++ function: QTextCharFormat QTextFormat::toCharFormat() const.

C++ documentation:

Returns this format as a character format.

pub unsafe fn to_frame_format(&self) -> CppBox<QTextFrameFormat>

Returns this format as a frame format.

Calls C++ function: QTextFrameFormat QTextFormat::toFrameFormat() const.

C++ documentation:

Returns this format as a frame format.

pub unsafe fn to_image_format(&self) -> CppBox<QTextImageFormat>

Returns this format as an image format.

Calls C++ function: QTextImageFormat QTextFormat::toImageFormat() const.

C++ documentation:

Returns this format as an image format.

pub unsafe fn to_list_format(&self) -> CppBox<QTextListFormat>

Returns this format as a list format.

Calls C++ function: QTextListFormat QTextFormat::toListFormat() const.

C++ documentation:

Returns this format as a list format.

pub unsafe fn to_q_variant(&self) -> CppBox<QVariant>

Returns the text format as a QVariant

Calls C++ function: QVariant QTextFormat::operator QVariant() const.

C++ documentation:

Returns the text format as a QVariant

pub unsafe fn to_table_cell_format(&self) -> CppBox<QTextTableCellFormat>

Returns this format as a table cell format.

Calls C++ function: QTextTableCellFormat QTextFormat::toTableCellFormat() const.

C++ documentation:

Returns this format as a table cell format.

This function was introduced in Qt 4.4.

pub unsafe fn to_table_format(&self) -> CppBox<QTextTableFormat>

Returns this format as a table format.

Calls C++ function: QTextTableFormat QTextFormat::toTableFormat() const.

C++ documentation:

Returns this format as a table format.

pub unsafe fn type_(&self) -> c_int

Returns the type of this format.

Calls C++ function: int QTextFormat::type() const.

C++ documentation:

Returns the type of this format.

See also FormatType.

Trait Implementations

impl CppDeletable for QTextCharFormat

unsafe fn delete(&mut self)

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

Calls C++ function: [destructor] void QTextCharFormat::~QTextCharFormat().

C++ documentation:

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

The character format of text in a document specifies the visual properties of the text, as well as information about its role in a hypertext document.

The font used can be set by supplying a font to the setFont() function, and each aspect of its appearance can be adjusted to give the desired effect. setFontFamily() and setFontPointSize() define the font's family (e.g. Times) and printed size; setFontWeight() and setFontItalic() provide control over the style of the font. setFontUnderline(), setFontOverline(), setFontStrikeOut(), and setFontFixedPitch() provide additional effects for text.

The color is set with setForeground(). If the text is intended to be used as an anchor (for hyperlinks), this can be enabled with setAnchor(). The setAnchorHref() and setAnchorNames() functions are used to specify the information about the hyperlink's destination and the anchor's name.

impl Deref for QTextCharFormat

type Target = QTextFormat

The resulting type after dereferencing.

fn deref(&self) -> &QTextFormat

Calls C++ function: QTextFormat* static_cast<QTextFormat*>(QTextCharFormat* ptr).

impl DerefMut for QTextCharFormat

fn deref_mut(&mut self) -> &mut QTextFormat

Calls C++ function: QTextFormat* static_cast<QTextFormat*>(QTextCharFormat* ptr).

impl StaticDowncast<QTextCharFormat> for QTextFormat

unsafe fn static_downcast(ptr: Ptr<QTextFormat>) -> Ptr<QTextCharFormat>

Calls C++ function: QTextCharFormat* static_cast<QTextCharFormat*>(QTextFormat* ptr).

unsafe fn static_downcast_mut(
    ptr: MutPtr<QTextFormat>
) -> MutPtr<QTextCharFormat>

Calls C++ function: QTextCharFormat* static_cast<QTextCharFormat*>(QTextFormat* ptr).

impl StaticDowncast<QTextImageFormat> for QTextCharFormat

unsafe fn static_downcast(ptr: Ptr<QTextCharFormat>) -> Ptr<QTextImageFormat>

Calls C++ function: QTextImageFormat* static_cast<QTextImageFormat*>(QTextCharFormat* ptr).

unsafe fn static_downcast_mut(
    ptr: MutPtr<QTextCharFormat>
) -> MutPtr<QTextImageFormat>

Calls C++ function: QTextImageFormat* static_cast<QTextImageFormat*>(QTextCharFormat* ptr).

impl StaticDowncast<QTextTableCellFormat> for QTextCharFormat

unsafe fn static_downcast(
    ptr: Ptr<QTextCharFormat>
) -> Ptr<QTextTableCellFormat>

Calls C++ function: QTextTableCellFormat* static_cast<QTextTableCellFormat*>(QTextCharFormat* ptr).

unsafe fn static_downcast_mut(
    ptr: MutPtr<QTextCharFormat>
) -> MutPtr<QTextTableCellFormat>

Calls C++ function: QTextTableCellFormat* static_cast<QTextTableCellFormat*>(QTextCharFormat* ptr).

impl StaticUpcast<QTextCharFormat> for QTextImageFormat

unsafe fn static_upcast(ptr: Ptr<QTextImageFormat>) -> Ptr<QTextCharFormat>

Calls C++ function: QTextCharFormat* static_cast<QTextCharFormat*>(QTextImageFormat* ptr).

unsafe fn static_upcast_mut(
    ptr: MutPtr<QTextImageFormat>
) -> MutPtr<QTextCharFormat>

Calls C++ function: QTextCharFormat* static_cast<QTextCharFormat*>(QTextImageFormat* ptr).

impl StaticUpcast<QTextCharFormat> for QTextTableCellFormat

unsafe fn static_upcast(ptr: Ptr<QTextTableCellFormat>) -> Ptr<QTextCharFormat>

Calls C++ function: QTextCharFormat* static_cast<QTextCharFormat*>(QTextTableCellFormat* ptr).

unsafe fn static_upcast_mut(
    ptr: MutPtr<QTextTableCellFormat>
) -> MutPtr<QTextCharFormat>

Calls C++ function: QTextCharFormat* static_cast<QTextCharFormat*>(QTextTableCellFormat* ptr).

impl StaticUpcast<QTextFormat> for QTextCharFormat

unsafe fn static_upcast(ptr: Ptr<QTextCharFormat>) -> Ptr<QTextFormat>

Calls C++ function: QTextFormat* static_cast<QTextFormat*>(QTextCharFormat* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QTextCharFormat>) -> MutPtr<QTextFormat>

Calls C++ function: QTextFormat* static_cast<QTextFormat*>(QTextCharFormat* ptr).