QTextLength Class

The QTextLength class encapsulates the different types of length used in a QTextDocument. More...

Header: #include <QTextLength>
qmake: QT += gui

Note: All functions in this class are reentrant.

Public Types

enum Type { VariableLength, FixedLength, PercentageLength }

Public Functions

QTextLength()
QTextLength(QTextLength::Type type, qreal value)
qreal rawValue() const
QTextLength::Type type() const
qreal value(qreal maximumLength) const
QVariant operator QVariant() const
bool operator!=(const QTextLength &other) const
bool operator==(const QTextLength &other) const

Detailed Description

The QTextLength class encapsulates the different types of length used in a QTextDocument.

When we specify a value for the length of an element in a text document, we often need to provide some other information so that the length is used in the way we expect. For example, when we specify a table width, the value can represent a fixed number of pixels, or it can be a percentage value. This information changes both the meaning of the value and the way it is used.

Generally, this class is used to specify table widths. These can be specified either as a fixed amount of pixels, as a percentage of the containing frame's width, or by a variable width that allows it to take up just the space it requires.

See also QTextTable.

Member Type Documentation

enum QTextLength::Type

This enum describes the different types a length object can have.

ConstantValueDescription
QTextLength::VariableLength0The width of the object is variable
QTextLength::FixedLength1The width of the object is fixed
QTextLength::PercentageLength2The width of the object is in percentage of the maximum width

See also type().

Member Function Documentation

QTextLength::QTextLength()

Default constructs an instance of QTextLength.

QTextLength::QTextLength(QTextLength::Type type, qreal value)

Default constructs an instance of QTextLength.

qreal QTextLength::rawValue() const

QTextLength::Type QTextLength::type() const

qreal QTextLength::value(qreal maximumLength) const

QVariant QTextLength::operator QVariant() const

Returns the text length as a QVariant

bool QTextLength::operator!=(const QTextLength &other) const

bool QTextLength::operator==(const QTextLength &other) const