KLayout Manual: Main Index » Class Index » API reference - Class QIconEngineV2

API reference - Class QIconEngineV2

Notation used in Ruby API documentation

Description: Binding of QIconEngineV2

Class hierarchy: QIconEngineV2 » QIconEngine

• Public constructors
• Public methods
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

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.

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.

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

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

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.

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.

[virtual] QSize actualSize(const QSize size,const QIcon_Mode mode,const QIcon_State state)

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

This method can be reimplemented in a derived class.

[virtual] void addFile(string fileName,const QSize size,const QIcon_Mode mode,const QIcon_State state)

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

This method can be reimplemented in a derived class.

[virtual] void addPixmap(const QPixmap pixmap,const QIcon_Mode mode,const QIcon_State state)

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

This method can be reimplemented in a derived class.

void assign(const QIconEngineV2 other)

Description: Assigns another object to self

QSize[] availableSizes(const QIcon_Mode mode = QIcon::Normal,const QIcon_State state = QIcon::Off)

Description: Method QList<QSize> QIconEngineV2::availableSizes(QIcon::Mode mode, QIcon::State state)

[virtual,const] QIconEngineV2 ptr clone

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

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new QIconEngineV2 ptr dup

Description: Creates a copy of self

[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

[virtual,const] string key

Description: Virtual method QString QIconEngineV2::key()

This method can be reimplemented in a derived class.

[static] new QIconEngineV2 new

Description: Constructor QIconEngineV2::QIconEngineV2()

This method creates an object of class QIconEngineV2.

Python specific notes:

This method is the default initializer of the object

[virtual] void paint(QPainter ptr painter,const QRect rect,const QIcon_Mode mode,const QIcon_State state)

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

This method can be reimplemented in a derived class.

[virtual] QPixmap pixmap(const QSize size,const QIcon_Mode mode,const QIcon_State state)

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

This method can be reimplemented in a derived class.

[virtual] bool read(QDataStream in)

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

This method can be reimplemented in a derived class.

[virtual] void virtual_hook(int id,void * data)

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

This method can be reimplemented in a derived class.

[virtual,const] bool write(QDataStream out)

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

This method can be reimplemented in a derived class.