QTextItem Class

The QTextItem class provides all the information required to draw text in a custom paint engine. More...

Header: #include <QTextItem>
CMake: find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui

Public Types

enum RenderFlag { RightToLeft, Overline, Underline, StrikeOut }
flags RenderFlags

Public Functions

qreal ascent() const
qreal descent() const
QFont font() const
QTextItem::RenderFlags renderFlags() const
QString text() const
qreal width() const

Detailed Description

When you reimplement your own paint engine, you must reimplement QPaintEngine::drawTextItem(), a function that takes a QTextItem as one of its arguments.

Member Type Documentation

enum QTextItem::RenderFlagflags QTextItem::RenderFlags

Constant Value Description
QTextItem::RightToLeft 0x1 Render the text from right to left.
QTextItem::Overline 0x10 Paint a line above the text.
QTextItem::Underline 0x20 Paint a line under the text.
QTextItem::StrikeOut 0x40 Paint a line through the text.

The RenderFlags type is a typedef for QFlags<RenderFlag>. It stores an OR combination of RenderFlag values.

Member Function Documentation

qreal QTextItem::ascent() const

Corresponds to the ascent of the piece of text that is drawn.

qreal QTextItem::descent() const

Corresponds to the descent of the piece of text that is drawn.

QFont QTextItem::font() const

Returns the font that should be used to draw the text.

QTextItem::RenderFlags QTextItem::renderFlags() const

Returns the render flags used.

QString QTextItem::text() const

Returns the text that should be drawn.

qreal QTextItem::width() const

Specifies the total width of the text to be drawn.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.0/qtextitem.html