API reference - Class QTextOption

AddSpaceForLineAndParagraphSeparators

Signature: [static,const] QTextOption_Flag AddSpaceForLineAndParagraphSeparators

Description: Enum constant QTextOption::AddSpaceForLineAndParagraphSeparators

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

CenterTab

Signature: [static,const] QTextOption_TabType CenterTab

Description: Enum constant QTextOption::CenterTab

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

DelimiterTab

Signature: [static,const] QTextOption_TabType DelimiterTab

Description: Enum constant QTextOption::DelimiterTab

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

IncludeTrailingSpaces

Signature: [static,const] QTextOption_Flag IncludeTrailingSpaces

Description: Enum constant QTextOption::IncludeTrailingSpaces

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

LeftTab

Signature: [static,const] QTextOption_TabType LeftTab

Description: Enum constant QTextOption::LeftTab

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

ManualWrap

Signature: [static,const] QTextOption_WrapMode ManualWrap

Description: Enum constant QTextOption::ManualWrap

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

NoWrap

Signature: [static,const] QTextOption_WrapMode NoWrap

Description: Enum constant QTextOption::NoWrap

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

RightTab

Signature: [static,const] QTextOption_TabType RightTab

Description: Enum constant QTextOption::RightTab

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

ShowDocumentTerminator

Signature: [static,const] QTextOption_Flag ShowDocumentTerminator

Description: Enum constant QTextOption::ShowDocumentTerminator

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

ShowLineAndParagraphSeparators

Signature: [static,const] QTextOption_Flag ShowLineAndParagraphSeparators

Description: Enum constant QTextOption::ShowLineAndParagraphSeparators

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

ShowTabsAndSpaces

Signature: [static,const] QTextOption_Flag ShowTabsAndSpaces

Description: Enum constant QTextOption::ShowTabsAndSpaces

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

SuppressColors

Signature: [static,const] QTextOption_Flag SuppressColors

Description: Enum constant QTextOption::SuppressColors

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

WordWrap

Signature: [static,const] QTextOption_WrapMode WordWrap

Description: Enum constant QTextOption::WordWrap

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

WrapAnywhere

Signature: [static,const] QTextOption_WrapMode WrapAnywhere

Description: Enum constant QTextOption::WrapAnywhere

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

WrapAtWordBoundaryOrAnywhere

Signature: [static,const] QTextOption_WrapMode WrapAtWordBoundaryOrAnywhere

Description: Enum constant QTextOption::WrapAtWordBoundaryOrAnywhere

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

_assign

Signature: void _assign (const QTextOption other)

Description: Assigns another object to self

_const_cast

Signature: [const] QTextOption 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> QTextOption::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 QTextOption::setAlignment(QFlags<Qt::AlignmentFlag> alignment)

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

assign

Signature: QTextOption assign (const QTextOption o)

Description: Method QTextOption &QTextOption::operator=(const QTextOption &o)

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 QTextOption ptr dup

Description: Creates a copy of self

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

flags

Signature: [const] QTextOption_QFlags_Flag flags

Description: Method QFlags<QTextOption::Flag> QTextOption::flags()

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

flags=

Signature: void flags= (QTextOption_QFlags_Flag flags)

Description: Method void QTextOption::setFlags(QFlags<QTextOption::Flag> flags)

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

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.

new

(1) Signature: [static] new QTextOption new

Description: Constructor QTextOption::QTextOption()

This method creates an object of class QTextOption.

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

(2) Signature: [static] new QTextOption new (Qt_QFlags_AlignmentFlag alignment)

Description: Constructor QTextOption::QTextOption(QFlags<Qt::AlignmentFlag> alignment)

This method creates an object of class QTextOption.

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

(3) Signature: [static] new QTextOption new (const QTextOption o)

Description: Constructor QTextOption::QTextOption(const QTextOption &o)

This method creates an object of class QTextOption.

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

setAlignment

Signature: void setAlignment (Qt_QFlags_AlignmentFlag alignment)

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

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

setFlags

Signature: void setFlags (QTextOption_QFlags_Flag flags)

Description: Method void QTextOption::setFlags(QFlags<QTextOption::Flag> flags)

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

setTabArray

Signature: void setTabArray (double[] tabStops)

Description: Method void QTextOption::setTabArray(const QList<qreal> &tabStops)

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

setTabStop

Signature: void setTabStop (double tabStop)

Description: Method void QTextOption::setTabStop(double tabStop)

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

setTabStopDistance

Signature: void setTabStopDistance (double tabStopDistance)

Description: Method void QTextOption::setTabStopDistance(double tabStopDistance)

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

setTabs

Signature: void setTabs (QTextOption_Tab[] tabStops)

Description: Method void QTextOption::setTabs(const QList<QTextOption::Tab> &tabStops)

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

setTextDirection

Signature: void setTextDirection (const Qt_LayoutDirection aDirection)

Description: Method void QTextOption::setTextDirection(Qt::LayoutDirection aDirection)

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

setUseDesignMetrics

Signature: void setUseDesignMetrics (bool b)

Description: Method void QTextOption::setUseDesignMetrics(bool b)

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

setWrapMode

Signature: void setWrapMode (const QTextOption_WrapMode wrap)

Description: Method void QTextOption::setWrapMode(QTextOption::WrapMode wrap)

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

tabArray

Signature: [const] double[] tabArray

Description: Method QList<qreal> QTextOption::tabArray()

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

tabArray=

Signature: void tabArray= (double[] tabStops)

Description: Method void QTextOption::setTabArray(const QList<qreal> &tabStops)

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

tabStop

Signature: [const] double tabStop

Description: Method double QTextOption::tabStop()

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

tabStop=

Signature: void tabStop= (double tabStop)

Description: Method void QTextOption::setTabStop(double tabStop)

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

tabStopDistance

Signature: [const] double tabStopDistance

Description: Method double QTextOption::tabStopDistance()

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

tabStopDistance=

Signature: void tabStopDistance= (double tabStopDistance)

Description: Method void QTextOption::setTabStopDistance(double tabStopDistance)

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

tabs

Signature: [const] QTextOption_Tab[] tabs

Description: Method QList<QTextOption::Tab> QTextOption::tabs()

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

tabs=

Signature: void tabs= (QTextOption_Tab[] tabStops)

Description: Method void QTextOption::setTabs(const QList<QTextOption::Tab> &tabStops)

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

textDirection

Signature: [const] Qt_LayoutDirection textDirection

Description: Method Qt::LayoutDirection QTextOption::textDirection()

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

textDirection=

Signature: void textDirection= (const Qt_LayoutDirection aDirection)

Description: Method void QTextOption::setTextDirection(Qt::LayoutDirection aDirection)

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

useDesignMetrics

Signature: [const] bool useDesignMetrics

Description: Method bool QTextOption::useDesignMetrics()

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

useDesignMetrics=

Signature: void useDesignMetrics= (bool b)

Description: Method void QTextOption::setUseDesignMetrics(bool b)

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

wrapMode

Signature: [const] QTextOption_WrapMode wrapMode

Description: Method QTextOption::WrapMode QTextOption::wrapMode()

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

wrapMode=

Signature: void wrapMode= (const QTextOption_WrapMode wrap)

Description: Method void QTextOption::setWrapMode(QTextOption::WrapMode wrap)

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