API reference - Class QIconEngine

Notation used in Ruby API documentation

Description: Binding of QIconEngine

Class hierarchy: QIconEngine

Public constructors

new QIconEnginenewConstructor QIconEngine::QIconEngine()

Public methods

[virtual]QSizeactualSize(const QSize size,
const QIcon_Mode mode,
const QIcon_State state)
Virtual method QSize QIconEngine::actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state)
[virtual]voidaddFile(string fileName,
const QSize size,
const QIcon_Mode mode,
const QIcon_State state)
Virtual method void QIconEngine::addFile(const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state)
[virtual]voidaddPixmap(const QPixmap pixmap,
const QIcon_Mode mode,
const QIcon_State state)
Virtual method void QIconEngine::addPixmap(const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state)
[const]voidassign(const QIconEngine other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QIconEnginedupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[virtual]voidpaint(QPainter ptr painter,
const QRect rect,
const QIcon_Mode mode,
const QIcon_State state)
Virtual method void QIconEngine::paint(QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state)
[virtual]QPixmappixmap(const QSize size,
const QIcon_Mode mode,
const QIcon_State state)
Virtual method QPixmap QIconEngine::pixmap(const QSize &size, QIcon::Mode mode, QIcon::State state)

Detailed description

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

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

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

[const] void assign(const QIconEngine other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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 destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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] QIconEngine dup

Description: Creates a copy of self

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

[static] new QIconEngine new

Description: Constructor QIconEngine::QIconEngine()

This method creates an object of class QIconEngine.

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

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