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

API reference - Class QTextTableFormat

Notation used in Ruby API documentation

Description: Binding of QTextTableFormat

Class hierarchy: QTextTableFormat » QTextFrameFormat » QTextFormat

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

Public constructors

Public methods

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

Detailed description

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> QTextTableFormat::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 QTextTableFormat::setAlignment(QFlags<Qt::AlignmentFlag> alignment)

Python specific notes:

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

void assign(const QTextTableFormat other)

Description: Assigns another object to self

[const] double cellPadding

Description: Method double QTextTableFormat::cellPadding()

Python specific notes:

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

void cellPadding=(double padding)

Description: Method void QTextTableFormat::setCellPadding(double padding)

Python specific notes:

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

[const] double cellSpacing

Description: Method double QTextTableFormat::cellSpacing()

Python specific notes:

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

void cellSpacing=(double spacing)

Description: Method void QTextTableFormat::setCellSpacing(double spacing)

Python specific notes:

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

void clearColumnWidthConstraints

Description: Method void QTextTableFormat::clearColumnWidthConstraints()

[const] QTextLength[] columnWidthConstraints

Description: Method QVector<QTextLength> QTextTableFormat::columnWidthConstraints()

Python specific notes:

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

void columnWidthConstraints=(QTextLength[] constraints)

Description: Method void QTextTableFormat::setColumnWidthConstraints(const QVector<QTextLength> &constraints)

Python specific notes:

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

[const] int columns

Description: Method int QTextTableFormat::columns()

Python specific notes:

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

void columns=(int columns)

Description: Method void QTextTableFormat::setColumns(int columns)

Python specific notes:

The object exposes a writable attribute 'columns'. 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 QTextTableFormat ptr dup

Description: Creates a copy of self

[const] int headerRowCount

Description: Method int QTextTableFormat::headerRowCount()

Python specific notes:

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

void headerRowCount=(int count)

Description: Method void QTextTableFormat::setHeaderRowCount(int count)

Python specific notes:

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

[const] bool isValid?

Description: Method bool QTextTableFormat::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

[static] new QTextTableFormat new

Description: Constructor QTextTableFormat::QTextTableFormat()

This method creates an object of class QTextTableFormat.

Python specific notes:

This method is the default initializer of the object

void setAlignment(const Qt_QFlags_AlignmentFlag alignment)

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

Python specific notes:

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

void setCellPadding(double padding)

Description: Method void QTextTableFormat::setCellPadding(double padding)

Python specific notes:

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

void setCellSpacing(double spacing)

Description: Method void QTextTableFormat::setCellSpacing(double spacing)

Python specific notes:

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

void setColumnWidthConstraints(QTextLength[] constraints)

Description: Method void QTextTableFormat::setColumnWidthConstraints(const QVector<QTextLength> &constraints)

Python specific notes:

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

void setColumns(int columns)

Description: Method void QTextTableFormat::setColumns(int columns)

Python specific notes:

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

void setHeaderRowCount(int count)

Description: Method void QTextTableFormat::setHeaderRowCount(int count)

Python specific notes:

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