KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QTextTable

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QTextTable

Class hierarchy: QTextTable » QTextFrame » QTextObject » QObject

Public constructors

new QTextTablenew(QTextDocument ptr doc)Constructor QTextTable::QTextTable(QTextDocument *doc)

Public methods

[const]QTextTable 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]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.
voidappendColumns(int count)Method void QTextTable::appendColumns(int count)
voidappendRows(int count)Method void QTextTable::appendRows(int count)
[const]QTextTableCellcellAt(int row,
int col)
Method QTextTableCell QTextTable::cellAt(int row, int col)
[const]QTextTableCellcellAt(int position)Method QTextTableCell QTextTable::cellAt(int position)
[const]QTextTableCellcellAt(const QTextCursor c)Method QTextTableCell QTextTable::cellAt(const QTextCursor &c)
[const]intcolumnsMethod int QTextTable::columns()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QTextTable::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QTextTable::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QTextTable::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QTextTable::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QTextTable::eventFilter(QObject *watched, QEvent *event)
[const]QTextTableFormatformatMethod QTextTableFormat QTextTable::format()
voidformat=(const QTextTableFormat format)Method void QTextTable::setFormat(const QTextTableFormat &format)
voidinsertColumns(int pos,
int num)
Method void QTextTable::insertColumns(int pos, int num)
voidinsertRows(int pos,
int num)
Method void QTextTable::insertRows(int pos, int num)
voidmergeCells(int row,
int col,
int numRows,
int numCols)
Method void QTextTable::mergeCells(int row, int col, int numRows, int numCols)
voidmergeCells(const QTextCursor cursor)Method void QTextTable::mergeCells(const QTextCursor &cursor)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QTextTable::objectNameChanged(const QString &objectName)
voidremoveColumns(int pos,
int num)
Method void QTextTable::removeColumns(int pos, int num)
voidremoveRows(int pos,
int num)
Method void QTextTable::removeRows(int pos, int num)
voidresize(int rows,
int cols)
Method void QTextTable::resize(int rows, int cols)
[const]QTextCursorrowEnd(const QTextCursor c)Method QTextCursor QTextTable::rowEnd(const QTextCursor &c)
[const]QTextCursorrowStart(const QTextCursor c)Method QTextCursor QTextTable::rowStart(const QTextCursor &c)
[const]introwsMethod int QTextTable::rows()
voidsetFormat(const QTextTableFormat format)Method void QTextTable::setFormat(const QTextTableFormat &format)
voidsplitCell(int row,
int col,
int numRows,
int numCols)
Method void QTextTable::splitCell(int row, int col, int numRows, int numCols)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QTextTable::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QTextTable::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QTextTable::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QTextTable::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QTextTable::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QTextTable::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QTextTable::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QTextTable::sender()
[const]intsenderSignalIndexMethod int QTextTable::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QTextTable::timerEvent(QTimerEvent *event)

Detailed description

_const_cast

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

appendColumns

Signature: void appendColumns (int count)

Description: Method void QTextTable::appendColumns(int count)

appendRows

Signature: void appendRows (int count)

Description: Method void QTextTable::appendRows(int count)

cellAt

(1) Signature: [const] QTextTableCell cellAt (int row, int col)

Description: Method QTextTableCell QTextTable::cellAt(int row, int col)

(2) Signature: [const] QTextTableCell cellAt (int position)

Description: Method QTextTableCell QTextTable::cellAt(int position)

(3) Signature: [const] QTextTableCell cellAt (const QTextCursor c)

Description: Method QTextTableCell QTextTable::cellAt(const QTextCursor &c)

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QTextTable::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

columns

Signature: [const] int columns

Description: Method int QTextTable::columns()

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QTextTable::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QTextTable::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QTextTable::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QTextTable::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QTextTable::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QTextTable::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QTextTable::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

format

Signature: [const] QTextTableFormat format

Description: Method QTextTableFormat QTextTable::format()

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

format=

Signature: void format= (const QTextTableFormat format)

Description: Method void QTextTable::setFormat(const QTextTableFormat &format)

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

insertColumns

Signature: void insertColumns (int pos, int num)

Description: Method void QTextTable::insertColumns(int pos, int num)

insertRows

Signature: void insertRows (int pos, int num)

Description: Method void QTextTable::insertRows(int pos, int num)

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QTextTable::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

mergeCells

(1) Signature: void mergeCells (int row, int col, int numRows, int numCols)

Description: Method void QTextTable::mergeCells(int row, int col, int numRows, int numCols)

(2) Signature: void mergeCells (const QTextCursor cursor)

Description: Method void QTextTable::mergeCells(const QTextCursor &cursor)

new

Signature: [static] new QTextTable new (QTextDocument ptr doc)

Description: Constructor QTextTable::QTextTable(QTextDocument *doc)

This method creates an object of class QTextTable.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QTextTable::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QTextTable::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

removeColumns

Signature: void removeColumns (int pos, int num)

Description: Method void QTextTable::removeColumns(int pos, int num)

removeRows

Signature: void removeRows (int pos, int num)

Description: Method void QTextTable::removeRows(int pos, int num)

resize

Signature: void resize (int rows, int cols)

Description: Method void QTextTable::resize(int rows, int cols)

rowEnd

Signature: [const] QTextCursor rowEnd (const QTextCursor c)

Description: Method QTextCursor QTextTable::rowEnd(const QTextCursor &c)

rowStart

Signature: [const] QTextCursor rowStart (const QTextCursor c)

Description: Method QTextCursor QTextTable::rowStart(const QTextCursor &c)

rows

Signature: [const] int rows

Description: Method int QTextTable::rows()

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QTextTable::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QTextTable::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setFormat

Signature: void setFormat (const QTextTableFormat format)

Description: Method void QTextTable::setFormat(const QTextTableFormat &format)

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

splitCell

Signature: void splitCell (int row, int col, int numRows, int numCols)

Description: Method void QTextTable::splitCell(int row, int col, int numRows, int numCols)

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QTextTable::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QTextTable::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QTextTable::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.