API reference - Class QTextBlock

!=

Signature: [const] bool != (const QTextBlock o)

Description: Method bool QTextBlock::operator!=(const QTextBlock &o)

<

Signature: [const] bool < (const QTextBlock o)

Description: Method bool QTextBlock::operator<(const QTextBlock &o)

==

Signature: [const] bool == (const QTextBlock o)

Description: Method bool QTextBlock::operator==(const QTextBlock &o)

_assign

Signature: void _assign (const QTextBlock other)

Description: Assigns another object to self

_const_cast

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

assign

Signature: QTextBlock assign (const QTextBlock o)

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

begin

Signature: [const] QTextBlock_Iterator begin

Description: Method QTextBlock::iterator QTextBlock::begin()

blockFormat

Signature: [const] QTextBlockFormat blockFormat

Description: Method QTextBlockFormat QTextBlock::blockFormat()

blockFormatIndex

Signature: [const] int blockFormatIndex

Description: Method int QTextBlock::blockFormatIndex()

blockNumber

Signature: [const] int blockNumber

Description: Method int QTextBlock::blockNumber()

charFormat

Signature: [const] QTextCharFormat charFormat

Description: Method QTextCharFormat QTextBlock::charFormat()

charFormatIndex

Signature: [const] int charFormatIndex

Description: Method int QTextBlock::charFormatIndex()

clearLayout

Signature: void clearLayout

Description: Method void QTextBlock::clearLayout()

contains

Signature: [const] bool contains (int position)

Description: Method bool QTextBlock::contains(int position)

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.

document

Signature: [const] const QTextDocument ptr document

Description: Method const QTextDocument *QTextBlock::document()

dup

Signature: [const] new QTextBlock ptr dup

Description: Creates a copy of self

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

end

Signature: [const] QTextBlock_Iterator end

Description: Method QTextBlock::iterator QTextBlock::end()

firstLineNumber

Signature: [const] int firstLineNumber

Description: Method int QTextBlock::firstLineNumber()

fragmentIndex

Signature: [const] int fragmentIndex

Description: Method int QTextBlock::fragmentIndex()

isValid?

Signature: [const] bool isValid?

Description: Method bool QTextBlock::isValid()

isVisible?

Signature: [const] bool isVisible?

Description: Method bool QTextBlock::isVisible()

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

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.

layout

Signature: [const] QTextLayout ptr layout

Description: Method QTextLayout *QTextBlock::layout()

length

Signature: [const] int length

Description: Method int QTextBlock::length()

lineCount

Signature: [const] int lineCount

Description: Method int QTextBlock::lineCount()

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

lineCount=

Signature: void lineCount= (int count)

Description: Method void QTextBlock::setLineCount(int count)

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

new

(1) Signature: [static] new QTextBlock new

Description: Constructor QTextBlock::QTextBlock()

This method creates an object of class QTextBlock.

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

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

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

This method creates an object of class QTextBlock.

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

next

Signature: [const] QTextBlock next

Description: Method QTextBlock QTextBlock::next()

position

Signature: [const] int position

Description: Method int QTextBlock::position()

previous

Signature: [const] QTextBlock previous

Description: Method QTextBlock QTextBlock::previous()

revision

Signature: [const] int revision

Description: Method int QTextBlock::revision()

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

revision=

Signature: void revision= (int rev)

Description: Method void QTextBlock::setRevision(int rev)

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

setLineCount

Signature: void setLineCount (int count)

Description: Method void QTextBlock::setLineCount(int count)

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

setRevision

Signature: void setRevision (int rev)

Description: Method void QTextBlock::setRevision(int rev)

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

setUserData

Signature: void setUserData (QTextBlockUserData ptr data)

Description: Method void QTextBlock::setUserData(QTextBlockUserData *data)

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

setUserState

Signature: void setUserState (int state)

Description: Method void QTextBlock::setUserState(int state)

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

setVisible

Signature: void setVisible (bool visible)

Description: Method void QTextBlock::setVisible(bool visible)

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

text

Signature: [const] string text

Description: Method QString QTextBlock::text()

textDirection

Signature: [const] Qt_LayoutDirection textDirection

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

textFormats

Signature: [const] QTextLayout_FormatRange[] textFormats

Description: Method QVector<QTextLayout::FormatRange> QTextBlock::textFormats()

textList

Signature: [const] QTextList ptr textList

Description: Method QTextList *QTextBlock::textList()

userData

Signature: [const] QTextBlockUserData ptr userData

Description: Method QTextBlockUserData *QTextBlock::userData()

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

userData=

Signature: void userData= (QTextBlockUserData ptr data)

Description: Method void QTextBlock::setUserData(QTextBlockUserData *data)

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

userState

Signature: [const] int userState

Description: Method int QTextBlock::userState()

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

userState=

Signature: void userState= (int state)

Description: Method void QTextBlock::setUserState(int state)

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

visible

Signature: [const] bool visible

Description: Method bool QTextBlock::isVisible()

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

visible=

Signature: void visible= (bool visible)

Description: Method void QTextBlock::setVisible(bool visible)

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