KLayout Documentation (Qt 4): Main Index » Class Index » API reference - Class QTextFrameFormat

API reference - Class QTextFrameFormat

Notation used in Ruby API documentation

Description: Binding of QTextFrameFormat

Class hierarchy: QTextFrameFormat » QTextFormat

Sub-classes: BorderStyle, QFlags_BorderStyle, Position, QFlags_Position

Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description

Public constructors

new QTextFrameFormat

new

Constructor QTextFrameFormat::QTextFrameFormat()

Public methods

	void	_create		Ensures the C++ object is created
	void	_destroy		Explicitly destroys the object
[const]	bool	_destroyed?		Returns a value indicating whether the object was already destroyed
[const]	bool	_is_const_object?		Returns a value indicating whether the reference is a const reference
	void	_manage		Marks the object as managed by the script side.
	void	_unmanage		Marks the object as no longer owned by the script side.
	void	assign	(const QTextFrameFormat other)	Assigns another object to self
[const]	double	border		Method double QTextFrameFormat::border()
	void	border=	(double border)	Method void QTextFrameFormat::setBorder(double border)
[const]	QBrush	borderBrush		Method QBrush QTextFrameFormat::borderBrush()
	void	borderBrush=	(const QBrush brush)	Method void QTextFrameFormat::setBorderBrush(const QBrush &brush)
[const]	QTextFrameFormat_BorderStyle	borderStyle		Method QTextFrameFormat::BorderStyle QTextFrameFormat::borderStyle()
	void	borderStyle=	(const QTextFrameFormat_BorderStyle style)	Method void QTextFrameFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)
[const]	double	bottomMargin		Method double QTextFrameFormat::bottomMargin()
	void	bottomMargin=	(double margin)	Method void QTextFrameFormat::setBottomMargin(double margin)
[const]	new QTextFrameFormat ptr	dup		Creates a copy of self
[const]	QTextLength	height		Method QTextLength QTextFrameFormat::height()
[const]	bool	isValid?		Method () const
[const]	double	leftMargin		Method double QTextFrameFormat::leftMargin()
	void	leftMargin=	(double margin)	Method void QTextFrameFormat::setLeftMargin(double margin)
[const]	double	margin		Method double QTextFrameFormat::margin()
	void	margin=	(double margin)	Method void QTextFrameFormat::setMargin(double margin)
[const]	double	padding		Method double QTextFrameFormat::padding()
	void	padding=	(double padding)	Method void QTextFrameFormat::setPadding(double padding)
[const]	QTextFormat_QFlags_PageBreakFlag	pageBreakPolicy		Method QFlags<QTextFormat::PageBreakFlag> QTextFrameFormat::pageBreakPolicy()
	void	pageBreakPolicy=	(QTextFormat_QFlags_PageBreakFlag flags)	Method void QTextFrameFormat::setPageBreakPolicy(QFlags<QTextFormat::PageBreakFlag> flags)
[const]	QTextFrameFormat_Position	position		Method QTextFrameFormat::Position QTextFrameFormat::position()
	void	position=	(const QTextFrameFormat_Position f)	Method void QTextFrameFormat::setPosition(QTextFrameFormat::Position f)
[const]	double	rightMargin		Method double QTextFrameFormat::rightMargin()
	void	rightMargin=	(double margin)	Method void QTextFrameFormat::setRightMargin(double margin)
	void	setBorder	(double border)	Method void QTextFrameFormat::setBorder(double border)
	void	setBorderBrush	(const QBrush brush)	Method void QTextFrameFormat::setBorderBrush(const QBrush &brush)
	void	setBorderStyle	(const QTextFrameFormat_BorderStyle style)	Method void QTextFrameFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)
	void	setBottomMargin	(double margin)	Method void QTextFrameFormat::setBottomMargin(double margin)
	void	setHeight	(double height)	Method void QTextFrameFormat::setHeight(double height)
	void	setHeight	(const QTextLength height)	Method void QTextFrameFormat::setHeight(const QTextLength &height)
	void	setLeftMargin	(double margin)	Method void QTextFrameFormat::setLeftMargin(double margin)
	void	setMargin	(double margin)	Method void QTextFrameFormat::setMargin(double margin)
	void	setPadding	(double padding)	Method void QTextFrameFormat::setPadding(double padding)
	void	setPageBreakPolicy	(QTextFormat_QFlags_PageBreakFlag flags)	Method void QTextFrameFormat::setPageBreakPolicy(QFlags<QTextFormat::PageBreakFlag> flags)
	void	setPosition	(const QTextFrameFormat_Position f)	Method void QTextFrameFormat::setPosition(QTextFrameFormat::Position f)
	void	setRightMargin	(double margin)	Method void QTextFrameFormat::setRightMargin(double margin)
	void	setTopMargin	(double margin)	Method void QTextFrameFormat::setTopMargin(double margin)
	void	setWidth	(double width)	Method void QTextFrameFormat::setWidth(double width)
	void	setWidth	(const QTextLength length)	Method void QTextFrameFormat::setWidth(const QTextLength &length)
[const]	double	topMargin		Method double QTextFrameFormat::topMargin()
	void	topMargin=	(double margin)	Method void QTextFrameFormat::setTopMargin(double margin)
[const]	QTextLength	width		Method QTextLength QTextFrameFormat::width()

Public static methods and constants

[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_Dashed	Enum constant QTextFrameFormat::BorderStyle_Dashed
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_DotDash	Enum constant QTextFrameFormat::BorderStyle_DotDash
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_DotDotDash	Enum constant QTextFrameFormat::BorderStyle_DotDotDash
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_Dotted	Enum constant QTextFrameFormat::BorderStyle_Dotted
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_Double	Enum constant QTextFrameFormat::BorderStyle_Double
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_Groove	Enum constant QTextFrameFormat::BorderStyle_Groove
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_Inset	Enum constant QTextFrameFormat::BorderStyle_Inset
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_None	Enum constant QTextFrameFormat::BorderStyle_None
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_Outset	Enum constant QTextFrameFormat::BorderStyle_Outset
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_Ridge	Enum constant QTextFrameFormat::BorderStyle_Ridge
[static,const]	QTextFrameFormat_BorderStyle	BorderStyle_Solid	Enum constant QTextFrameFormat::BorderStyle_Solid
[static,const]	QTextFrameFormat_Position	FloatLeft	Enum constant QTextFrameFormat::FloatLeft
[static,const]	QTextFrameFormat_Position	FloatRight	Enum constant QTextFrameFormat::FloatRight
[static,const]	QTextFrameFormat_Position	InFlow	Enum constant QTextFrameFormat::InFlow

Deprecated methods (protected, public, static, non-static and constructors)

	void	create	Use of this method is deprecated. Use _create instead
	void	destroy	Use of this method is deprecated. Use _destroy instead
[const]	bool	destroyed?	Use of this method is deprecated. Use _destroyed? instead
[const]	bool	is_const_object?	Use of this method is deprecated. Use _is_const_object? instead

Detailed description

BorderStyle_Dashed

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Dashed

Description: Enum constant QTextFrameFormat::BorderStyle_Dashed

BorderStyle_DotDash

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_DotDash

Description: Enum constant QTextFrameFormat::BorderStyle_DotDash

BorderStyle_DotDotDash

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_DotDotDash

Description: Enum constant QTextFrameFormat::BorderStyle_DotDotDash

BorderStyle_Dotted

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Dotted

Description: Enum constant QTextFrameFormat::BorderStyle_Dotted

BorderStyle_Double

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Double

Description: Enum constant QTextFrameFormat::BorderStyle_Double

BorderStyle_Groove

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Groove

Description: Enum constant QTextFrameFormat::BorderStyle_Groove

BorderStyle_Inset

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Inset

Description: Enum constant QTextFrameFormat::BorderStyle_Inset

BorderStyle_None

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_None

Description: Enum constant QTextFrameFormat::BorderStyle_None

BorderStyle_Outset

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Outset

Description: Enum constant QTextFrameFormat::BorderStyle_Outset

BorderStyle_Ridge

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Ridge

Description: Enum constant QTextFrameFormat::BorderStyle_Ridge

BorderStyle_Solid

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Solid

Description: Enum constant QTextFrameFormat::BorderStyle_Solid

FloatLeft

Signature: [static,const] QTextFrameFormat_Position FloatLeft

Description: Enum constant QTextFrameFormat::FloatLeft

FloatRight

Signature: [static,const] QTextFrameFormat_Position FloatRight

Description: Enum constant QTextFrameFormat::FloatRight

InFlow

Signature: [static,const] QTextFrameFormat_Position InFlow

Description: Enum constant QTextFrameFormat::InFlow

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QTextFrameFormat other)

Description: Assigns another object to self

border

Signature: [const] double border

Description: Method double QTextFrameFormat::border()

Python specific notes:
The object exposes a readable attribute 'border'. This is the getter.

border=

Signature: void border= (double border)

Description: Method void QTextFrameFormat::setBorder(double border)

Python specific notes:
The object exposes a writable attribute 'border'. This is the setter.

borderBrush

Signature: [const] QBrush borderBrush

Description: Method QBrush QTextFrameFormat::borderBrush()

Python specific notes:
The object exposes a readable attribute 'borderBrush'. This is the getter.

borderBrush=

Signature: void borderBrush= (const QBrush brush)

Description: Method void QTextFrameFormat::setBorderBrush(const QBrush &brush)

Python specific notes:
The object exposes a writable attribute 'borderBrush'. This is the setter.

borderStyle

Signature: [const] QTextFrameFormat_BorderStyle borderStyle

Description: Method QTextFrameFormat::BorderStyle QTextFrameFormat::borderStyle()

Python specific notes:
The object exposes a readable attribute 'borderStyle'. This is the getter.

borderStyle=

Signature: void borderStyle= (const QTextFrameFormat_BorderStyle style)

Description: Method void QTextFrameFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)

Python specific notes:
The object exposes a writable attribute 'borderStyle'. This is the setter.

bottomMargin

Signature: [const] double bottomMargin

Description: Method double QTextFrameFormat::bottomMargin()

Python specific notes:
The object exposes a readable attribute 'bottomMargin'. This is the getter.

bottomMargin=

Signature: void bottomMargin= (double margin)

Description: Method void QTextFrameFormat::setBottomMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'bottomMargin'. This is the setter.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

dup

Signature: [const] new QTextFrameFormat ptr dup

Description: Creates a copy of self

height

Signature: [const] QTextLength height

Description: Method QTextLength QTextFrameFormat::height()

isValid?

Signature: [const] bool isValid?

Description: Method () const

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

leftMargin

Signature: [const] double leftMargin

Description: Method double QTextFrameFormat::leftMargin()

Python specific notes:
The object exposes a readable attribute 'leftMargin'. This is the getter.

leftMargin=

Signature: void leftMargin= (double margin)

Description: Method void QTextFrameFormat::setLeftMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'leftMargin'. This is the setter.

margin

Signature: [const] double margin

Description: Method double QTextFrameFormat::margin()

Python specific notes:
The object exposes a readable attribute 'margin'. This is the getter.

margin=

Signature: void margin= (double margin)

Description: Method void QTextFrameFormat::setMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'margin'. This is the setter.

new

Signature: [static] new QTextFrameFormat new

Description: Constructor QTextFrameFormat::QTextFrameFormat()

This method creates an object of class QTextFrameFormat.

Python specific notes:
This method is the default initializer of the object

padding

Signature: [const] double padding

Description: Method double QTextFrameFormat::padding()

Python specific notes:
The object exposes a readable attribute 'padding'. This is the getter.

padding=

Signature: void padding= (double padding)

Description: Method void QTextFrameFormat::setPadding(double padding)

Python specific notes:
The object exposes a writable attribute 'padding'. This is the setter.

pageBreakPolicy

Signature: [const] QTextFormat_QFlags_PageBreakFlag pageBreakPolicy

Description: Method QFlags<QTextFormat::PageBreakFlag> QTextFrameFormat::pageBreakPolicy()

Python specific notes:
The object exposes a readable attribute 'pageBreakPolicy'. This is the getter.

pageBreakPolicy=

Signature: void pageBreakPolicy= (QTextFormat_QFlags_PageBreakFlag flags)

Description: Method void QTextFrameFormat::setPageBreakPolicy(QFlags<QTextFormat::PageBreakFlag> flags)

Python specific notes:
The object exposes a writable attribute 'pageBreakPolicy'. This is the setter.

position

Signature: [const] QTextFrameFormat_Position position

Description: Method QTextFrameFormat::Position QTextFrameFormat::position()

Python specific notes:
The object exposes a readable attribute 'position'. This is the getter.

position=

Signature: void position= (const QTextFrameFormat_Position f)

Description: Method void QTextFrameFormat::setPosition(QTextFrameFormat::Position f)

Python specific notes:
The object exposes a writable attribute 'position'. This is the setter.

rightMargin

Signature: [const] double rightMargin

Description: Method double QTextFrameFormat::rightMargin()

Python specific notes:
The object exposes a readable attribute 'rightMargin'. This is the getter.

rightMargin=

Signature: void rightMargin= (double margin)

Description: Method void QTextFrameFormat::setRightMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'rightMargin'. This is the setter.

setBorder

Signature: void setBorder (double border)

Description: Method void QTextFrameFormat::setBorder(double border)

Python specific notes:
The object exposes a writable attribute 'border'. This is the setter.

setBorderBrush

Signature: void setBorderBrush (const QBrush brush)

Description: Method void QTextFrameFormat::setBorderBrush(const QBrush &brush)

Python specific notes:
The object exposes a writable attribute 'borderBrush'. This is the setter.

setBorderStyle

Signature: void setBorderStyle (const QTextFrameFormat_BorderStyle style)

Description: Method void QTextFrameFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)

Python specific notes:
The object exposes a writable attribute 'borderStyle'. This is the setter.

setBottomMargin

Signature: void setBottomMargin (double margin)

Description: Method void QTextFrameFormat::setBottomMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'bottomMargin'. This is the setter.

setHeight

Signature: void setHeight (double height)

Description: Method void QTextFrameFormat::setHeight(double height)

Signature: void setHeight (const QTextLength height)

Description: Method void QTextFrameFormat::setHeight(const QTextLength &height)

setLeftMargin

Signature: void setLeftMargin (double margin)

Description: Method void QTextFrameFormat::setLeftMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'leftMargin'. This is the setter.

setMargin

Signature: void setMargin (double margin)

Description: Method void QTextFrameFormat::setMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'margin'. This is the setter.

setPadding

Signature: void setPadding (double padding)

Description: Method void QTextFrameFormat::setPadding(double padding)

Python specific notes:
The object exposes a writable attribute 'padding'. This is the setter.

setPageBreakPolicy

Signature: void setPageBreakPolicy (QTextFormat_QFlags_PageBreakFlag flags)

Description: Method void QTextFrameFormat::setPageBreakPolicy(QFlags<QTextFormat::PageBreakFlag> flags)

Python specific notes:
The object exposes a writable attribute 'pageBreakPolicy'. This is the setter.

setPosition

Signature: void setPosition (const QTextFrameFormat_Position f)

Description: Method void QTextFrameFormat::setPosition(QTextFrameFormat::Position f)

Python specific notes:
The object exposes a writable attribute 'position'. This is the setter.

setRightMargin

Signature: void setRightMargin (double margin)

Description: Method void QTextFrameFormat::setRightMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'rightMargin'. This is the setter.

setTopMargin

Signature: void setTopMargin (double margin)

Description: Method void QTextFrameFormat::setTopMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'topMargin'. This is the setter.

setWidth

Signature: void setWidth (double width)

Description: Method void QTextFrameFormat::setWidth(double width)

Signature: void setWidth (const QTextLength length)

Description: Method void QTextFrameFormat::setWidth(const QTextLength &length)

topMargin

Signature: [const] double topMargin

Description: Method double QTextFrameFormat::topMargin()

Python specific notes:
The object exposes a readable attribute 'topMargin'. This is the getter.

topMargin=

Signature: void topMargin= (double margin)

Description: Method void QTextFrameFormat::setTopMargin(double margin)

Python specific notes:
The object exposes a writable attribute 'topMargin'. This is the setter.

width

Signature: [const] QTextLength width

Description: Method QTextLength QTextFrameFormat::width()