Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QTextLayout Class Reference

\reentrant More...

#include <qtextlayout.h>

Collaboration diagram for QTextLayout:

Classes

class  FormatRange
 \reentrant More...

Public Types

enum  GlyphRunRetrievalFlag : quint16 {
  RetrieveGlyphIndexes = 0x1 , RetrieveGlyphPositions = 0x2 , RetrieveStringIndexes = 0x4 , RetrieveString = 0x8 ,
  DefaultRetrievalFlags = RetrieveGlyphIndexes | RetrieveGlyphPositions , RetrieveAll = 0xffff
}
enum  CursorMode { SkipCharacters , SkipWords }
 \value SkipCharacters \value SkipWords More...

Public Member Functions

 QTextLayout ()
 Constructs an empty text layout.
 QTextLayout (const QString &text)
 Constructs a text layout to lay out the given text.
 QTextLayout (const QString &text, const QFont &font, const QPaintDevice *paintdevice=nullptr)
 QTextLayout (const QTextBlock &b)
 ~QTextLayout ()
 Destructs the layout.
void setFont (const QFont &f)
 Sets the layout's font to the given font.
QFont font () const
 Returns the current font that is used for the layout, or a default font if none is set.
void setRawFont (const QRawFont &rawFont)
void setText (const QString &string)
 Sets the layout's text to the given string.
QString text () const
 Returns the layout's text.
void setTextOption (const QTextOption &option)
 Sets the text option structure that controls the layout process to the given option.
const QTextOptiontextOption () const
 Returns the current text option used to control the layout process.
void setPreeditArea (int position, const QString &text)
 Sets the position and text of the area in the layout that is processed before editing occurs.
int preeditAreaPosition () const
 Returns the position of the area in the text layout that will be processed before editing occurs.
QString preeditAreaText () const
 Returns the text that is inserted in the layout before editing occurs.
void setFormats (const QList< FormatRange > &overrides)
QList< FormatRangeformats () const
void clearFormats ()
void setCacheEnabled (bool enable)
 Enables caching of the complete layout information if enable is true; otherwise disables layout caching.
bool cacheEnabled () const
 Returns true if the complete layout information is cached; otherwise returns false.
void setCursorMoveStyle (Qt::CursorMoveStyle style)
 Sets the visual cursor movement style to the given style.
Qt::CursorMoveStyle cursorMoveStyle () const
 The cursor movement style of this QTextLayout.
void beginLayout ()
 Begins the layout process.
void endLayout ()
 Ends the layout process.
void clearLayout ()
QTextLine createLine ()
 Returns a new text line to be laid out if there is text to be inserted into the layout; otherwise returns an invalid text line.
int lineCount () const
 Returns the number of lines in this text layout.
QTextLine lineAt (int i) const
 Returns the {i}-th line of text in this text layout.
QTextLine lineForTextPosition (int pos) const
 Returns the line that contains the cursor position specified by pos.
bool isValidCursorPosition (int pos) const
 Returns true if position pos is a valid cursor position.
int nextCursorPosition (int oldPos, CursorMode mode=SkipCharacters) const
 Returns the next valid cursor position after oldPos that respects the given cursor mode.
int previousCursorPosition (int oldPos, CursorMode mode=SkipCharacters) const
 Returns the first valid cursor position before oldPos that respects the given cursor mode.
int leftCursorPosition (int oldPos) const
 Returns the cursor position to the left of oldPos, next to it.
int rightCursorPosition (int oldPos) const
 Returns the cursor position to the right of oldPos, next to it.
void draw (QPainter *p, const QPointF &pos, const QList< FormatRange > &selections=QList< FormatRange >(), const QRectF &clip=QRectF()) const
 Draws the whole layout on the painter p at the position specified by pos.
void drawCursor (QPainter *p, const QPointF &pos, int cursorPosition) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Draws a text cursor with the current pen at the given position using the painter specified.
void drawCursor (QPainter *p, const QPointF &pos, int cursorPosition, int width) const
 Draws a text cursor with the current pen and the specified width at the given position using the painter specified.
QPointF position () const
void setPosition (const QPointF &p)
 Moves the text layout to point p.
QRectF boundingRect () const
 The smallest rectangle that contains all the lines in the layout.
qreal minimumWidth () const
 The minimum width the layout needs.
qreal maximumWidth () const
 The maximum width the layout could expand to; this is essentially the width of the entire text.
QList< QGlyphRunglyphRuns (int from=-1, int length=-1, GlyphRunRetrievalFlags flags=DefaultRetrievalFlags) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns the glyph indexes and positions for all glyphs corresponding to the length characters starting at the position from in this QTextLayout.
QTextEngineengine () const
void setFlags (int flags)

Friends

class QPainter
class QGraphicsSimpleTextItemPrivate
class QGraphicsSimpleTextItem
void qt_format_text (const QFont &font, const QRectF &_r, int tf, int alignment, const QTextOption *opt, const QString &str, QRectF *brect, int tabstops, int *tabarray, int tabarraylen, QPainter *painter)

Detailed Description

\reentrant

The QTextLayout class is used to lay out and render text. \inmodule QtGui

It offers many features expected from a modern text layout engine, including Unicode compliant rendering, line breaking and handling of cursor positioning. It can also produce and render device independent layout, something that is important for WYSIWYG applications.

The class has a rather low level API and unless you intend to implement your own text rendering for some specialized widget, you probably won't need to use it directly.

QTextLayout can be used with both plain and rich text.

QTextLayout can be used to create a sequence of QTextLine instances with given widths and can position them independently on the screen. Once the layout is done, these lines can be drawn on a paint device.

The text to be laid out can be provided in the constructor or set with setText().

The layout can be seen as a sequence of QTextLine objects; use createLine() to create a QTextLine instance, and lineAt() or lineForTextPosition() to retrieve created lines.

Here is a code snippet that demonstrates the layout phase:

int leading = fontMetrics.leading();
textLayout.setCacheEnabled(true);
textLayout.beginLayout();
while (true) {
QTextLine line = textLayout.createLine();
if (!line.isValid())
break;
line.setLineWidth(lineWidth);
height += leading;
line.setPosition(QPointF(0, height));
height += line.height();
}
textLayout.endLayout();

The text can then be rendered by calling the layout's draw() function:

textLayout.draw(&painter, QPoint(0, 0));

It is also possible to draw each line individually, for instance to draw the last line that fits into a widget elided:

QFontMetrics fontMetrics = painter.fontMetrics();
int lineSpacing = fontMetrics.lineSpacing();
int y = 0;
QTextLayout textLayout(content, painter.font());
while (true) {
QTextLine line = textLayout.createLine();
if (!line.isValid())
break;
line.setLineWidth(width());
const int nextLineY = y + lineSpacing;
if (height() >= nextLineY + lineSpacing) {
line.draw(&painter, QPoint(0, y));
y = nextLineY;
} else {
const QString lastLine = content.mid(line.textStart());
const QString elidedLastLine = fontMetrics.elidedText(lastLine, Qt::ElideRight, width());
painter.drawText(QPoint(0, y + fontMetrics.ascent()), elidedLastLine);
break;
}
}

For a given position in the text you can find a valid cursor position with isValidCursorPosition(), nextCursorPosition(), and previousCursorPosition().

The QTextLayout itself can be positioned with setPosition(); it has a boundingRect(), and a minimumWidth() and a maximumWidth().

See also
QStaticText

Definition at line 69 of file qtextlayout.h.

Member Enumeration Documentation

◆ CursorMode

\value SkipCharacters \value SkipWords

Enumerator
SkipCharacters 
SkipWords 

Definition at line 137 of file qtextlayout.h.

◆ GlyphRunRetrievalFlag

Since
6.5

GlyphRunRetrievalFlag specifies flags passed to the glyphRuns() functions to determine which properties of the layout are returned in the QGlyphRun objects. Since each property will consume memory and may require additional allocations, it is a good practice to only request the properties you will need to access later.

\value RetrieveGlyphIndexes Retrieves the indexes in the font which correspond to the glyphs. \value RetrieveGlyphPositions Retrieves the relative positions of the glyphs in the layout. \value RetrieveStringIndexes Retrieves the indexes in the original string that correspond to each of the glyphs. \value RetrieveString Retrieves the original source string from the layout. \value RetrieveAll Retrieves all available properties of the layout. \omitvalue DefaultRetrievalFlags

See also
glyphRuns(), QTextLine::glyphRuns()
Enumerator
RetrieveGlyphIndexes 
RetrieveGlyphPositions 
RetrieveStringIndexes 
RetrieveString 
DefaultRetrievalFlags 
RetrieveAll 

Definition at line 72 of file qtextlayout.h.

Constructor & Destructor Documentation

◆ QTextLayout() [1/4]

QTextLayout::QTextLayout ( )

Constructs an empty text layout.

See also
setText()

Definition at line 321 of file qtextlayout.cpp.

◆ QTextLayout() [2/4]

QTextLayout::QTextLayout ( const QString & text)

Constructs a text layout to lay out the given text.

Definition at line 327 of file qtextlayout.cpp.

◆ QTextLayout() [3/4]

QTextLayout::QTextLayout ( const QString & text,
const QFont & font,
const QPaintDevice * paintdevice = nullptr )
Since
5.13

Constructs a text layout to lay out the given text with the specified font.

All the metric and layout calculations will be done in terms of the paint device, paintdevice. If paintdevice is \nullptr the calculations will be done in screen metrics.

Definition at line 344 of file qtextlayout.cpp.

◆ QTextLayout() [4/4]

QTextLayout::QTextLayout ( const QTextBlock & block)

Constructs a text layout to lay out the given block.

Definition at line 354 of file qtextlayout.cpp.

◆ ~QTextLayout()

QTextLayout::~QTextLayout ( )

Destructs the layout.

Definition at line 363 of file qtextlayout.cpp.

Member Function Documentation

◆ beginLayout()

void QTextLayout::beginLayout ( )

Begins the layout process.

Warning
This will invalidate the layout, so all existing QTextLine objects that refer to the previous contents should now be discarded.
See also
endLayout()

Definition at line 594 of file qtextlayout.cpp.

◆ boundingRect()

QRectF QTextLayout::boundingRect ( ) const

The smallest rectangle that contains all the lines in the layout.

Definition at line 877 of file qtextlayout.cpp.

◆ cacheEnabled()

bool QTextLayout::cacheEnabled ( ) const

Returns true if the complete layout information is cached; otherwise returns false.

See also
setCacheEnabled()

Definition at line 557 of file qtextlayout.cpp.

◆ clearFormats()

void QTextLayout::clearFormats ( )
Since
5.6

Clears the list of additional formats supported by the text layout.

See also
formats(), setFormats()

Definition at line 531 of file qtextlayout.cpp.

◆ clearLayout()

void QTextLayout::clearLayout ( )
Since
4.4

Clears the line information in the layout. After having called this function, lineCount() returns 0.

Warning
This will invalidate the layout, so all existing QTextLine objects that refer to the previous contents should now be discarded.

Definition at line 639 of file qtextlayout.cpp.

◆ createLine()

QTextLine QTextLayout::createLine ( )

Returns a new text line to be laid out if there is text to be inserted into the layout; otherwise returns an invalid text line.

The text layout creates a new line object that starts after the last line in the layout, or at the beginning if the layout is empty. The layout maintains an internal cursor, and each line is filled with text from the cursor position onwards when the QTextLine::setLineWidth() function is called.

Once QTextLine::setLineWidth() is called, a new line can be created and filled with text. Repeating this process will lay out the whole block of text contained in the QTextLayout. If there is no text left to be inserted into the layout, the QTextLine returned will not be valid (isValid() will return false).

Definition at line 784 of file qtextlayout.cpp.

◆ cursorMoveStyle()

Qt::CursorMoveStyle QTextLayout::cursorMoveStyle ( ) const

The cursor movement style of this QTextLayout.

The default is Qt::LogicalMoveStyle.

See also
setCursorMoveStyle()

Definition at line 581 of file qtextlayout.cpp.

◆ draw()

void QTextLayout::draw ( QPainter * p,
const QPointF & pos,
const QList< FormatRange > & selections = QList<FormatRange>(),
const QRectF & clip = QRectF() ) const

Draws the whole layout on the painter p at the position specified by pos.

The rendered layout includes the given selections and is clipped within the rectangle specified by clip.

Definition at line 1088 of file qtextlayout.cpp.

◆ drawCursor() [1/2]

void QTextLayout::drawCursor ( QPainter * painter,
const QPointF & position,
int cursorPosition ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Draws a text cursor with the current pen at the given position using the painter specified.

The corresponding position within the text is specified by cursorPosition.

Definition at line 1272 of file qtextlayout.cpp.

◆ drawCursor() [2/2]

void QTextLayout::drawCursor ( QPainter * painter,
const QPointF & position,
int cursorPosition,
int width ) const

Draws a text cursor with the current pen and the specified width at the given position using the painter specified.

The corresponding position within the text is specified by cursorPosition.

Definition at line 1284 of file qtextlayout.cpp.

◆ endLayout()

void QTextLayout::endLayout ( )

Ends the layout process.

See also
beginLayout()

Definition at line 613 of file qtextlayout.cpp.

◆ engine()

QTextEngine * QTextLayout::engine ( ) const
inline

Returns the text engine used to render the text layout.

Definition at line 173 of file qtextlayout.h.

◆ font()

QFont QTextLayout::font ( ) const

Returns the current font that is used for the layout, or a default font if none is set.

See also
setFont()

Definition at line 406 of file qtextlayout.cpp.

◆ formats()

QList< QTextLayout::FormatRange > QTextLayout::formats ( ) const
Since
5.6

Returns the list of additional formats supported by the text layout.

See also
setFormats(), clearFormats()

Definition at line 519 of file qtextlayout.cpp.

◆ glyphRuns()

QList< QGlyphRun > QTextLayout::glyphRuns ( int from = -1,
int length = -1,
GlyphRunRetrievalFlags flags = DefaultRetrievalFlags ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns the glyph indexes and positions for all glyphs corresponding to the length characters starting at the position from in this QTextLayout.

This is an expensive function, and should not be called in a time sensitive context.

If from is less than zero, then the glyph run will begin at the first character in the layout. If length is less than zero, it will span the entire string from the start position.

The retrievalFlags specifies which properties of the QGlyphRun will be retrieved from the layout. To minimize allocations and memory consumption, this should be set to include only the properties that you need to access later.

Since
6.5
See also
draw(), QPainter::drawGlyphRun()

Definition at line 1034 of file qtextlayout.cpp.

◆ isValidCursorPosition()

bool QTextLayout::isValidCursorPosition ( int pos) const

Returns true if position pos is a valid cursor position.

In a Unicode context some positions in the text are not valid cursor positions, because the position is inside a Unicode surrogate or a grapheme cluster.

A grapheme cluster is a sequence of two or more Unicode characters that form one indivisible entity on the screen. For example the latin character ‘\unicode{0xC4}’ can be represented in Unicode by two characters, ‘A’ (0x41), and the combining diaeresis (0x308). A text cursor can only validly be positioned before or after these two characters, never between them since that wouldn't make sense. In indic languages every syllable forms a grapheme cluster.

Definition at line 760 of file qtextlayout.cpp.

◆ leftCursorPosition()

int QTextLayout::leftCursorPosition ( int oldPos) const

Returns the cursor position to the left of oldPos, next to it.

It's dependent on the visual position of characters, after bi-directional reordering.

See also
rightCursorPosition(), previousCursorPosition()

Definition at line 738 of file qtextlayout.cpp.

◆ lineAt()

QTextLine QTextLayout::lineAt ( int i) const

Returns the {i}-th line of text in this text layout.

See also
lineCount(), lineForTextPosition()

Definition at line 835 of file qtextlayout.cpp.

◆ lineCount()

int QTextLayout::lineCount ( ) const

Returns the number of lines in this text layout.

See also
lineAt()

Definition at line 825 of file qtextlayout.cpp.

◆ lineForTextPosition()

QTextLine QTextLayout::lineForTextPosition ( int pos) const

Returns the line that contains the cursor position specified by pos.

See also
isValidCursorPosition(), lineAt()

Definition at line 845 of file qtextlayout.cpp.

◆ maximumWidth()

qreal QTextLayout::maximumWidth ( ) const

The maximum width the layout could expand to; this is essentially the width of the entire text.

Warning
This function only returns a valid value after the layout has been done.
See also
minimumWidth()

Definition at line 921 of file qtextlayout.cpp.

◆ minimumWidth()

qreal QTextLayout::minimumWidth ( ) const

The minimum width the layout needs.

This is the width of the layout's smallest non-breakable substring.

Warning
This function only returns a valid value after the layout has been done.
See also
maximumWidth()

Definition at line 907 of file qtextlayout.cpp.

◆ nextCursorPosition()

int QTextLayout::nextCursorPosition ( int oldPos,
CursorMode mode = SkipCharacters ) const

Returns the next valid cursor position after oldPos that respects the given cursor mode.

Returns value of oldPos, if oldPos is not a valid cursor position.

See also
isValidCursorPosition(), previousCursorPosition()

Definition at line 651 of file qtextlayout.cpp.

◆ position()

QPointF QTextLayout::position ( ) const
Since
4.2

The global position of the layout. This is independent of the bounding rectangle and of the layout process.

See also
setPosition()

Definition at line 859 of file qtextlayout.cpp.

◆ preeditAreaPosition()

int QTextLayout::preeditAreaPosition ( ) const

Returns the position of the area in the text layout that will be processed before editing occurs.

See also
preeditAreaText()

Definition at line 481 of file qtextlayout.cpp.

◆ preeditAreaText()

QString QTextLayout::preeditAreaText ( ) const

Returns the text that is inserted in the layout before editing occurs.

See also
preeditAreaPosition()

Definition at line 491 of file qtextlayout.cpp.

◆ previousCursorPosition()

int QTextLayout::previousCursorPosition ( int oldPos,
CursorMode mode = SkipCharacters ) const

Returns the first valid cursor position before oldPos that respects the given cursor mode.

Returns value of oldPos, if oldPos is not a valid cursor position.

See also
isValidCursorPosition(), nextCursorPosition()

Definition at line 687 of file qtextlayout.cpp.

◆ rightCursorPosition()

int QTextLayout::rightCursorPosition ( int oldPos) const

Returns the cursor position to the right of oldPos, next to it.

It's dependent on the visual position of characters, after bi-directional reordering.

See also
leftCursorPosition(), nextCursorPosition()

Definition at line 724 of file qtextlayout.cpp.

◆ setCacheEnabled()

void QTextLayout::setCacheEnabled ( bool enable)

Enables caching of the complete layout information if enable is true; otherwise disables layout caching.

Usually QTextLayout throws most of the layouting information away after a call to endLayout() to reduce memory consumption. If you however want to draw the laid out text directly afterwards enabling caching might speed up drawing significantly.

See also
cacheEnabled()

Definition at line 546 of file qtextlayout.cpp.

◆ setCursorMoveStyle()

void QTextLayout::setCursorMoveStyle ( Qt::CursorMoveStyle style)

Sets the visual cursor movement style to the given style.

If the QTextLayout is backed by a document, you can ignore this and use the option in QTextDocument, this option is for widgets like QLineEdit or custom widgets without a QTextDocument. Default value is Qt::LogicalMoveStyle.

See also
cursorMoveStyle()

Definition at line 570 of file qtextlayout.cpp.

◆ setFlags()

void QTextLayout::setFlags ( int flags)

Definition at line 930 of file qtextlayout.cpp.

◆ setFont()

void QTextLayout::setFont ( const QFont & font)

Sets the layout's font to the given font.

The layout is invalidated and must be laid out again.

See also
font()

Definition at line 391 of file qtextlayout.cpp.

◆ setFormats()

void QTextLayout::setFormats ( const QList< FormatRange > & formats)
Since
5.6

Sets the additional formats supported by the text layout to formats. The formats are applied with preedit area text in place.

See also
formats(), clearFormats()

Definition at line 504 of file qtextlayout.cpp.

◆ setPosition()

void QTextLayout::setPosition ( const QPointF & p)

Moves the text layout to point p.

See also
position()

Definition at line 869 of file qtextlayout.cpp.

◆ setPreeditArea()

void QTextLayout::setPreeditArea ( int position,
const QString & text )

Sets the position and text of the area in the layout that is processed before editing occurs.

The layout is invalidated and must be laid out again.

See also
preeditAreaPosition(), preeditAreaText()

Definition at line 465 of file qtextlayout.cpp.

◆ setRawFont()

void QTextLayout::setRawFont ( const QRawFont & rawFont)

Sets a raw font, to be used with QTextLayout::glyphRuns. Note that this only supports the needs of WebKit. Use of this function with e.g. QTextLayout::draw will result in undefined behaviour.

Definition at line 377 of file qtextlayout.cpp.

◆ setText()

void QTextLayout::setText ( const QString & string)

Sets the layout's text to the given string.

The layout is invalidated and must be laid out again.

Notice that when using this QTextLayout as part of a QTextDocument this method will have no effect.

See also
text()

Definition at line 420 of file qtextlayout.cpp.

◆ setTextOption()

void QTextLayout::setTextOption ( const QTextOption & option)

Sets the text option structure that controls the layout process to the given option.

See also
textOption()

Definition at line 443 of file qtextlayout.cpp.

◆ text()

QString QTextLayout::text ( ) const

Returns the layout's text.

See also
setText()

Definition at line 432 of file qtextlayout.cpp.

◆ textOption()

const QTextOption & QTextLayout::textOption ( ) const

Returns the current text option used to control the layout process.

See also
setTextOption()

Definition at line 453 of file qtextlayout.cpp.

◆ QGraphicsSimpleTextItem

friend class QGraphicsSimpleTextItem
friend

Definition at line 181 of file qtextlayout.h.

◆ QGraphicsSimpleTextItemPrivate

friend class QGraphicsSimpleTextItemPrivate
friend

Definition at line 180 of file qtextlayout.h.

◆ QPainter

friend class QPainter
friend

Definition at line 179 of file qtextlayout.h.

◆ qt_format_text

void qt_format_text ( const QFont & font,
const QRectF & _r,
int tf,
int alignment,
const QTextOption * opt,
const QString & str,
QRectF * brect,
int tabstops,
int * tabarray,
int tabarraylen,
QPainter * painter )
friend

Definition at line 7167 of file qpainter.cpp.

References QPainter::QTextEngine.


The documentation for this class was generated from the following files: