QTextFrameFormat Class Reference

\reentrant More...

#include <qtextformat.h>

Inheritance diagram for QTextFrameFormat:

Collaboration diagram for QTextFrameFormat:

Public Types
enum	Position { InFlow , FloatLeft , FloatRight }
	This enum describes how a frame is located relative to the surrounding text. More...
enum	BorderStyle {   BorderStyle_None , BorderStyle_Dotted , BorderStyle_Dashed , BorderStyle_Solid ,   BorderStyle_Double , BorderStyle_DotDash , BorderStyle_DotDotDash , BorderStyle_Groove ,   BorderStyle_Ridge , BorderStyle_Inset , BorderStyle_Outset }
Public Types inherited from QTextFormat
enum	FormatType {   InvalidFormat = -1 , BlockFormat = 1 , CharFormat = 2 , ListFormat = 3 ,   FrameFormat = 5 , UserFormat = 100 }
	This enum describes the text item a QTextFormat object is formatting. More...
enum	Property {   ObjectIndex = 0x0 , CssFloat = 0x0800 , LayoutDirection = 0x0801 , OutlinePen = 0x810 ,   BackgroundBrush = 0x820 , ForegroundBrush = 0x821 , BackgroundImageUrl = 0x823 , BlockAlignment = 0x1010 ,   BlockTopMargin = 0x1030 , BlockBottomMargin = 0x1031 , BlockLeftMargin = 0x1032 , BlockRightMargin = 0x1033 ,   TextIndent = 0x1034 , TabPositions = 0x1035 , BlockIndent = 0x1040 , LineHeight = 0x1048 ,   LineHeightType = 0x1049 , BlockNonBreakableLines = 0x1050 , BlockTrailingHorizontalRulerWidth = 0x1060 , HeadingLevel = 0x1070 ,   BlockQuoteLevel = 0x1080 , BlockCodeLanguage = 0x1090 , BlockCodeFence = 0x1091 , BlockMarker = 0x10A0 ,   FirstFontProperty = 0x1FE0 , FontCapitalization = FirstFontProperty , FontLetterSpacing = 0x1FE1 , FontWordSpacing = 0x1FE2 ,   FontStyleHint = 0x1FE3 , FontStyleStrategy = 0x1FE4 , FontKerning = 0x1FE5 , FontHintingPreference = 0x1FE6 ,   FontFamilies = 0x1FE7 , FontStyleName = 0x1FE8 , FontLetterSpacingType = 0x1FE9 , FontStretch = 0x1FEA ,   FontPointSize = 0x2001 , FontSizeAdjustment = 0x2002 , FontSizeIncrement = FontSizeAdjustment , FontWeight = 0x2003 ,   FontItalic = 0x2004 , FontUnderline = 0x2005 , FontOverline = 0x2006 , FontStrikeOut = 0x2007 ,   FontFixedPitch = 0x2008 , FontPixelSize = 0x2009 , LastFontProperty = FontPixelSize , TextUnderlineColor = 0x2020 ,   TextVerticalAlignment = 0x2021 , TextOutline = 0x2022 , TextUnderlineStyle = 0x2023 , TextToolTip = 0x2024 ,   TextSuperScriptBaseline = 0x2025 , TextSubScriptBaseline = 0x2026 , TextBaselineOffset = 0x2027 , IsAnchor = 0x2030 ,   AnchorHref = 0x2031 , AnchorName = 0x2032 , OldFontLetterSpacingType = 0x2033 , OldFontStretch = 0x2034 ,   OldTextUnderlineColor = 0x2010 , OldFontFamily = 0x2000 , ObjectType = 0x2f00 , ListStyle = 0x3000 ,   ListIndent = 0x3001 , ListNumberPrefix = 0x3002 , ListNumberSuffix = 0x3003 , ListStart = 0x3004 ,   FrameBorder = 0x4000 , FrameMargin = 0x4001 , FramePadding = 0x4002 , FrameWidth = 0x4003 ,   FrameHeight = 0x4004 , FrameTopMargin = 0x4005 , FrameBottomMargin = 0x4006 , FrameLeftMargin = 0x4007 ,   FrameRightMargin = 0x4008 , FrameBorderBrush = 0x4009 , FrameBorderStyle = 0x4010 , TableColumns = 0x4100 ,   TableColumnWidthConstraints = 0x4101 , TableCellSpacing = 0x4102 , TableCellPadding = 0x4103 , TableHeaderRowCount = 0x4104 ,   TableBorderCollapse = 0x4105 , TableCellRowSpan = 0x4810 , TableCellColumnSpan = 0x4811 , TableCellTopPadding = 0x4812 ,   TableCellBottomPadding = 0x4813 , TableCellLeftPadding = 0x4814 , TableCellRightPadding = 0x4815 , TableCellTopBorder = 0x4816 ,   TableCellBottomBorder = 0x4817 , TableCellLeftBorder = 0x4818 , TableCellRightBorder = 0x4819 , TableCellTopBorderStyle = 0x481a ,   TableCellBottomBorderStyle = 0x481b , TableCellLeftBorderStyle = 0x481c , TableCellRightBorderStyle = 0x481d , TableCellTopBorderBrush = 0x481e ,   TableCellBottomBorderBrush = 0x481f , TableCellLeftBorderBrush = 0x4820 , TableCellRightBorderBrush = 0x4821 , ImageName = 0x5000 ,   ImageTitle = 0x5001 , ImageAltText = 0x5002 , ImageWidth = 0x5010 , ImageHeight = 0x5011 ,   ImageQuality = 0x5014 , ImageMaxWidth = 0x5015 , FullWidthSelection = 0x06000 , PageBreakPolicy = 0x7000 ,   UserProperty = 0x100000 }
	This enum describes the different properties a format can have. More...
enum	ObjectTypes {   NoObject , ImageObject , TableObject , TableCellObject ,   UserObject = 0x1000 }
	This enum describes what kind of QTextObject this format is associated with. More...
enum	PageBreakFlag { PageBreak_Auto = 0 , PageBreak_AlwaysBefore = 0x001 , PageBreak_AlwaysAfter = 0x010 }

Public Member Functions
	QTextFrameFormat ()
	Constructs a text frame format object with the default properties.
bool	isValid () const
	Returns true if the format description is valid; otherwise returns false.
void	setPosition (Position f)
	Sets the policy for positioning frames with this frame format.
Position	position () const
	Returns the positioning policy for frames with this frame format.
void	setBorder (qreal border)
	Sets the width (in pixels) of the frame's border.
qreal	border () const
	Returns the width of the border in pixels.
void	setBorderBrush (const QBrush &brush)
QBrush	borderBrush () const
void	setBorderStyle (BorderStyle style)
BorderStyle	borderStyle () const
void	setMargin (qreal margin)
	Sets the frame's margin in pixels.
qreal	margin () const
	Returns the width of the frame's external margin in pixels.
void	setTopMargin (qreal margin)
qreal	topMargin () const
void	setBottomMargin (qreal margin)
qreal	bottomMargin () const
void	setLeftMargin (qreal margin)
qreal	leftMargin () const
void	setRightMargin (qreal margin)
qreal	rightMargin () const
void	setPadding (qreal padding)
	Sets the width of the frame's internal padding in pixels.
qreal	padding () const
	Returns the width of the frame's internal padding in pixels.
void	setWidth (qreal width)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Convenience method that sets the width of the frame's border rectangle's width to the specified fixed width.
void	setWidth (const QTextLength &length)
	Sets the frame's border rectangle's width.
QTextLength	width () const
	Returns the width of the frame's border rectangle.
void	setHeight (qreal height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the frame's height.
void	setHeight (const QTextLength &height)
	Sets the frame's height.
QTextLength	height () const
	Returns the height of the frame's border rectangle.
void	setPageBreakPolicy (PageBreakFlags flags)
PageBreakFlags	pageBreakPolicy () const
Public Member Functions inherited from QTextFormat
	QTextFormat ()
	Creates a new text format with an InvalidFormat.
	QTextFormat (int type)
	Creates a new text format of the given type.
	QTextFormat (const QTextFormat &rhs)
	Creates a new text format with the same attributes as the other text format.
QTextFormat &	operator= (const QTextFormat &rhs)
	Assigns the other text format to this text format, and returns a reference to this text format.
	~QTextFormat ()
	Destroys this text format.
void	swap (QTextFormat &other)
void	merge (const QTextFormat &other)
	Merges the other format with this format; where there are conflicts the other format takes precedence.
bool	isValid () const
	Returns true if the format is valid (i.e.
bool	isEmpty () const
int	type () const
	Returns the type of this format.
int	objectIndex () const
	Returns the index of the format object, or -1 if the format object is invalid.
void	setObjectIndex (int object)
	Sets the format object's object index.
QVariant	property (int propertyId) const
	Returns the property specified by the given propertyId.
void	setProperty (int propertyId, const QVariant &value)
	Sets the property specified by the propertyId to the given value.
void	clearProperty (int propertyId)
	Clears the value of the property given by propertyId.
bool	hasProperty (int propertyId) const
	Returns true if the text format has a property with the given propertyId; otherwise returns false.
bool	boolProperty (int propertyId) const
	Returns the value of the property specified by propertyId.
int	intProperty (int propertyId) const
	Returns the value of the property specified by propertyId.
qreal	doubleProperty (int propertyId) const
	Returns the value of the property specified by propertyId.
QString	stringProperty (int propertyId) const
	Returns the value of the property given by propertyId; if the property isn't of QMetaType::QString type, an empty string is returned instead.
QColor	colorProperty (int propertyId) const
	Returns the value of the property given by propertyId; if the property isn't of QMetaType::QColor type, an invalid color is returned instead.
QPen	penProperty (int propertyId) const
	Returns the value of the property given by propertyId; if the property isn't of QMetaType::QPen type, Qt::NoPen is returned instead.
QBrush	brushProperty (int propertyId) const
	Returns the value of the property given by propertyId; if the property isn't of QMetaType::QBrush type, Qt::NoBrush is returned instead.
QTextLength	lengthProperty (int propertyId) const
	Returns the value of the property given by propertyId.
QList< QTextLength >	lengthVectorProperty (int propertyId) const
	Returns the value of the property given by propertyId.
void	setProperty (int propertyId, const QList< QTextLength > &lengths)
	Sets the value of the property given by propertyId to value.
QMap< int, QVariant >	properties () const
	Returns a map with all properties of this text format.
int	propertyCount () const
void	setObjectType (int type)
	Sets the text format's object type to type.
int	objectType () const
	Returns the text format's object type.
bool	isCharFormat () const
	Returns true if this text format is a CharFormat; otherwise returns false.
bool	isBlockFormat () const
	Returns true if this text format is a BlockFormat; otherwise returns false.
bool	isListFormat () const
	Returns true if this text format is a ListFormat; otherwise returns false.
bool	isFrameFormat () const
	Returns true if this text format is a FrameFormat; otherwise returns false.
bool	isImageFormat () const
	Returns true if this text format is an image format; otherwise returns false.
bool	isTableFormat () const
	Returns true if this text format is a TableFormat; otherwise returns false.
bool	isTableCellFormat () const
QTextBlockFormat	toBlockFormat () const
	Returns this format as a block format.
QTextCharFormat	toCharFormat () const
	Returns this format as a character format.
QTextListFormat	toListFormat () const
	Returns this format as a list format.
QTextTableFormat	toTableFormat () const
	Returns this format as a table format.
QTextFrameFormat	toFrameFormat () const
	Returns this format as a frame format.
QTextImageFormat	toImageFormat () const
	Returns this format as an image format.
QTextTableCellFormat	toTableCellFormat () const
bool	operator== (const QTextFormat &rhs) const
	Returns true if this text format is the same as the other text format.
bool	operator!= (const QTextFormat &rhs) const
	Returns true if this text format is different from the other text format.
	operator QVariant () const
	Returns the text format as a QVariant.
void	setLayoutDirection (Qt::LayoutDirection direction)
	Sets the document's layout direction to the specified direction.
Qt::LayoutDirection	layoutDirection () const
	Returns the document's layout direction.
void	setBackground (const QBrush &brush)
	Sets the brush use to paint the document's background to the brush specified.
QBrush	background () const
	Returns the brush used to paint the document's background.
void	clearBackground ()
	Clears the brush used to paint the document's background.
void	setForeground (const QBrush &brush)
	Sets the foreground brush to the specified brush.
QBrush	foreground () const
	Returns the brush used to render foreground details, such as text, frame outlines, and table borders.
void	clearForeground ()
	Clears the brush used to paint the document's foreground.

Protected Member Functions
	QTextFrameFormat (const QTextFormat &fmt)

Friends
class	QTextFormat
Q_GUI_EXPORT QDataStream &	operator<< (QDataStream &stream, const QTextFrameFormat &fmt)
Q_GUI_EXPORT QDataStream &	operator>> (QDataStream &stream, QTextFrameFormat &fmt)

Detailed Description

\reentrant

The QTextFrameFormat class provides formatting information for frames in a QTextDocument. \inmodule QtGui

A text frame groups together one or more blocks of text, providing a layer of structure larger than the paragraph. The format of a frame specifies how it is rendered and positioned on the screen. It does not directly specify the behavior of the text formatting within, but provides constraints on the layout of its children.

The frame format defines the width() and height() of the frame on the screen. Each frame can have a border() that surrounds its contents with a rectangular box. The border is surrounded by a margin() around the frame, and the contents of the frame are kept separate from the border by the frame's padding(). This scheme is similar to the box model used by Cascading Style Sheets for HTML pages.

The position() of a frame is set using setPosition() and determines how it is located relative to the surrounding text.

The validity of a QTextFrameFormat object can be determined with the isValid() function.

See also

QTextFrame, QTextBlockFormat

Definition at line 840 of file qtextformat.h.

Member Enumeration Documentation

BorderStyle

enum QTextFrameFormat::BorderStyle

Since

4.3

This enum describes different border styles for the text frame.

\value BorderStyle_None \value BorderStyle_Dotted \value BorderStyle_Dashed \value BorderStyle_Solid \value BorderStyle_Double \value BorderStyle_DotDash \value BorderStyle_DotDotDash \value BorderStyle_Groove \value BorderStyle_Ridge \value BorderStyle_Inset \value BorderStyle_Outset

See also

borderStyle(), FrameBorderStyle

Enumerator
BorderStyle_None
BorderStyle_Dotted
BorderStyle_Dashed
BorderStyle_Solid
BorderStyle_Double
BorderStyle_DotDash
BorderStyle_DotDotDash
BorderStyle_Groove
BorderStyle_Ridge
BorderStyle_Inset
BorderStyle_Outset

Definition at line 855 of file qtextformat.h.

Position

enum QTextFrameFormat::Position

This enum describes how a frame is located relative to the surrounding text.

\value InFlow \value FloatLeft \value FloatRight

See also

position(), CssFloat

Enumerator
InFlow
FloatLeft
FloatRight

Definition at line 847 of file qtextformat.h.

Constructor & Destructor Documentation

QTextFrameFormat() [1/2]

QTextFrameFormat::QTextFrameFormat

(

)

Constructs a text frame format object with the default properties.

Definition at line 2849 of file qtextformat.cpp.

QTextFrameFormat() [2/2]

QTextFrameFormat::QTextFrameFormat ( const QTextFormat & other )

explicitprotected

Creates a new frame format with the same attributes as the given text format.

Definition at line 2862 of file qtextformat.cpp.

Member Function Documentation

border()

qreal QTextFrameFormat::border ( ) const

inline

Returns the width of the border in pixels.

Definition at line 875 of file qtextformat.h.

borderBrush()

QBrush QTextFrameFormat::borderBrush ( ) const

inline

Since

4.3

Returns the brush used for the frame's border.

Definition at line 880 of file qtextformat.h.

borderStyle()

BorderStyle QTextFrameFormat::borderStyle ( ) const

inline

Since

4.3

Returns the style of the frame's border.

Definition at line 885 of file qtextformat.h.

bottomMargin()

qreal QTextFrameFormat::bottomMargin

(

)

const

Since

4.3

Returns the width of the frame's bottom margin in pixels.

Definition at line 2983 of file qtextformat.cpp.

height()

QTextLength QTextFrameFormat::height ( ) const

inline

Returns the height of the frame's border rectangle.

Definition at line 916 of file qtextformat.h.

isValid()

bool QTextFrameFormat::isValid ( ) const

inline

Returns true if the format description is valid; otherwise returns false.

Definition at line 845 of file qtextformat.h.

leftMargin()

qreal QTextFrameFormat::leftMargin

(

)

const

Since

4.3

Returns the width of the frame's left margin in pixels.

Definition at line 3003 of file qtextformat.cpp.

margin()

qreal QTextFrameFormat::margin ( ) const

inline

Returns the width of the frame's external margin in pixels.

Definition at line 889 of file qtextformat.h.

padding()

qreal QTextFrameFormat::padding ( ) const

inline

Returns the width of the frame's internal padding in pixels.

Definition at line 905 of file qtextformat.h.

pageBreakPolicy()

PageBreakFlags QTextFrameFormat::pageBreakPolicy ( ) const

inline

Since

4.2

Returns the currently set page break policy for the frame/table. The default is QTextFormat::PageBreak_Auto.

See also

setPageBreakPolicy()

Definition at line 921 of file qtextformat.h.

position()

Position QTextFrameFormat::position ( ) const

inline

Returns the positioning policy for frames with this frame format.

Definition at line 871 of file qtextformat.h.

rightMargin()

qreal QTextFrameFormat::rightMargin

(

)

const

Since

4.3

Returns the width of the frame's right margin in pixels.

Definition at line 3023 of file qtextformat.cpp.

setBorder()

void QTextFrameFormat::setBorder ( qreal border )

inline

Sets the width (in pixels) of the frame's border.

Definition at line 933 of file qtextformat.h.

setBorderBrush()

void QTextFrameFormat::setBorderBrush ( const QBrush & brush )

inline

Since

4.3

Sets the brush used for the frame's border.

Definition at line 878 of file qtextformat.h.

setBorderStyle()

void QTextFrameFormat::setBorderStyle ( BorderStyle style )

inline

Since

4.3

Sets the style of the frame's border.

Definition at line 883 of file qtextformat.h.

setBottomMargin()

void QTextFrameFormat::setBottomMargin ( qreal margin )

inline

Since

4.3

Sets the frame's bottom margin in pixels.

Definition at line 950 of file qtextformat.h.

setHeight() [1/2]

void QTextFrameFormat::setHeight ( const QTextLength & height )

inline

Sets the frame's height.

Definition at line 944 of file qtextformat.h.

setHeight() [2/2]

void QTextFrameFormat::setHeight ( qreal height )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the frame's height.

Definition at line 942 of file qtextformat.h.

setLeftMargin()

void QTextFrameFormat::setLeftMargin ( qreal margin )

inline

Since

4.3

Sets the frame's left margin in pixels.

Definition at line 953 of file qtextformat.h.

setMargin()

void QTextFrameFormat::setMargin

(

qreal

margin

)

Sets the frame's margin in pixels.

This method also sets the left, right, top and bottom margins of the frame to the same value. The individual margins override the general margin.

Definition at line 2934 of file qtextformat.cpp.

setPadding()

void QTextFrameFormat::setPadding ( qreal padding )

inline

Sets the width of the frame's internal padding in pixels.

Definition at line 936 of file qtextformat.h.

setPageBreakPolicy()

void QTextFrameFormat::setPageBreakPolicy ( PageBreakFlags policy )

inline

Since

4.2

Sets the page break policy for the frame/table to policy.

See also

pageBreakPolicy()

Definition at line 919 of file qtextformat.h.

setPosition()

void QTextFrameFormat::setPosition ( Position f )

inline

Sets the policy for positioning frames with this frame format.

Definition at line 869 of file qtextformat.h.

setRightMargin()

void QTextFrameFormat::setRightMargin ( qreal margin )

inline

Since

4.3

Sets the frame's right margin in pixels.

Definition at line 956 of file qtextformat.h.

setTopMargin()

void QTextFrameFormat::setTopMargin ( qreal margin )

inline

Since

4.3

Sets the frame's top margin in pixels.

Definition at line 947 of file qtextformat.h.

setWidth() [1/2]

void QTextFrameFormat::setWidth ( const QTextLength & width )

inline

Sets the frame's border rectangle's width.

See also

QTextLength

Definition at line 909 of file qtextformat.h.

setWidth() [2/2]

void QTextFrameFormat::setWidth ( qreal width )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Convenience method that sets the width of the frame's border rectangle's width to the specified fixed width.

Definition at line 939 of file qtextformat.h.

topMargin()

qreal QTextFrameFormat::topMargin

(

)

const

Since

4.3

Returns the width of the frame's top margin in pixels.

Definition at line 2963 of file qtextformat.cpp.

width()

QTextLength QTextFrameFormat::width ( ) const

inline

Returns the width of the frame's border rectangle.

See also

QTextLength

Definition at line 911 of file qtextformat.h.

Friends And Related Symbol Documentation

operator<<

Q_GUI_EXPORT QDataStream & operator<< ( QDataStream & stream, const QTextFrameFormat & fmt )

friend

Definition at line 494 of file qtextformat.cpp.

operator>>

Q_GUI_EXPORT QDataStream & operator>> ( QDataStream & stream, QTextFrameFormat & fmt )

friend

Definition at line 499 of file qtextformat.cpp.

QTextFormat

friend class QTextFormat

friend

Definition at line 926 of file qtextformat.h.

---

The documentation for this class was generated from the following files:

• qtbase/src/gui/text/qtextformat.h (ab2f4ef8fad82fd07dac8768b8dcb94b11b271b6)
• qtbase/src/gui/text/qtextformat.cpp (5627e113793df3df24742d7af502a075c2c9e95d)