The QTextFrameFormat class provides formatting information for frames in a QTextDocument. More...

Inheritance diagram for QtGui.QTextFrameFormat:

Collaboration diagram for QtGui.QTextFrameFormat:

Public Types
enum	BorderStyle { BorderStyle_Dashed = 2, BorderStyle_DotDash = 5, BorderStyle_DotDotDash = 6, BorderStyle_Dotted = 1, BorderStyle_Double = 4, BorderStyle_Groove = 7, BorderStyle_Inset = 9, BorderStyle_None = 0, BorderStyle_Outset = 10, BorderStyle_Ridge = 8, BorderStyle_Solid = 3 }
	More...

enum	Position { FloatLeft = 1, FloatRight = 2, InFlow = 0 }
	More...

Public Types inherited from QtGui.QTextFormat
enum	FormatType { BlockFormat = 1, CharFormat = 2, FrameFormat = 5, InvalidFormat = -1, ListFormat = 3, TableFormat = 4, UserFormat = 100 }
	More...

enum	ObjectTypes { ImageObject = 1, NoObject = 0, TableCellObject = 3, TableObject = 2, UserObject = 4096 }
	More...

enum	PageBreakFlag { PageBreak_AlwaysAfter = 16, PageBreak_AlwaysBefore = 1, PageBreak_Auto = 0 }
	More...

enum	Property { AnchorHref = 8241, AnchorName = 8242, BackgroundBrush = 2080, BackgroundImageUrl = 2083, BlockAlignment = 4112, BlockBottomMargin = 4145, BlockIndent = 4160, BlockLeftMargin = 4146, BlockNonBreakableLines = 4176, BlockRightMargin = 4147, BlockTopMargin = 4144, BlockTrailingHorizontalRulerWidth = 4192, CssFloat = 2048, FirstFontProperty = 8160, FontCapitalization = 8160, FontFamily = 8192, FontFixedPitch = 8200, FontHintingPreference = 8166, FontItalic = 8196, FontKerning = 8165, FontLetterSpacing = 8161, FontOverline = 8198, FontPixelSize = 8201, FontPointSize = 8193, FontSizeAdjustment = 8194, FontSizeIncrement = 8194, FontStrikeOut = 8199, FontStyleHint = 8163, FontStyleStrategy = 8164, FontUnderline = 8197, FontWeight = 8195, FontWordSpacing = 8162, ForegroundBrush = 2081, FrameBorder = 16384, FrameBorderBrush = 16393, FrameBorderStyle = 16400, FrameBottomMargin = 16390, FrameHeight = 16388, FrameLeftMargin = 16391, FrameMargin = 16385, FramePadding = 16386, FrameRightMargin = 16392, FrameTopMargin = 16389, FrameWidth = 16387, FullWidthSelection = 24576, ImageHeight = 20497, ImageName = 20480, ImageWidth = 20496, IsAnchor = 8240, LastFontProperty = 8201, LayoutDirection = 2049, LineHeight = 4168, LineHeightType = 4169, ListIndent = 12289, ListNumberPrefix = 12290, ListNumberSuffix = 12291, ListStyle = 12288, ObjectIndex = 0, ObjectType = 12032, OutlinePen = 2064, PageBreakPolicy = 28672, TabPositions = 4149, TableCellBottomPadding = 18451, TableCellColumnSpan = 18449, TableCellLeftPadding = 18452, TableCellPadding = 16643, TableCellRightPadding = 18453, TableCellRowSpan = 18448, TableCellSpacing = 16642, TableCellTopPadding = 18450, TableColumnWidthConstraints = 16641, TableColumns = 16640, TableHeaderRowCount = 16644, TextIndent = 4148, TextOutline = 8226, TextToolTip = 8228, TextUnderlineColor = 8208, TextUnderlineStyle = 8227, TextVerticalAlignment = 8225, UserProperty = 1048576 }
	More...

Public Member Functions
	QTextFrameFormat ()


	QTextFrameFormat (QTextFrameFormat copy)


override void	CreateProxy ()

new bool	IsValid ()


new void	SetHeight (double height)


new void	SetWidth (double width)


new void	Dispose ()

Public Member Functions inherited from QtGui.QTextFormat
override bool	Equals (object o)

override int	GetHashCode ()

	QTextFormat ()


	QTextFormat (QTextFormat rhs)


	QTextFormat (int type)


new bool	BoolProperty (int propertyId)


new QBrush	BrushProperty (int propertyId)


new void	ClearBackground ()


new void	ClearForeground ()


new void	ClearProperty (int propertyId)


new QColor	ColorProperty (int propertyId)


new double	DoubleProperty (int propertyId)


new bool	HasProperty (int propertyId)


new int	IntProperty (int propertyId)


new bool	IsBlockFormat ()


new bool	IsCharFormat ()


new bool	IsFrameFormat ()


new bool	IsImageFormat ()


new bool	IsListFormat ()


new bool	IsTableCellFormat ()


new bool	IsTableFormat ()


new bool	IsValid ()


new QTextLength	LengthProperty (int propertyId)


new System.Collections.Generic.List < QTextLength >	LengthVectorProperty (int propertyId)


new void	Merge (QTextFormat other)


new QPen	PenProperty (int propertyId)


new System.Collections.Generic.Dictionary < System.Int32, System.Object >	Properties ()


new object	property (int propertyId)


new int	PropertyCount ()


new void	SetProperty (int propertyId, object value)


new void	SetProperty (int propertyId, System.Collections.Generic.List< QTextLength > lengths)


new string	StringProperty (int propertyId)


new QTextBlockFormat	ToBlockFormat ()


new QTextCharFormat	ToCharFormat ()


new QTextFrameFormat	ToFrameFormat ()


new QTextImageFormat	ToImageFormat ()


new QTextListFormat	ToListFormat ()


new QTextTableCellFormat	ToTableCellFormat ()


new QTextTableFormat	ToTableFormat ()


new int	Type ()


new void	Dispose ()

Protected Member Functions
	QTextFrameFormat (System.Type dummy)

	QTextFrameFormat (QTextFormat fmt)


Protected Member Functions inherited from QtGui.QTextFormat
	QTextFormat (System.Type dummy)

Properties
new double	Border `[get, set]`


new QBrush	BorderBrush `[get, set]`


new QTextFrameFormat.BorderStyle	borderStyle `[get, set]`


new double	BottomMargin `[get, set]`


new QTextLength	Height `[get, set]`


new double	LeftMargin `[get, set]`


new double	Margin `[get, set]`


new double	Padding `[get, set]`


new QTextFormat.PageBreakFlag	PageBreakPolicy `[get, set]`


new QTextFrameFormat.Position	position `[get, set]`


new double	RightMargin `[get, set]`


new double	TopMargin `[get, set]`


new QTextLength	Width `[get, set]`


Properties inherited from QtGui.QTextFormat
new QBrush	Background `[get, set]`


new QBrush	Foreground `[get, set]`


new Qt.LayoutDirection	LayoutDirection `[get, set]`


new int	ObjectIndex `[get, set]`


new int	ObjectType `[get, set]`


virtual System.IntPtr	SmokeObject `[get, set]`

static new QMetaObject	StaticMetaObject `[get]`

Additional Inherited Members
Static Public Member Functions inherited from QtGui.QTextFormat
static bool	operator!= (QTextFormat arg1, QTextFormat arg2)


static bool	operator== (QTextFormat arg1, QTextFormat arg2)


Protected Attributes inherited from QtGui.QTextFormat
SmokeInvocation	interceptor

Detailed Description

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

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 and QTextBlockFormat.

Member Enumeration Documentation

enum QtGui.QTextFrameFormat.BorderStyle

This enum describes different border styles for the text frame.

This enum was introduced or modified in Qt 4.3.

See also borderStyle() and FrameBorderStyle.

Enumerator:

BorderStyle_Dashed
BorderStyle_DotDash
BorderStyle_DotDotDash
BorderStyle_Dotted
BorderStyle_Double
BorderStyle_Groove
BorderStyle_Inset
BorderStyle_None
BorderStyle_Outset
BorderStyle_Ridge
BorderStyle_Solid

enum QtGui.QTextFrameFormat.Position

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

Constructor & Destructor Documentation

QtGui.QTextFrameFormat.QTextFrameFormat ( System.Type dummy )

protected

QtGui.QTextFrameFormat.QTextFrameFormat ( )

Constructs a text frame format object with the default properties.

QtGui.QTextFrameFormat.QTextFrameFormat ( QTextFormat fmt )

protected

Constructs a text frame format object with the default properties.

QtGui.QTextFrameFormat.QTextFrameFormat ( QTextFrameFormat copy )

Constructs a text frame format object with the default properties.

Member Function Documentation

override void QtGui.QTextFrameFormat.CreateProxy ( )

virtual

Reimplemented from QtGui.QTextFormat.

Reimplemented in QtGui.QTextTableFormat.

new void QtGui.QTextFrameFormat.Dispose ( )

new bool QtGui.QTextFrameFormat.IsValid ( )

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

new void QtGui.QTextFrameFormat.SetHeight ( double height )

Sets the frame's height.

Property Documentation

new double QtGui.QTextFrameFormat.Border

getset

Returns the width of the border in pixels.

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

new QBrush QtGui.QTextFrameFormat.BorderBrush

getset

Returns the brush used for the frame's border.

This function was introduced in Qt 4.3.

Sets the brush used for the frame's border.

This function was introduced in Qt 4.3.

new QTextFrameFormat.BorderStyle QtGui.QTextFrameFormat.borderStyle

getset

Returns the style of the frame's border.

This function was introduced in Qt 4.3.

Sets the style of the frame's border.

This function was introduced in Qt 4.3.

new double QtGui.QTextFrameFormat.BottomMargin

getset

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

This function was introduced in Qt 4.3.

Sets the frame's bottom margin in pixels.

This function was introduced in Qt 4.3.

new QTextLength QtGui.QTextFrameFormat.Height

getset

Returns the height of the frame's border rectangle.

Sets the frame's height.

new double QtGui.QTextFrameFormat.LeftMargin

getset

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

This function was introduced in Qt 4.3.

Sets the frame's left margin in pixels.

This function was introduced in Qt 4.3.

new double QtGui.QTextFrameFormat.Margin

getset

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

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.

new double QtGui.QTextFrameFormat.Padding

getsetadd

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

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

new QTextFormat.PageBreakFlag QtGui.QTextFrameFormat.PageBreakPolicy

getset

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

This function was introduced in Qt 4.2.

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

This function was introduced in Qt 4.2.

new QTextFrameFormat.Position QtGui.QTextFrameFormat.position

getset

Returns the positioning policy for frames with this frame format.

Sets the policy for positioning frames with this frame format.

new double QtGui.QTextFrameFormat.RightMargin

getset

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

This function was introduced in Qt 4.3.

Sets the frame's right margin in pixels.

This function was introduced in Qt 4.3.

new double QtGui.QTextFrameFormat.TopMargin

getset

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

This function was introduced in Qt 4.3.

Sets the frame's top margin in pixels.

This function was introduced in Qt 4.3.

new QTextLength QtGui.QTextFrameFormat.Width

getset

Returns the width of the frame's border rectangle.

Sets the frame's border rectangle's width.

FloatLeft
FloatRight
InFlow

Public Types

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation