API reference - Class QTextInlineObject

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QTextInlineObject

Public constructors

new QTextInlineObjectnewConstructor QTextInlineObject::QTextInlineObject()

Public methods

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.
[const]doubleascentMethod double QTextInlineObject::ascent()
voidascent=(double a)Method void QTextInlineObject::setAscent(double a)
voidassign(const QTextInlineObject other)Assigns another object to self
[const]doubledescentMethod double QTextInlineObject::descent()
voiddescent=(double d)Method void QTextInlineObject::setDescent(double d)
[const]new QTextInlineObject ptrdupCreates a copy of self
[const]QTextFormatformatMethod QTextFormat QTextInlineObject::format()
[const]intformatIndexMethod int QTextInlineObject::formatIndex()
[const]doubleheightMethod double QTextInlineObject::height()
[const]boolisValid?Method bool QTextInlineObject::isValid()
[const]QRectFrectMethod QRectF QTextInlineObject::rect()
voidsetAscent(double a)Method void QTextInlineObject::setAscent(double a)
voidsetDescent(double d)Method void QTextInlineObject::setDescent(double d)
voidsetWidth(double w)Method void QTextInlineObject::setWidth(double w)
[const]Qt_LayoutDirectiontextDirectionMethod Qt::LayoutDirection QTextInlineObject::textDirection()
[const]inttextPositionMethod int QTextInlineObject::textPosition()
[const]doublewidthMethod double QTextInlineObject::width()
voidwidth=(double w)Method void QTextInlineObject::setWidth(double w)

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

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

ascent

Signature: [const] double ascent

Description: Method double QTextInlineObject::ascent()

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

ascent=

Signature: void ascent= (double a)

Description: Method void QTextInlineObject::setAscent(double a)

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

assign

Signature: void assign (const QTextInlineObject other)

Description: Assigns another object to self

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.

descent

Signature: [const] double descent

Description: Method double QTextInlineObject::descent()

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

descent=

Signature: void descent= (double d)

Description: Method void QTextInlineObject::setDescent(double d)

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

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

Description: Creates a copy of self

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

format

Signature: [const] QTextFormat format

Description: Method QTextFormat QTextInlineObject::format()

formatIndex

Signature: [const] int formatIndex

Description: Method int QTextInlineObject::formatIndex()

height

Signature: [const] double height

Description: Method double QTextInlineObject::height()

isValid?

Signature: [const] bool isValid?

Description: Method bool QTextInlineObject::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.

new

Signature: [static] new QTextInlineObject new

Description: Constructor QTextInlineObject::QTextInlineObject()

This method creates an object of class QTextInlineObject.

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

rect

Signature: [const] QRectF rect

Description: Method QRectF QTextInlineObject::rect()

setAscent

Signature: void setAscent (double a)

Description: Method void QTextInlineObject::setAscent(double a)

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

setDescent

Signature: void setDescent (double d)

Description: Method void QTextInlineObject::setDescent(double d)

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

setWidth

Signature: void setWidth (double w)

Description: Method void QTextInlineObject::setWidth(double w)

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

textDirection

Signature: [const] Qt_LayoutDirection textDirection

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

textPosition

Signature: [const] int textPosition

Description: Method int QTextInlineObject::textPosition()

width

Signature: [const] double width

Description: Method double QTextInlineObject::width()

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

width=

Signature: void width= (double w)

Description: Method void QTextInlineObject::setWidth(double w)

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