KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QTextImageFormat

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QTextImageFormat

Class hierarchy: QTextImageFormat » QTextCharFormat » QTextFormat

Public constructors

new QTextImageFormatnewConstructor QTextImageFormat::QTextImageFormat()

Public methods

void_assign(const QTextImageFormat other)Assigns another object to self
[const]QTextImageFormat 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]new QTextImageFormat ptr_dupCreates a copy of self
[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]doubleheightMethod double QTextImageFormat::height()
voidheight=(double height)Method void QTextImageFormat::setHeight(double height)
[const]boolisValid?Method bool QTextImageFormat::isValid()
[const]stringnameMethod QString QTextImageFormat::name()
voidname=(string name)Method void QTextImageFormat::setName(const QString &name)
[const]intqualityMethod int QTextImageFormat::quality()
voidquality=(int quality = 100)Method void QTextImageFormat::setQuality(int quality)
voidsetHeight(double height)Method void QTextImageFormat::setHeight(double height)
voidsetName(string name)Method void QTextImageFormat::setName(const QString &name)
voidsetQuality(int quality = 100)Method void QTextImageFormat::setQuality(int quality)
voidsetWidth(double width)Method void QTextImageFormat::setWidth(double width)
[const]doublewidthMethod double QTextImageFormat::width()
voidwidth=(double width)Method void QTextImageFormat::setWidth(double width)

Detailed description

_assign

Signature: void _assign (const QTextImageFormat other)

Description: Assigns another object to self

_const_cast

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

_dup

Signature: [const] new QTextImageFormat ptr _dup

Description: Creates a copy of self

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

height

Signature: [const] double height

Description: Method double QTextImageFormat::height()

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

height=

Signature: void height= (double height)

Description: Method void QTextImageFormat::setHeight(double height)

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

isValid?

Signature: [const] bool isValid?

Description: Method bool QTextImageFormat::isValid()

name

Signature: [const] string name

Description: Method QString QTextImageFormat::name()

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

name=

Signature: void name= (string name)

Description: Method void QTextImageFormat::setName(const QString &name)

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

new

Signature: [static] new QTextImageFormat new

Description: Constructor QTextImageFormat::QTextImageFormat()

This method creates an object of class QTextImageFormat.

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

quality

Signature: [const] int quality

Description: Method int QTextImageFormat::quality()

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

quality=

Signature: void quality= (int quality = 100)

Description: Method void QTextImageFormat::setQuality(int quality)

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

setHeight

Signature: void setHeight (double height)

Description: Method void QTextImageFormat::setHeight(double height)

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

setName

Signature: void setName (string name)

Description: Method void QTextImageFormat::setName(const QString &name)

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

setQuality

Signature: void setQuality (int quality = 100)

Description: Method void QTextImageFormat::setQuality(int quality)

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

setWidth

Signature: void setWidth (double width)

Description: Method void QTextImageFormat::setWidth(double width)

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

width

Signature: [const] double width

Description: Method double QTextImageFormat::width()

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

width=

Signature: void width= (double width)

Description: Method void QTextImageFormat::setWidth(double width)

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