CopperSpice API  1.7.2
QTextLength Class Reference

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

Public Types

enum  Type
 

Public Methods

 QTextLength ()
 
 QTextLength (Type type, qreal value)
 
 operator QVariant () const
 
bool operator!= (const QTextLength &other) const
 
bool operator== (const QTextLength &other) const
 
qreal rawValue () const
 
Type type () const
 
qreal value (qreal maximumLength) 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 Enumeration Documentation

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()

Constructor & Destructor Documentation

QTextLength::QTextLength ( )
inline

Constructs a new length object which represents a variable size.

QTextLength::QTextLength ( Type  atype,
qreal  avalue 
)
inlineexplicit

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

Method Documentation

QTextLength::operator QVariant ( ) const

Returns the text length as a QVariant

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

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

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

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

qreal QTextLength::rawValue ( ) const
inline

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
inline

Returns the type of this length object.

See also
QTextLength::Type
qreal QTextLength::value ( qreal  maximumLength) const
inline

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

See also
type()