QTextFrameFormat¶

Synopsis¶

Functions¶

def border ()
def borderBrush ()
def borderStyle ()
def bottomMargin ()
def height ()
def leftMargin ()
def margin ()
def padding ()
def pageBreakPolicy ()
def position ()
def rightMargin ()
def setBorder (border)
def setBorderBrush (brush)
def setBorderStyle (style)
def setBottomMargin (margin)
def setHeight (height)
def setHeight (height)
def setLeftMargin (margin)
def setMargin (margin)
def setPadding (padding)
def setPageBreakPolicy (flags)
def setPosition (f)
def setRightMargin (margin)
def setTopMargin (margin)
def setWidth (length)
def setWidth (width)
def topMargin ()
def width ()

Detailed Description¶

The PySide.QtGui.QTextFrameFormat class provides formatting information for frames in a PySide.QtGui.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 PySide.QtGui.QTextFrameFormat.width() and PySide.QtGui.QTextFrameFormat.height() of the frame on the screen. Each frame can have a PySide.QtGui.QTextFrameFormat.border() that surrounds its contents with a rectangular box. The border is surrounded by a PySide.QtGui.QTextFrameFormat.margin() around the frame, and the contents of the frame are kept separate from the border by the frame’s PySide.QtGui.QTextFrameFormat.padding() . This scheme is similar to the box model used by Cascading Style Sheets for HTML pages.

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

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

See also

PySide.QtGui.QTextFrame PySide.QtGui.QTextBlockFormat

class PySide.QtGui.QTextFrameFormat¶

class PySide.QtGui.QTextFrameFormat(fmt)

class PySide.QtGui.QTextFrameFormat(QTextFrameFormat)

Parameters:	fmt – `PySide.QtGui.QTextFormat` QTextFrameFormat – `PySide.QtGui.QTextFrameFormat`

Constructs a text frame format object with the default properties.

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

PySide.QtGui.QTextFrameFormat.Position¶

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

Constant	Description
QTextFrameFormat.InFlow
QTextFrameFormat.FloatLeft
QTextFrameFormat.FloatRight

PySide.QtGui.QTextFrameFormat.BorderStyle¶

This enum describes different border styles for the text frame.

Constant	Description
QTextFrameFormat.BorderStyle_None
QTextFrameFormat.BorderStyle_Dotted
QTextFrameFormat.BorderStyle_Dashed
QTextFrameFormat.BorderStyle_Solid
QTextFrameFormat.BorderStyle_Double
QTextFrameFormat.BorderStyle_DotDash
QTextFrameFormat.BorderStyle_DotDotDash
QTextFrameFormat.BorderStyle_Groove
QTextFrameFormat.BorderStyle_Ridge
QTextFrameFormat.BorderStyle_Inset
QTextFrameFormat.BorderStyle_Outset

PySide.QtGui.QTextFrameFormat.border()¶

Return type:	`PySide.QtCore.qreal`

Returns the width of the border in pixels.

PySide.QtGui.QTextFrameFormat.borderBrush()¶

Return type:	`PySide.QtGui.QBrush`

Returns the brush used for the frame’s border.

PySide.QtGui.QTextFrameFormat.borderStyle()¶

Return type:	`PySide.QtGui.QTextFrameFormat.BorderStyle`

Returns the style of the frame’s border.

PySide.QtGui.QTextFrameFormat.bottomMargin()¶

Return type:	`PySide.QtCore.qreal`

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

PySide.QtGui.QTextFrameFormat.height()¶

Return type:	`PySide.QtGui.QTextLength`

Returns the height of the frame’s border rectangle.

PySide.QtGui.QTextFrameFormat.leftMargin()¶

Return type:	`PySide.QtCore.qreal`

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

PySide.QtGui.QTextFrameFormat.margin()¶

Return type:	`PySide.QtCore.qreal`

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

PySide.QtGui.QTextFrameFormat.padding()¶

Return type:	`PySide.QtCore.qreal`

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

PySide.QtGui.QTextFrameFormat.pageBreakPolicy()¶

Return type:	`PySide.QtGui.QTextFormat.PageBreakFlags`

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

PySide.QtGui.QTextFrameFormat.position()¶

Return type:	`PySide.QtGui.QTextFrameFormat.Position`

Returns the positioning policy for frames with this frame format.

PySide.QtGui.QTextFrameFormat.rightMargin()¶

Return type:	`PySide.QtCore.qreal`

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

PySide.QtGui.QTextFrameFormat.setBorder(border)¶

Parameters:	border – `PySide.QtCore.qreal`

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

PySide.QtGui.QTextFrameFormat.setBorderBrush(brush)¶

Parameters:	brush – `PySide.QtGui.QBrush`

Sets the brush used for the frame’s border.

PySide.QtGui.QTextFrameFormat.setBorderStyle(style)¶

Parameters:	style – `PySide.QtGui.QTextFrameFormat.BorderStyle`

Sets the style of the frame’s border.

PySide.QtGui.QTextFrameFormat.setBottomMargin(margin)¶

Parameters:	margin – `PySide.QtCore.qreal`

Sets the frame’s bottom margin in pixels.

PySide.QtGui.QTextFrameFormat.setHeight(height)¶

Parameters:	height – `PySide.QtGui.QTextLength`

Sets the frame’s height .

PySide.QtGui.QTextFrameFormat.setHeight(height)

Parameters:	height – `PySide.QtCore.qreal`

This is an overloaded function.

Sets the frame’s height .

PySide.QtGui.QTextFrameFormat.setLeftMargin(margin)¶

Parameters:	margin – `PySide.QtCore.qreal`

Sets the frame’s left margin in pixels.

PySide.QtGui.QTextFrameFormat.setMargin(margin)¶

Parameters:	margin – `PySide.QtCore.qreal`

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.

PySide.QtGui.QTextFrameFormat.setPadding(padding)¶

Parameters:	padding – `PySide.QtCore.qreal`

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

PySide.QtGui.QTextFrameFormat.setPageBreakPolicy(flags)¶

Parameters:	flags – `PySide.QtGui.QTextFormat.PageBreakFlags`

PySide.QtGui.QTextFrameFormat.setPosition(f)¶

Parameters:	f – `PySide.QtGui.QTextFrameFormat.Position`

Sets the policy for positioning frames with this frame format.

PySide.QtGui.QTextFrameFormat.setRightMargin(margin)¶

Parameters:	margin – `PySide.QtCore.qreal`

Sets the frame’s right margin in pixels.

PySide.QtGui.QTextFrameFormat.setTopMargin(margin)¶

Parameters:	margin – `PySide.QtCore.qreal`

Sets the frame’s top margin in pixels.

PySide.QtGui.QTextFrameFormat.setWidth(width)¶

Parameters:	width – `PySide.QtCore.qreal`

This is an overloaded function.

Convenience method that sets the width of the frame’s border rectangle’s width to the specified fixed width .

PySide.QtGui.QTextFrameFormat.setWidth(length)

Parameters:	length – `PySide.QtGui.QTextLength`

Sets the frame’s border rectangle’s width .

PySide.QtGui.QTextFrameFormat.topMargin()¶

Return type:	`PySide.QtCore.qreal`

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

PySide.QtGui.QTextFrameFormat.width()¶

Return type:	`PySide.QtGui.QTextLength`

Returns the width of the frame’s border rectangle.

Table Of Contents

Previous topic

Next topic

QTextFrameFormat¶

Synopsis¶

Functions¶

Detailed Description¶

Table Of Contents

Previous topic

Next topic

Quick search

QTextFrameFormat¶

Synopsis¶

Functions¶

Detailed Description¶