QTextLength Class | Qt GUI 5.6

Qt 5.6 | Qt GUI | C++ Classes | QTextLength

Qt 5.6.2 Reference Documentation

# QTextLength Class

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

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

- List of all members, including inherited members

Note: All functions in this class are reentrant.

## Public Types

enum | Type { VariableLength, FixedLength, PercentageLength }

## Public Functions

| QTextLength()
| QTextLength(Type type, qreal value)
qreal | rawValue() const
Type | type() const
qreal | value(qreal maximumLength) const
| 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.

Constant | Value | Description
--- | --- | ---
`QTextLength::VariableLength` | `0` | The width of the object is variable
`QTextLength::FixedLength` | `1` | The width of the object is fixed
`QTextLength::PercentageLength` | `2` | The width of the object is in percentage of the maximum width

See also type().

## Member Function Documentation

### QTextLength::QTextLength()

Constructs a new length object which represents a variable size.

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

Constructs a new length object of the given type and value.

### qreal QTextLength::rawValue() const

Returns the constraint value that is specific for the type of the length. If the length is QTextLength::PercentageLength then the raw value is in percent, in the range of 0 to 100. If the length is QTextLength::FixedLength then that fixed amount is returned. For variable lengths, zero is returned.

### Type QTextLength::type() const

Returns the type of this length object.

See also QTextLength::Type.

### qreal QTextLength::value(qreal maximumLength) const

Returns the effective length, constrained by the type of the length object and the specified maximumLength.

See also type().

### QTextLength::operator QVariant() const

Returns the text length as a QVariant

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

Returns `true` if this text length is different from the other text length.

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

Returns `true` if this text length is the same as the other text length.