KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QTextTableFormat

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QTextTableFormat

Class hierarchy: QTextTableFormat » QTextFrameFormat » QTextFormat

Public constructors

new QTextTableFormatnewConstructor QTextTableFormat::QTextTableFormat()

Public methods

void_assign(const QTextTableFormat other)Assigns another object to self
[const]QTextTableFormat ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]new QTextTableFormat ptr_dupCreates a copy of self
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]Qt_QFlags_AlignmentFlagalignmentMethod QFlags<Qt::AlignmentFlag> QTextTableFormat::alignment()
voidalignment=(Qt_QFlags_AlignmentFlag alignment)Method void QTextTableFormat::setAlignment(QFlags<Qt::AlignmentFlag> alignment)
[const]doublecellPaddingMethod double QTextTableFormat::cellPadding()
voidcellPadding=(double padding)Method void QTextTableFormat::setCellPadding(double padding)
[const]doublecellSpacingMethod double QTextTableFormat::cellSpacing()
voidcellSpacing=(double spacing)Method void QTextTableFormat::setCellSpacing(double spacing)
voidclearColumnWidthConstraintsMethod void QTextTableFormat::clearColumnWidthConstraints()
[const]QTextLength[]columnWidthConstraintsMethod QVector<QTextLength> QTextTableFormat::columnWidthConstraints()
voidcolumnWidthConstraints=(QTextLength[] constraints)Method void QTextTableFormat::setColumnWidthConstraints(const QVector<QTextLength> &constraints)
[const]intcolumnsMethod int QTextTableFormat::columns()
voidcolumns=(int columns)Method void QTextTableFormat::setColumns(int columns)
[const]intheaderRowCountMethod int QTextTableFormat::headerRowCount()
voidheaderRowCount=(int count)Method void QTextTableFormat::setHeaderRowCount(int count)
[const]boolisValid?Method bool QTextTableFormat::isValid()
voidsetAlignment(Qt_QFlags_AlignmentFlag alignment)Method void QTextTableFormat::setAlignment(QFlags<Qt::AlignmentFlag> alignment)
voidsetCellPadding(double padding)Method void QTextTableFormat::setCellPadding(double padding)
voidsetCellSpacing(double spacing)Method void QTextTableFormat::setCellSpacing(double spacing)
voidsetColumnWidthConstraints(QTextLength[] constraints)Method void QTextTableFormat::setColumnWidthConstraints(const QVector<QTextLength> &constraints)
voidsetColumns(int columns)Method void QTextTableFormat::setColumns(int columns)
voidsetHeaderRowCount(int count)Method void QTextTableFormat::setHeaderRowCount(int count)

Detailed description

_assign

Signature: void _assign (const QTextTableFormat other)

Description: Assigns another object to self

_const_cast

Signature: [const] QTextTableFormat 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.

_dup

Signature: [const] new QTextTableFormat ptr _dup

Description: Creates a copy of self

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

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

cellPadding

Signature: [const] double cellPadding

Description: Method double QTextTableFormat::cellPadding()

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

cellPadding=

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

cellSpacing

Signature: [const] double cellSpacing

Description: Method double QTextTableFormat::cellSpacing()

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

cellSpacing=

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

clearColumnWidthConstraints

Signature: void clearColumnWidthConstraints

Description: Method void QTextTableFormat::clearColumnWidthConstraints()

columnWidthConstraints

Signature: [const] QTextLength[] columnWidthConstraints

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

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

columnWidthConstraints=

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

columns

Signature: [const] int columns

Description: Method int QTextTableFormat::columns()

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

columns=

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

headerRowCount

Signature: [const] int headerRowCount

Description: Method int QTextTableFormat::headerRowCount()

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

headerRowCount=

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

isValid?

Signature: [const] bool isValid?

Description: Method bool QTextTableFormat::isValid()

new

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

setAlignment

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

setCellPadding

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

setCellSpacing

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

setColumnWidthConstraints

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

setColumns

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

setHeaderRowCount

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