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

Sub-classes: BorderStyle, Position

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

Public constructors

Public methods

Public static methods and constants

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

Detailed description

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_Dashed

Description: Enum constant QTextFrameFormat::BorderStyle_Dashed

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_DotDash

Description: Enum constant QTextFrameFormat::BorderStyle_DotDash

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_DotDotDash

Description: Enum constant QTextFrameFormat::BorderStyle_DotDotDash

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_Dotted

Description: Enum constant QTextFrameFormat::BorderStyle_Dotted

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_Double

Description: Enum constant QTextFrameFormat::BorderStyle_Double

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_Groove

Description: Enum constant QTextFrameFormat::BorderStyle_Groove

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_Inset

Description: Enum constant QTextFrameFormat::BorderStyle_Inset

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_None

Description: Enum constant QTextFrameFormat::BorderStyle_None

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_Outset

Description: Enum constant QTextFrameFormat::BorderStyle_Outset

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_Ridge

Description: Enum constant QTextFrameFormat::BorderStyle_Ridge

[static,const] new QTextFrameFormat_BorderStyle ptr BorderStyle_Solid

Description: Enum constant QTextFrameFormat::BorderStyle_Solid

[static,const] new QTextFrameFormat_Position ptr FloatLeft

Description: Enum constant QTextFrameFormat::FloatLeft

[static,const] new QTextFrameFormat_Position ptr FloatRight

Description: Enum constant QTextFrameFormat::FloatRight

[static,const] new QTextFrameFormat_Position ptr InFlow

Description: Enum constant QTextFrameFormat::InFlow

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

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

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.

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.

void assign(const QTextFrameFormat other)

Description: Assigns another object to self

[const] double border

Description: Method double QTextFrameFormat::border()

Python specific notes:

The object exposes a readable attribute 'border'. This is the getter.

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.

[const] QBrush borderBrush

Description: Method QBrush QTextFrameFormat::borderBrush()

Python specific notes:

The object exposes a readable attribute 'borderBrush'. This is the getter.

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.

[const] QTextFrameFormat_BorderStyle borderStyle

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

Python specific notes:

The object exposes a readable attribute 'borderStyle'. This is the getter.

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.

[const] double bottomMargin

Description: Method double QTextFrameFormat::bottomMargin()

Python specific notes:

The object exposes a readable attribute 'bottomMargin'. This is the getter.

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.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] new QTextFrameFormat ptr dup

Description: Creates a copy of self

[const] QTextLength height

Description: Method QTextLength QTextFrameFormat::height()

[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

Use of this method is deprecated. Use _is_const_object? instead

[const] double leftMargin

Description: Method double QTextFrameFormat::leftMargin()

Python specific notes:

The object exposes a readable attribute 'leftMargin'. This is the getter.

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.

[const] double margin

Description: Method double QTextFrameFormat::margin()

Python specific notes:

The object exposes a readable attribute 'margin'. This is the getter.

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.

[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

[const] double padding

Description: Method double QTextFrameFormat::padding()

Python specific notes:

The object exposes a readable attribute 'padding'. This is the getter.

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.

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

void pageBreakPolicy=(const 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.

[const] QTextFrameFormat_Position position

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

Python specific notes:

The object exposes a readable attribute 'position'. This is the getter.

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.

[const] double rightMargin

Description: Method double QTextFrameFormat::rightMargin()

Python specific notes:

The object exposes a readable attribute 'rightMargin'. This is the getter.

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.

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.

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.

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.

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.

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)

Python specific notes:

The object exposes a writable attribute 'leftMargin'. This is the setter.

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.

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.

void setPageBreakPolicy(const 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.

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.

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.

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.

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()

Python specific notes:

The object exposes a readable attribute 'topMargin'. This is the getter.

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.

[const] QTextLength width

Description: Method QTextLength QTextFrameFormat::width()