API reference - Class QTextFrame

_const_cast

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

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QTextFrame::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

childFrames

Signature: [const] QTextFrame ptr[] childFrames

Description: Method QList<QTextFrame *> QTextFrame::childFrames()

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.

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QTextFrame::customEvent(QEvent *)

This method can be reimplemented in a derived class.

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: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QTextFrame::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 (string signal)

Description: Virtual method void QTextFrame::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QTextFrame::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

firstCursorPosition

Signature: [const] QTextCursor firstCursorPosition

Description: Method QTextCursor QTextFrame::firstCursorPosition()

firstPosition

Signature: [const] int firstPosition

Description: Method int QTextFrame::firstPosition()

frameFormat

Signature: [const] QTextFrameFormat frameFormat

Description: Method QTextFrameFormat QTextFrame::frameFormat()

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

frameFormat=

Signature: void frameFormat= (const QTextFrameFormat format)

Description: Method void QTextFrame::setFrameFormat(const QTextFrameFormat &format)

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

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 QTextFrame::lastCursorPosition()

lastPosition

Signature: [const] int lastPosition

Description: Method int QTextFrame::lastPosition()

new

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

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

This method creates an object of class QTextFrame.

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

parentFrame

Signature: [const] QTextFrame ptr parentFrame

Description: Method QTextFrame *QTextFrame::parentFrame()

receivers

Signature: [const] int receivers (string signal)

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

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QTextFrame::sender()

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

setFormat

Signature: void setFormat (const QTextFormat format)

Description: Method void QTextFrame::setFormat(const QTextFormat &format)

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

setFrameFormat

Signature: void setFrameFormat (const QTextFrameFormat format)

Description: Method void QTextFrame::setFrameFormat(const QTextFrameFormat &format)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QTextFrame::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

tr

(1) Signature: [static] string tr (string s, string c = 0)

Description: Static method QString QTextFrame::tr(const char *s, const char *c)

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

(2) Signature: [static] string tr (string s, string c, int n)

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

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

trUtf8

(1) Signature: [static] string trUtf8 (string s, string c = 0)

Description: Static method QString QTextFrame::trUtf8(const char *s, const char *c)

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

(2) Signature: [static] string trUtf8 (string s, string c, int n)

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

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