API reference - Class QTextBlockFormat

_assign

Signature: void _assign (const QTextBlockFormat other)

Description: Assigns another object to self

_const_cast

Signature: [const] QTextBlockFormat ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

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

alignment

Signature: [const] Qt_QFlags_AlignmentFlag alignment

Description: Method QFlags<Qt::AlignmentFlag> QTextBlockFormat::alignment()

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

alignment=

Signature: void alignment= (Qt_QFlags_AlignmentFlag alignment)

Description: Method void QTextBlockFormat::setAlignment(QFlags<Qt::AlignmentFlag> alignment)

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

bottomMargin

Signature: [const] double bottomMargin

Description: Method double QTextBlockFormat::bottomMargin()

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

bottomMargin=

Signature: void bottomMargin= (double margin)

Description: Method void QTextBlockFormat::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

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QTextBlockFormat ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

headingLevel

Signature: [const] int headingLevel

Description: Method int QTextBlockFormat::headingLevel()

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

headingLevel=

Signature: void headingLevel= (int alevel)

Description: Method void QTextBlockFormat::setHeadingLevel(int alevel)

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

indent

Signature: [const] int indent

Description: Method int QTextBlockFormat::indent()

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

indent=

Signature: void indent= (int indent)

Description: Method void QTextBlockFormat::setIndent(int indent)

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

isValid?

Signature: [const] bool isValid?

Description: Method bool QTextBlockFormat::isValid()

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

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

leftMargin

Signature: [const] double leftMargin

Description: Method double QTextBlockFormat::leftMargin()

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

leftMargin=

Signature: void leftMargin= (double margin)

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

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

lineHeight

(1) Signature: [const] double lineHeight (double scriptLineHeight, double scaling)

Description: Method double QTextBlockFormat::lineHeight(double scriptLineHeight, double scaling)

(2) Signature: [const] double lineHeight

Description: Method double QTextBlockFormat::lineHeight()

lineHeightType

Signature: [const] int lineHeightType

Description: Method int QTextBlockFormat::lineHeightType()

new

Signature: [static] new QTextBlockFormat new

Description: Constructor QTextBlockFormat::QTextBlockFormat()

This method creates an object of class QTextBlockFormat.

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

nonBreakableLines

Signature: [const] bool nonBreakableLines

Description: Method bool QTextBlockFormat::nonBreakableLines()

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

nonBreakableLines=

Signature: void nonBreakableLines= (bool b)

Description: Method void QTextBlockFormat::setNonBreakableLines(bool b)

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

pageBreakPolicy

Signature: [const] QTextFormat_QFlags_PageBreakFlag pageBreakPolicy

Description: Method QFlags<QTextFormat::PageBreakFlag> QTextBlockFormat::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 QTextBlockFormat::setPageBreakPolicy(QFlags<QTextFormat::PageBreakFlag> flags)

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

rightMargin

Signature: [const] double rightMargin

Description: Method double QTextBlockFormat::rightMargin()

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

rightMargin=

Signature: void rightMargin= (double margin)

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

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

setAlignment

Signature: void setAlignment (Qt_QFlags_AlignmentFlag alignment)

Description: Method void QTextBlockFormat::setAlignment(QFlags<Qt::AlignmentFlag> alignment)

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

setBottomMargin

Signature: void setBottomMargin (double margin)

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

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

setHeadingLevel

Signature: void setHeadingLevel (int alevel)

Description: Method void QTextBlockFormat::setHeadingLevel(int alevel)

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

setIndent

Signature: void setIndent (int indent)

Description: Method void QTextBlockFormat::setIndent(int indent)

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

setLeftMargin

Signature: void setLeftMargin (double margin)

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

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

setLineHeight

Signature: void setLineHeight (double height, int heightType)

Description: Method void QTextBlockFormat::setLineHeight(double height, int heightType)

setNonBreakableLines

Signature: void setNonBreakableLines (bool b)

Description: Method void QTextBlockFormat::setNonBreakableLines(bool b)

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

setPageBreakPolicy

Signature: void setPageBreakPolicy (QTextFormat_QFlags_PageBreakFlag flags)

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

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

setRightMargin

Signature: void setRightMargin (double margin)

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

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

setTabPositions

Signature: void setTabPositions (QTextOption_Tab[] tabs)

Description: Method void QTextBlockFormat::setTabPositions(const QList<QTextOption::Tab> &tabs)

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

setTextIndent

Signature: void setTextIndent (double aindent)

Description: Method void QTextBlockFormat::setTextIndent(double aindent)

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

setTopMargin

Signature: void setTopMargin (double margin)

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

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

tabPositions

Signature: [const] QTextOption_Tab[] tabPositions

Description: Method QList<QTextOption::Tab> QTextBlockFormat::tabPositions()

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

tabPositions=

Signature: void tabPositions= (QTextOption_Tab[] tabs)

Description: Method void QTextBlockFormat::setTabPositions(const QList<QTextOption::Tab> &tabs)

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

textIndent

Signature: [const] double textIndent

Description: Method double QTextBlockFormat::textIndent()

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

textIndent=

Signature: void textIndent= (double aindent)

Description: Method void QTextBlockFormat::setTextIndent(double aindent)

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

topMargin

Signature: [const] double topMargin

Description: Method double QTextBlockFormat::topMargin()

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

topMargin=

Signature: void topMargin= (double margin)

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

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