API reference - Class QTextTableCell

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QTextTableCell

Public constructors

new QTextTableCellnewConstructor QTextTableCell::QTextTableCell()
new QTextTableCellnew(const QTextTableCell o)Constructor QTextTableCell::QTextTableCell(const QTextTableCell &o)

Public methods

[const]bool!=(const QTextTableCell other)Method bool QTextTableCell::operator!=(const QTextTableCell &other)
[const]bool==(const QTextTableCell other)Method bool QTextTableCell::operator==(const QTextTableCell &other)
void_assign(const QTextTableCell other)Assigns another object 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.
QTextTableCellassign(const QTextTableCell o)Method QTextTableCell &QTextTableCell::operator=(const QTextTableCell &o)
[const]intcolumnMethod int QTextTableCell::column()
[const]intcolumnSpanMethod int QTextTableCell::columnSpan()
[const]new QTextTableCell ptrdupCreates a copy of self
[const]QTextCursorfirstCursorPositionMethod QTextCursor QTextTableCell::firstCursorPosition()
[const]intfirstPositionMethod int QTextTableCell::firstPosition()
[const]QTextCharFormatformatMethod QTextCharFormat QTextTableCell::format()
voidformat=(const QTextCharFormat format)Method void QTextTableCell::setFormat(const QTextCharFormat &format)
[const]boolisValid?Method bool QTextTableCell::isValid()
[const]QTextCursorlastCursorPositionMethod QTextCursor QTextTableCell::lastCursorPosition()
[const]intlastPositionMethod int QTextTableCell::lastPosition()
[const]introwMethod int QTextTableCell::row()
[const]introwSpanMethod int QTextTableCell::rowSpan()
voidsetFormat(const QTextCharFormat format)Method void QTextTableCell::setFormat(const QTextCharFormat &format)
[const]inttableCellFormatIndexMethod int QTextTableCell::tableCellFormatIndex()

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

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QTextTableCell other)

Description: Method bool QTextTableCell::operator!=(const QTextTableCell &other)

==

Signature: [const] bool == (const QTextTableCell other)

Description: Method bool QTextTableCell::operator==(const QTextTableCell &other)

_assign

Signature: void _assign (const QTextTableCell other)

Description: Assigns another object to self

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

assign

Signature: QTextTableCell assign (const QTextTableCell o)

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

column

Signature: [const] int column

Description: Method int QTextTableCell::column()

columnSpan

Signature: [const] int columnSpan

Description: Method int QTextTableCell::columnSpan()

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

Description: Creates a copy of self

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

firstCursorPosition

Signature: [const] QTextCursor firstCursorPosition

Description: Method QTextCursor QTextTableCell::firstCursorPosition()

firstPosition

Signature: [const] int firstPosition

Description: Method int QTextTableCell::firstPosition()

format

Signature: [const] QTextCharFormat format

Description: Method QTextCharFormat QTextTableCell::format()

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

format=

Signature: void format= (const QTextCharFormat format)

Description: Method void QTextTableCell::setFormat(const QTextCharFormat &format)

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

isValid?

Signature: [const] bool isValid?

Description: Method bool QTextTableCell::isValid()

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.

lastCursorPosition

Signature: [const] QTextCursor lastCursorPosition

Description: Method QTextCursor QTextTableCell::lastCursorPosition()

lastPosition

Signature: [const] int lastPosition

Description: Method int QTextTableCell::lastPosition()

new

(1) Signature: [static] new QTextTableCell new

Description: Constructor QTextTableCell::QTextTableCell()

This method creates an object of class QTextTableCell.

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

(2) Signature: [static] new QTextTableCell new (const QTextTableCell o)

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

This method creates an object of class QTextTableCell.

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

row

Signature: [const] int row

Description: Method int QTextTableCell::row()

rowSpan

Signature: [const] int rowSpan

Description: Method int QTextTableCell::rowSpan()

setFormat

Signature: void setFormat (const QTextCharFormat format)

Description: Method void QTextTableCell::setFormat(const QTextCharFormat &format)

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

tableCellFormatIndex

Signature: [const] int tableCellFormatIndex

Description: Method int QTextTableCell::tableCellFormatIndex()