QTextLength

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

Synopsis

Functions

• def __eq__ (other)

• def __ne__ (other)

• def rawValue ()

• def type ()

• def value (maximumLength)

Detailed Description

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

class PySide6.QtGui.QTextLength

PySide6.QtGui.QTextLength(type, value)

PySide6.QtGui.QTextLength(QTextLength)

Parameters

• value – float

• QTextLength – PySide6.QtGui.QTextLength

• type – Type

Constructs a new length object which represents a variable size.

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

PySide6.QtGui.QTextLength.Type

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

Constant	Description
QTextLength.VariableLength	The width of the object is variable
QTextLength.FixedLength	The width of the object is fixed
QTextLength.PercentageLength	The width of the object is in percentage of the maximum width

See also

type()

PySide6.QtGui.QTextLength.__ne__(other)

Parameters

other – PySide6.QtGui.QTextLength

Return type

bool

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

PySide6.QtGui.QTextLength.__eq__(other)

Parameters

other – PySide6.QtGui.QTextLength

Return type

bool

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

PySide6.QtGui.QTextLength.rawValue()

Return type

float

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

PySide6.QtGui.QTextLength.type()

Return type

Type

Returns the type of this length object.

See also

Type

PySide6.QtGui.QTextLength.value(maximumLength)

Parameters

maximumLength – float

Return type

float

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

See also

type()