KLayout Manual: 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

Public constructors
Public methods
Public static methods and constants
Detailed description

Public constructors

new QTextFrameFormat

new

Constructor QTextFrameFormat::QTextFrameFormat()

Public methods

[const]	void	assign	(const QTextFrameFormat other)	Assign the contents of 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)
	void	create		Ensures the C++ object is created
	void	destroy		Explicitly destroy the object
[const]	bool	destroyed?		Returns a value indicating whether the object was already destroyed
[const]	QTextFrameFormat	dup		Creates a copy of self
[const]	QTextLength	height		Method QTextLength QTextFrameFormat::height()
	void	height=	(double height)	Method void QTextFrameFormat::setHeight(double height)
	void	height=	(const QTextLength height)	Method void QTextFrameFormat::setHeight(const QTextLength &height)
[const]	bool	isValid		Method bool QTextFrameFormat::isValid()
[const]	bool	isValid?		Method bool QTextFrameFormat::isValid()
[const]	bool	is_const_object?		Returns a value indicating whether the reference is a const reference
[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]	int	pageBreakPolicy		Method QFlags<enum QTextFormat::PageBreakFlag> QTextFrameFormat::pageBreakPolicy()
	void	pageBreakPolicy=	(int flags)	Method void QTextFrameFormat::setPageBreakPolicy(QFlags<enum 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	(int flags)	Method void QTextFrameFormat::setPageBreakPolicy(QFlags<enum 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()
	void	width=	(double width)	Method void QTextFrameFormat::setWidth(double width)
	void	width=	(const QTextLength length)	Method void QTextFrameFormat::setWidth(const QTextLength &length)

Public static methods and constants

QTextFrameFormat_BorderStyle	BorderStyle_Dashed	Enum constant enum QTextFrameFormat::BorderStyle_Dashed
QTextFrameFormat_BorderStyle	BorderStyle_DotDash	Enum constant enum QTextFrameFormat::BorderStyle_DotDash
QTextFrameFormat_BorderStyle	BorderStyle_DotDotDash	Enum constant enum QTextFrameFormat::BorderStyle_DotDotDash
QTextFrameFormat_BorderStyle	BorderStyle_Dotted	Enum constant enum QTextFrameFormat::BorderStyle_Dotted
QTextFrameFormat_BorderStyle	BorderStyle_Double	Enum constant enum QTextFrameFormat::BorderStyle_Double
QTextFrameFormat_BorderStyle	BorderStyle_Groove	Enum constant enum QTextFrameFormat::BorderStyle_Groove
QTextFrameFormat_BorderStyle	BorderStyle_Inset	Enum constant enum QTextFrameFormat::BorderStyle_Inset
QTextFrameFormat_BorderStyle	BorderStyle_None	Enum constant enum QTextFrameFormat::BorderStyle_None
QTextFrameFormat_BorderStyle	BorderStyle_Outset	Enum constant enum QTextFrameFormat::BorderStyle_Outset
QTextFrameFormat_BorderStyle	BorderStyle_Ridge	Enum constant enum QTextFrameFormat::BorderStyle_Ridge
QTextFrameFormat_BorderStyle	BorderStyle_Solid	Enum constant enum QTextFrameFormat::BorderStyle_Solid
QTextFrameFormat_Position	FloatLeft	Enum constant enum QTextFrameFormat::FloatLeft
QTextFrameFormat_Position	FloatRight	Enum constant enum QTextFrameFormat::FloatRight
QTextFrameFormat_Position	InFlow	Enum constant enum QTextFrameFormat::InFlow

Detailed description

[static] QTextFrameFormat_BorderStyle BorderStyle_Dashed

Description: Enum constant enum QTextFrameFormat::BorderStyle_Dashed

[static] QTextFrameFormat_BorderStyle BorderStyle_DotDash

Description: Enum constant enum QTextFrameFormat::BorderStyle_DotDash

[static] QTextFrameFormat_BorderStyle BorderStyle_DotDotDash

Description: Enum constant enum QTextFrameFormat::BorderStyle_DotDotDash

[static] QTextFrameFormat_BorderStyle BorderStyle_Dotted

Description: Enum constant enum QTextFrameFormat::BorderStyle_Dotted

[static] QTextFrameFormat_BorderStyle BorderStyle_Double

Description: Enum constant enum QTextFrameFormat::BorderStyle_Double

[static] QTextFrameFormat_BorderStyle BorderStyle_Groove

Description: Enum constant enum QTextFrameFormat::BorderStyle_Groove

[static] QTextFrameFormat_BorderStyle BorderStyle_Inset

Description: Enum constant enum QTextFrameFormat::BorderStyle_Inset

[static] QTextFrameFormat_BorderStyle BorderStyle_None

Description: Enum constant enum QTextFrameFormat::BorderStyle_None

[static] QTextFrameFormat_BorderStyle BorderStyle_Outset

Description: Enum constant enum QTextFrameFormat::BorderStyle_Outset

[static] QTextFrameFormat_BorderStyle BorderStyle_Ridge

Description: Enum constant enum QTextFrameFormat::BorderStyle_Ridge

[static] QTextFrameFormat_BorderStyle BorderStyle_Solid

Description: Enum constant enum QTextFrameFormat::BorderStyle_Solid

[static] QTextFrameFormat_Position FloatLeft

Description: Enum constant enum QTextFrameFormat::FloatLeft

[static] QTextFrameFormat_Position FloatRight

Description: Enum constant enum QTextFrameFormat::FloatRight

[static] QTextFrameFormat_Position InFlow

Description: Enum constant enum QTextFrameFormat::InFlow

[const] void assign(const QTextFrameFormat other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

[const] double border

Description: Method double QTextFrameFormat::border()

void border=(double border)

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

[const] QBrush borderBrush

Description: Method QBrush QTextFrameFormat::borderBrush()

void borderBrush=(const QBrush brush)

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

[const] QTextFrameFormat_BorderStyle borderStyle

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

void borderStyle=(const QTextFrameFormat_BorderStyle style)

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

[const] double bottomMargin

Description: Method double QTextFrameFormat::bottomMargin()

void bottomMargin=(double margin)

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

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.

void destroy

Description: Explicitly destroy the object

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

[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.

[const] QTextFrameFormat dup

Description: Creates a copy of self

[const] QTextLength height

Description: Method QTextLength QTextFrameFormat::height()

void height=(double height)

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

void height=(const QTextLength height)

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

[const] bool isValid

Description: Method bool QTextFrameFormat::isValid()

[const] bool isValid?

Description: Method bool QTextFrameFormat::isValid()

[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.

[const] double leftMargin

Description: Method double QTextFrameFormat::leftMargin()

void leftMargin=(double margin)

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

[const] double margin

Description: Method double QTextFrameFormat::margin()

void margin=(double margin)

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

[static] new QTextFrameFormat new

Description: Constructor QTextFrameFormat::QTextFrameFormat()

This method creates an object of class QTextFrameFormat.

[const] double padding

Description: Method double QTextFrameFormat::padding()

void padding=(double padding)

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

[const] int pageBreakPolicy

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

void pageBreakPolicy=(int flags)

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

[const] QTextFrameFormat_Position position

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

void position=(const QTextFrameFormat_Position f)

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

[const] double rightMargin

Description: Method double QTextFrameFormat::rightMargin()

void rightMargin=(double margin)

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

void setBorder(double border)

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

void setBorderBrush(const QBrush brush)

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

void setBorderStyle(const QTextFrameFormat_BorderStyle style)

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

void setBottomMargin(double margin)

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

void setHeight(double height)

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

void setHeight(const QTextLength height)

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

void setLeftMargin(double margin)

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

void setMargin(double margin)

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

void setPadding(double padding)

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

void setPageBreakPolicy(int flags)

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

void setPosition(const QTextFrameFormat_Position f)

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

void setRightMargin(double margin)

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

void setTopMargin(double margin)

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

void setWidth(double width)

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

void setWidth(const QTextLength length)

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

[const] double topMargin

Description: Method double QTextFrameFormat::topMargin()

void topMargin=(double margin)

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

[const] QTextLength width

Description: Method QTextLength QTextFrameFormat::width()

void width=(double width)

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

void width=(const QTextLength length)

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