Contents

• Public Types
• Public Functions
• Detailed Description

Detailed Description

TheQTextFormat class provides formatting information for aQTextDocument.

AQTextFormat is a generic class used for describing the format of parts of aQTextDocument. The derived classesQTextCharFormat,QTextBlockFormat,QTextListFormat, andQTextTableFormat are usually more useful, and describe the formatting that is applied to specific parts of the document.

A format has aFormatType which specifies the kinds of text item it can format; e.g. a block of text, a list, a table, etc. A format also has various properties (some specific to particular format types), as described by the Property enum. Every property has a corresponding Property.

The format type is given bytype(), and the format can be tested withisCharFormat(),isBlockFormat(),isListFormat(),isTableFormat(),isFrameFormat(), andisImageFormat(). If the type is determined, it can be retrieved withtoCharFormat(),toBlockFormat(),toListFormat(),toTableFormat(),toFrameFormat(), andtoImageFormat().

A format's properties can be set with thesetProperty() functions, and retrieved withboolProperty(),intProperty(),doubleProperty(), andstringProperty() as appropriate. All the property IDs used in the format can be retrieved with allPropertyIds(). One format can be merged into another usingmerge().

A format's object index can be set withsetObjectIndex(), and retrieved withobjectIndex(). These methods can be used to associate the format with aQTextObject. It is used to represent lists, frames, and tables inside the document.

Member Type Documentation

enum QTextFormat::FormatType

This enum describes the text item aQTextFormat object is formatting.

See alsoQTextCharFormat,QTextBlockFormat,QTextListFormat,QTextTableFormat, andtype().

enum QTextFormat::ObjectTypes

This enum describes what kind ofQTextObject this format is associated with.

See alsoQTextObject,QTextTable, andQTextObject::format().

enum QTextFormat::PageBreakFlag
flags QTextFormat::PageBreakFlags

This enum describes how page breaking is performed when printing. It maps to the corresponding css properties.

This enum was introduced or modified in Qt 4.2.

The PageBreakFlags type is a typedef forQFlags<PageBreakFlag>. It stores an OR combination of PageBreakFlag values.

See alsoQTextBlockFormat::pageBreakPolicy(),QTextFrameFormat::pageBreakPolicy(), andPageBreakPolicy.

enum QTextFormat::Property

This enum describes the different properties a format can have.

Paragraph and character properties

Paragraph properties

Character properties

List properties

Table and frame properties

Table cell properties

Image properties

Selection properties

Page break properties

See alsoproperty() andsetProperty().

Member Function Documentation

QTextFormat::QTextFormat()

Creates a new text format with anInvalidFormat.

See alsoFormatType.

QTextFormat::QTextFormat(int type)

Creates a new text format of the giventype.

See alsoFormatType.

QTextFormat::QTextFormat(constQTextFormat & other)

Creates a new text format with the same attributes as theother text format.

QTextFormat::~QTextFormat()

Destroys this text format.

QBrush QTextFormat::background() const

Returns the brush used to paint the document's background.

See alsosetBackground(),clearBackground(), andforeground().

bool QTextFormat::boolProperty(int propertyId) const

Returns the value of the property specified bypropertyId. If the property isn't of QTextFormat::Bool type, false is returned instead.

See alsosetProperty(),intProperty(),doubleProperty(),stringProperty(),colorProperty(),lengthProperty(),lengthVectorProperty(), andProperty.

QBrush QTextFormat::brushProperty(int propertyId) const

Returns the value of the property given bypropertyId; if the property isn't ofQVariant::Brush type,Qt::NoBrush is returned instead.

See alsosetProperty(),boolProperty(),intProperty(),doubleProperty(),stringProperty(),lengthProperty(),lengthVectorProperty(), andProperty.

void QTextFormat::clearBackground()

Clears the brush used to paint the document's background. The default brush will be used.

See alsobackground(),setBackground(), andclearForeground().

void QTextFormat::clearForeground()

Clears the brush used to paint the document's foreground. The default brush will be used.

See alsoforeground(),setForeground(), andclearBackground().

void QTextFormat::clearProperty(int propertyId)

Clears the value of the property given bypropertyId

See alsoProperty.

QColor QTextFormat::colorProperty(int propertyId) const

Returns the value of the property given bypropertyId; if the property isn't ofQVariant::Color type, an invalid color is returned instead.

See alsosetProperty(),boolProperty(),intProperty(),doubleProperty(),stringProperty(),lengthProperty(),lengthVectorProperty(), andProperty.

qreal QTextFormat::doubleProperty(int propertyId) const

Returns the value of the property specified bypropertyId. If the property isn't ofQVariant::Double orQMetaType::Float type, 0 is returned instead.

See alsosetProperty(),boolProperty(),intProperty(),stringProperty(),colorProperty(),lengthProperty(),lengthVectorProperty(), andProperty.

QBrush QTextFormat::foreground() const

Returns the brush used to render foreground details, such as text, frame outlines, and table borders.

See alsosetForeground(),clearForeground(), andbackground().

bool QTextFormat::hasProperty(int propertyId) const

Returns true if the text format has a property with the givenpropertyId; otherwise returns false.

See alsoproperties() andProperty.

int QTextFormat::intProperty(int propertyId) const

Returns the value of the property specified bypropertyId. If the property is not of QTextFormat::Integer type, 0 is returned instead.

See alsosetProperty(),boolProperty(),doubleProperty(),stringProperty(),colorProperty(),lengthProperty(),lengthVectorProperty(), andProperty.

bool QTextFormat::isBlockFormat() const

Returns true if this text format is aBlockFormat; otherwise returns false.

bool QTextFormat::isCharFormat() const

Returns true if this text format is aCharFormat; otherwise returns false.

bool QTextFormat::isFrameFormat() const

Returns true if this text format is aFrameFormat; otherwise returns false.

bool QTextFormat::isImageFormat() const

Returns true if this text format is an image format; otherwise returns false.

bool QTextFormat::isListFormat() const

Returns true if this text format is aListFormat; otherwise returns false.

bool QTextFormat::isTableCellFormat() const

Returns true if this text format is aTableCellFormat; otherwise returns false.

This function was introduced in Qt 4.4.

bool QTextFormat::isTableFormat() const

Returns true if this text format is aTableFormat; otherwise returns false.

bool QTextFormat::isValid() const

Returns true if the format is valid (i.e. is notInvalidFormat); otherwise returns false.

Qt::LayoutDirection QTextFormat::layoutDirection() const

Returns the document's layout direction.

See alsosetLayoutDirection().

QTextLength QTextFormat::lengthProperty(int propertyId) const

Returns the value of the property given bypropertyId.

See alsosetProperty(),boolProperty(),intProperty(),doubleProperty(),stringProperty(),colorProperty(),lengthVectorProperty(), andProperty.

QVector<QTextLength> QTextFormat::lengthVectorProperty(int propertyId) const

Returns the value of the property given bypropertyId. If the property isn't of QTextFormat::LengthVector type, an empty length vector is returned instead.

See alsosetProperty(),boolProperty(),intProperty(),doubleProperty(),stringProperty(),colorProperty(),lengthProperty(), andProperty.

void QTextFormat::merge(constQTextFormat & other)

Merges theother format with this format; where there are conflicts theother format takes precedence.

int QTextFormat::objectIndex() const

Returns the index of the format object, or -1 if the format object is invalid.

See alsosetObjectIndex().

int QTextFormat::objectType() const

Returns the text format's object type.

See alsoObjectTypes andsetObjectType().

QPen QTextFormat::penProperty(int propertyId) const

Returns the value of the property given bypropertyId; if the property isn't ofQVariant::Pen type,Qt::NoPen is returned instead.

See alsosetProperty(),boolProperty(),intProperty(),doubleProperty(),stringProperty(),lengthProperty(),lengthVectorProperty(), andProperty.

QMap<int,QVariant> QTextFormat::properties() const

Returns a map with all properties of this text format.

QVariant QTextFormat::property(int propertyId) const

Returns the property specified by the givenpropertyId.

See alsosetProperty() andProperty.

int QTextFormat::propertyCount() const

Returns the number of properties stored in the format.

This function was introduced in Qt 4.3.

void QTextFormat::setBackground(constQBrush & brush)

Sets the brush use to paint the document's background to thebrush specified.

See alsobackground(),clearBackground(), andsetForeground().

void QTextFormat::setForeground(constQBrush & brush)

Sets the foreground brush to the specifiedbrush. The foreground brush is mostly used to render text.

See alsoforeground(),clearForeground(), andsetBackground().

void QTextFormat::setLayoutDirection(Qt::LayoutDirection direction)

Sets the document's layout direction to the specifieddirection.

See alsolayoutDirection().

void QTextFormat::setObjectIndex(int index)

Sets the format object's objectindex.

See alsoobjectIndex().

void QTextFormat::setObjectType(int type)

Sets the text format's object type totype.

See alsoObjectTypes andobjectType().

void QTextFormat::setProperty(int propertyId, constQVariant & value)

Sets the property specified by thepropertyId to the givenvalue.

See alsoproperty() andProperty.

void QTextFormat::setProperty(int propertyId, constQVector<QTextLength> & value)

Sets the value of the property given bypropertyId tovalue.

See alsolengthVectorProperty() andProperty.

QString QTextFormat::stringProperty(int propertyId) const

Returns the value of the property given bypropertyId; if the property isn't ofQVariant::String type, an empty string is returned instead.

See alsosetProperty(),boolProperty(),intProperty(),doubleProperty(),colorProperty(),lengthProperty(),lengthVectorProperty(), andProperty.

QTextBlockFormat QTextFormat::toBlockFormat() const

Returns this format as a block format.

QTextCharFormat QTextFormat::toCharFormat() const

Returns this format as a character format.

QTextFrameFormat QTextFormat::toFrameFormat() const

Returns this format as a frame format.

QTextImageFormat QTextFormat::toImageFormat() const

Returns this format as an image format.

QTextListFormat QTextFormat::toListFormat() const

Returns this format as a list format.

QTextTableCellFormat QTextFormat::toTableCellFormat() const

Returns this format as a table cell format.

This function was introduced in Qt 4.4.

QTextTableFormat QTextFormat::toTableFormat() const

Returns this format as a table format.

int QTextFormat::type() const

Returns the type of this format.

See alsoFormatType.

QTextFormat::operator QVariant() const

Returns the text format as aQVariant

bool QTextFormat::operator!=(constQTextFormat & other) const

Returns true if this text format is different from theother text format.

QTextFormat & QTextFormat::operator=(constQTextFormat & other)

Assigns theother text format to this text format, and returns a reference to this text format.

bool QTextFormat::operator==(constQTextFormat & other) const

Returns true if this text format is the same as theother text format.