API reference - Class QIconEngine

_const_cast

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

actualSize

Signature: QSize actualSize (const QSize size, const QIcon_Mode mode, const QIcon_State state)

Description: Virtual method QSize QIconEngine::actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state)

This method can be reimplemented in a derived class.

addFile

Signature: void addFile (string fileName, const QSize size, const QIcon_Mode mode, const QIcon_State state)

Description: Virtual method void QIconEngine::addFile(const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state)

This method can be reimplemented in a derived class.

addPixmap

Signature: void addPixmap (const QPixmap pixmap, const QIcon_Mode mode, const QIcon_State state)

Description: Virtual method void QIconEngine::addPixmap(const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state)

This method can be reimplemented in a derived class.

assign

Signature: void assign (const QIconEngine other)

Description: Assigns another object to self

availableSizes

Signature: [const] QSize[] availableSizes (const QIcon_Mode mode, const QIcon_State state)

Description: Virtual method QList<QSize> QIconEngine::availableSizes(QIcon::Mode mode, QIcon::State state)

This method can be reimplemented in a derived class.

clone

Signature: [const] QIconEngine ptr clone

Description: Virtual method QIconEngine *QIconEngine::clone()

This method can be reimplemented in a derived class.

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

Description: Creates a copy of self

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

iconName

Signature: [const] string iconName

Description: Virtual method QString QIconEngine::iconName()

This method can be reimplemented in a derived class.

isNull?

Signature: [const] bool isNull?

Description: Method bool QIconEngine::isNull()

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.

key

Signature: [const] string key

Description: Virtual method QString QIconEngine::key()

This method can be reimplemented in a derived class.

new

(1) Signature: [static] new QIconEngine new

Description: Constructor QIconEngine::QIconEngine()

This method creates an object of class QIconEngine.

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

(2) Signature: [static] new QIconEngine new (const QIconEngine other)

Description: Constructor QIconEngine::QIconEngine(const QIconEngine &other)

This method creates an object of class QIconEngine.

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

paint

Signature: void paint (QPainter ptr painter, const QRect rect, const QIcon_Mode mode, const QIcon_State state)

Description: Virtual method void QIconEngine::paint(QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state)

This method can be reimplemented in a derived class.

pixmap

Signature: QPixmap pixmap (const QSize size, const QIcon_Mode mode, const QIcon_State state)

Description: Virtual method QPixmap QIconEngine::pixmap(const QSize &size, QIcon::Mode mode, QIcon::State state)

This method can be reimplemented in a derived class.

read

Signature: bool read (QDataStream in)

Description: Virtual method bool QIconEngine::read(QDataStream &in)

This method can be reimplemented in a derived class.

scaledPixmap

Signature: QPixmap scaledPixmap (const QSize size, const QIcon_Mode mode, const QIcon_State state, double scale)

Description: Method QPixmap QIconEngine::scaledPixmap(const QSize &size, QIcon::Mode mode, QIcon::State state, double scale)

virtual_hook

Signature: void virtual_hook (int id, void * data)

Description: Virtual method void QIconEngine::virtual_hook(int id, void *data)

This method can be reimplemented in a derived class.

write

Signature: [const] bool write (QDataStream out)

Description: Virtual method bool QIconEngine::write(QDataStream &out)

This method can be reimplemented in a derived class.