KLayout Manual: Main Index » Class Index » API reference - Class QTextOption

API reference - Class QTextOption

Notation used in Ruby API documentation

Description: Binding of QTextOption

Sub-classes: Flag, WrapMode, Tab

• 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 QTextOption_Flag ptr AddSpaceForLineAndParagraphSeparators

Description: Enum constant QTextOption::AddSpaceForLineAndParagraphSeparators

[static,const] new QTextOption_Flag ptr IncludeTrailingSpaces

Description: Enum constant QTextOption::IncludeTrailingSpaces

[static,const] new QTextOption_WrapMode ptr ManualWrap

Description: Enum constant QTextOption::ManualWrap

[static,const] new QTextOption_WrapMode ptr NoWrap

Description: Enum constant QTextOption::NoWrap

[static,const] new QTextOption_Flag ptr ShowLineAndParagraphSeparators

Description: Enum constant QTextOption::ShowLineAndParagraphSeparators

[static,const] new QTextOption_Flag ptr ShowTabsAndSpaces

Description: Enum constant QTextOption::ShowTabsAndSpaces

[static,const] new QTextOption_Flag ptr SuppressColors

Description: Enum constant QTextOption::SuppressColors

[static,const] new QTextOption_WrapMode ptr WordWrap

Description: Enum constant QTextOption::WordWrap

[static,const] new QTextOption_WrapMode ptr WrapAnywhere

Description: Enum constant QTextOption::WrapAnywhere

[static,const] new QTextOption_WrapMode ptr WrapAtWordBoundaryOrAnywhere

Description: Enum constant QTextOption::WrapAtWordBoundaryOrAnywhere

void _assign(const QTextOption other)

Description: Assigns another object to self

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.

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

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

QTextOption assign(const QTextOption o)

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

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

Description: Creates a copy of self

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

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

[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

[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

[static] new QTextOption new(const 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

[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

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

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

void setTabArray(double[] tabStops)

Description: Method void QTextOption::setTabArray(QList<double> tabStops)

Python specific notes:

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

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.

void setTabs(QTextOption_Tab[] tabStops)

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

Python specific notes:

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

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.

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.

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.

[const] double[] tabArray

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

Python specific notes:

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

void tabArray=(double[] tabStops)

Description: Method void QTextOption::setTabArray(QList<double> tabStops)

Python specific notes:

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

[const] double tabStop

Description: Method double QTextOption::tabStop()

Python specific notes:

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

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.

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

void tabs=(QTextOption_Tab[] tabStops)

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

Python specific notes:

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

[const] Qt_LayoutDirection textDirection

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

Python specific notes:

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

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.

[const] bool useDesignMetrics

Description: Method bool QTextOption::useDesignMetrics()

Python specific notes:

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

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.

[const] QTextOption_WrapMode wrapMode

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

Python specific notes:

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

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.