Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |
The QTextFormat class provides formatting information for a QTextDocument. More...
#include <QTextFormat>
Inherited by QTextBlockFormat, QTextCharFormat, QTextFrameFormat, and QTextListFormat.
The QTextFormat class provides formatting information for a QTextDocument.
A QTextFormat is a generic class used for describing the format of parts of a QTextDocument. The derived classes QTextCharFormat, QTextBlockFormat, QTextListFormat, and QTextTableFormat are usually more useful, and describe the formatting that is applied to specific parts of the document.
A format has a FormatType which specifies the kinds of thing 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 by type(), and the format can be tested with isCharFormat(), isBlockFormat(), isListFormat(), isTableFormat(), isFrameFormat(), and isImageFormat(). If the type is determined, it can be retrieved with toCharFormat(), toBlockFormat(), toListFormat(), toTableFormat(), toFrameFormat(), and toImageFormat().
A format's properties can be set with the setProperty() functions, and retrieved with boolProperty(), intProperty(), doubleProperty(), and stringProperty() as appropriate. All the property IDs used in the format can be retrieved with allPropertyIds(). One format can be merged into another using merge().
A format's object index can be set with setObjectIndex(), and retrieved with objectIndex(). These methods can be used to associate the format with a QTextObject. It is used to represent lists, frames, and tables inside the document.
See also Text Related Classes.
Constant | Value |
---|---|
QTextFormat::InvalidFormat | -1 |
QTextFormat::BlockFormat | 1 |
QTextFormat::CharFormat | 2 |
QTextFormat::ListFormat | 3 |
QTextFormat::TableFormat | 4 |
QTextFormat::FrameFormat | 5 |
QTextFormat::UserFormat | 100 |
Constant | Value |
---|---|
QTextFormat::NoObject | 0 |
QTextFormat::ImageObject | 1 |
QTextFormat::TableObject | 2 |
Constant | Value |
---|---|
QTextFormat::ObjectIndex | 0x0 |
Paragraph and character properties
Constant | Value | Description |
---|---|---|
QTextFormat::CssFloat | 0x0800 | |
QTextFormat::LayoutDirection | 0x0801 | The layout direction of the text in the document (Qt::LayoutDirection). |
QTextFormat::OutlinePen | 0x810 | |
QTextFormat::ForegroundBrush | 0x821 | |
QTextFormat::BackgroundBrush | 0x820 |
Paragraph properties
Constant | Value |
---|---|
QTextFormat::BlockAlignment | 0x1010 |
QTextFormat::BlockTopMargin | 0x1030 |
QTextFormat::BlockBottomMargin | 0x1031 |
QTextFormat::BlockLeftMargin | 0x1032 |
QTextFormat::BlockRightMargin | 0x1033 |
QTextFormat::TextIndent | 0x1034 |
QTextFormat::BlockIndent | 0x1040 |
QTextFormat::BlockNonBreakableLines | 0x1050 |
QTextFormat::BlockTrailingHorizontalRulerWidth | 0x1060 |
Character properties
Constant | Value |
---|---|
QTextFormat::FontFamily | 0x2000 |
QTextFormat::FontPointSize | 0x2001 |
QTextFormat::FontSizeAdjustment | 0x2002 |
QTextFormat::FontWeight | 0x2003 |
QTextFormat::FontItalic | 0x2004 |
QTextFormat::FontUnderline | 0x2005 |
QTextFormat::FontOverline | 0x2006 |
QTextFormat::FontStrikeOut | 0x2007 |
QTextFormat::FontFixedPitch | 0x2008 |
QTextFormat::TextUnderlineColor | 0x2010 |
QTextFormat::TextVerticalAlignment | 0x2021 |
QTextFormat::IsAnchor | 0x2030 |
QTextFormat::AnchorHref | 0x2031 |
QTextFormat::AnchorName | 0x2032 |
QTextFormat::ObjectType | 0x2f00 |
List properties
Constant | Value |
---|---|
QTextFormat::ListStyle | 0x3000 |
QTextFormat::ListIndent | 0x3001 |
Table and frame properties
Constant | Value |
---|---|
QTextFormat::TableColumns | 0x4100 |
QTextFormat::FrameBorder | 0x4000 |
QTextFormat::FrameMargin | 0x4001 |
QTextFormat::FramePadding | 0x4002 |
QTextFormat::FrameWidth | 0x4003 |
QTextFormat::FrameHeight | 0x4004 |
QTextFormat::TableColumnWidthConstraints | 0x4101 |
QTextFormat::TableCellSpacing | 0x4102 |
QTextFormat::TableCellPadding | 0x4103 |
Table cell properties
Constant | Value |
---|---|
QTextFormat::TableCellRowSpan | 0x4810 |
QTextFormat::TableCellColumnSpan | 0x4811 |
Image properties
Constant | Value |
---|---|
QTextFormat::ImageName | 0x5000 |
QTextFormat::ImageWidth | 0x5010 |
QTextFormat::ImageHeight | 0x5011 |
QTextFormat::UserProperty | 0x100000 |
Creates a new text format with an InvalidFormat.
See also FormatType.
Creates a new text format of the given type.
See also FormatType.
Creates a new text format with the same attributes at the other text format.
Destroys this text format.
Returns the brush used to paint the document's background.
See also setBackground(), clearBackground(), and foreground().
Returns the value of the property specified by propertyId. If the property isn't of QTextFormat::Bool type, false is returned instead.
See also setProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(), lengthProperty(), lengthVectorProperty(), and Property.
Returns the value of the property given by propertyId; if the property isn't of QVariant::Brush type, Qt::NoBrush is returned instead.
See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), lengthProperty(), lengthVectorProperty(), and Property.
Clears the brush used to paint the document's background. The default brush will be used.
See also background(), setBackground(), and clearForeground().
Clears the brush used to paint the document's foreground. The default brush will be used.
See also foreground(), setForeground(), and clearBackground().
Clears the value of the property given by propertyId
Returns the value of the property given by propertyId; if the property isn't of QVariant::Color type, an invalid color is returned instead.
See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), lengthProperty(), lengthVectorProperty(), and Property.
Returns the value of the property specified by propertyId. If the property isn't of QVariant::Double type, 0 is returned instead.
See also setProperty(), boolProperty(), intProperty(), stringProperty(), colorProperty(), lengthProperty(), lengthVectorProperty(), and Property.
Returns the brush used to render foreground details, such as text, frame outlines, and table borders.
See also setForeground(), clearForeground(), and background().
Returns true if the text format has a property with the given propertyId; otherwise returns false.
See also properties() and Property.
Returns the value of the property specified by propertyId. If the property is not of QTextFormat::Integer type, 0 is returned instead.
See also setProperty(), boolProperty(), doubleProperty(), stringProperty(), colorProperty(), lengthProperty(), lengthVectorProperty(), and Property.
Returns true if this text format is a BlockFormat; otherwise returns false.
Returns true if this text format is a CharFormat; otherwise returns false.
Returns true if this text format is a FrameFormat; otherwise returns false.
Returns true if this text format is an image format; otherwise returns false.
Returns true if this text format is a ListFormat; otherwise returns false.
Returns true if this text format is a TableFormat; otherwise returns false.
Returns true if the format is valid (i.e. is not InvalidFormat); otherwise returns false.
Returns the document's layout direction.
See also setLayoutDirection().
Returns the value of the property given by propertyId.
See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(), lengthVectorProperty(), and Property.
Returns the value of the property given by propertyId. If the property isn't of QTextFormat::LengthVector type, an empty length vector is returned instead.
See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(), lengthProperty(), and Property.
Merges the other format with this format; where there are conflicts the other format takes precedence.
Returns the index of the format object, or -1 if the format object is invalid.
See also setObjectIndex().
Returns the text format's object type. See ObjectTypes.
See also setObjectType().
Returns the value of the property given by propertyId; if the property isn't of QVariant::Pen type, Qt::NoPen is returned instead.
See also setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(), lengthProperty(), lengthVectorProperty(), and Property.
Returns a map with all properties of this text format.
Returns the property specified by the given propertyId.
See also setProperty().
Sets the brush use to paint the document's background to the brush specified.
See also background(), clearBackground(), and setForeground().
Sets the foreground brush to the specified brush. The foreground brush is mostly used to render text.
See also foreground(), clearForeground(), and setBackground().
Sets the document's layout direction to the specified direction.
See also layoutDirection().
Sets the format object's object index.
See also objectIndex().
Sets the text format's object type. See ObjectTypes.
See also objectType().
Sets the property specified by the propertyId to the given value.
See also property().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Sets the value of the property given by propertyId to value.
See also lengthVectorProperty() and Property.
Returns the value of the property given by propertyId; if the property isn't of QVariant::String type, an empty string is returned instead.
See also setProperty(), boolProperty(), intProperty(), doubleProperty(), colorProperty(), lengthProperty(), lengthVectorProperty(), and Property.
Returns this format as a block format.
Returns this format as a character format.
Returns this format as a frame format.
Returns this format as an image format.
Returns this format as a list format.
Returns this format as a table format.
Returns the type of this format.
See also ObjectTypes.
Returns the text format as a QVariant
Returns true if this text format is different from the other text format.
Assigns the other text format to this text format, and returns a reference to this text format.
Returns true if this text format is the same as the other text format.
Copyright © 2005 Trolltech | Trademarks | Qt 4.1.0 |