API reference - Class QIcon

Active

Signature: [static,const] QIcon_Mode Active

Description: Enum constant QIcon::Active

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

Disabled

Signature: [static,const] QIcon_Mode Disabled

Description: Enum constant QIcon::Disabled

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

Normal

Signature: [static,const] QIcon_Mode Normal

Description: Enum constant QIcon::Normal

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

Off

Signature: [static,const] QIcon_State Off

Description: Enum constant QIcon::Off

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

On

Signature: [static,const] QIcon_State On

Description: Enum constant QIcon::On

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

Selected

Signature: [static,const] QIcon_Mode Selected

Description: Enum constant QIcon::Selected

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

_assign

Signature: void _assign (const QIcon other)

Description: Assigns another object to self

_const_cast

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

(1) Signature: [const] QSize actualSize (const QSize size, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

Description: Method QSize QIcon::actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state)

(2) Signature: [const] QSize actualSize (QWindow ptr window, const QSize size, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

Description: Method QSize QIcon::actualSize(QWindow *window, const QSize &size, QIcon::Mode mode, QIcon::State state)

addFile

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

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

addPixmap

Signature: void addPixmap (const QPixmap pixmap, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

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

assign

Signature: QIcon assign (const QIcon other)

Description: Method QIcon &QIcon::operator=(const QIcon &other)

availableSizes

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

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

cacheKey

Signature: [const] long long cacheKey

Description: Method qint64 QIcon::cacheKey()

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.

detach

Signature: void detach

Description: Method void QIcon::detach()

dup

Signature: [const] new QIcon ptr dup

Description: Creates a copy of self

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

fallbackSearchPaths

Signature: [static] string[] fallbackSearchPaths

Description: Static method QStringList QIcon::fallbackSearchPaths()

This method is static and can be called without an instance.

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

fallbackSearchPaths=

Signature: [static] void fallbackSearchPaths= (string[] paths)

Description: Static method void QIcon::setFallbackSearchPaths(const QStringList &paths)

This method is static and can be called without an instance.

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

fallbackThemeName

Signature: [static] string fallbackThemeName

Description: Static method QString QIcon::fallbackThemeName()

This method is static and can be called without an instance.

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

fallbackThemeName=

Signature: [static] void fallbackThemeName= (string name)

Description: Static method void QIcon::setFallbackThemeName(const QString &name)

This method is static and can be called without an instance.

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

fromTheme

(1) Signature: [static] QIcon fromTheme (string name)

Description: Static method QIcon QIcon::fromTheme(const QString &name)

This method is static and can be called without an instance.

(2) Signature: [static] QIcon fromTheme (string name, const QIcon fallback)

Description: Static method QIcon QIcon::fromTheme(const QString &name, const QIcon &fallback)

This method is static and can be called without an instance.

hasThemeIcon

Signature: [static] bool hasThemeIcon (string name)

Description: Static method bool QIcon::hasThemeIcon(const QString &name)

This method is static and can be called without an instance.

isDetached?

Signature: [const] bool isDetached?

Description: Method bool QIcon::isDetached()

isMask?

Signature: [const] bool isMask?

Description: Method bool QIcon::isMask()

isNull?

Signature: [const] bool isNull?

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

name

Signature: [const] string name

Description: Method QString QIcon::name()

new

(1) Signature: [static] new QIcon new

Description: Constructor QIcon::QIcon()

This method creates an object of class QIcon.

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

(2) Signature: [static] new QIcon new (const QPixmap pixmap)

Description: Constructor QIcon::QIcon(const QPixmap &pixmap)

This method creates an object of class QIcon.

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

(3) Signature: [static] new QIcon new (const QIcon other)

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

This method creates an object of class QIcon.

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

(4) Signature: [static] new QIcon new (string fileName)

Description: Constructor QIcon::QIcon(const QString &fileName)

This method creates an object of class QIcon.

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

(5) Signature: [static] new QIcon new (QIconEngine ptr engine)

Description: Constructor QIcon::QIcon(QIconEngine *engine)

This method creates an object of class QIcon.

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

paint

(1) Signature: [const] void paint (QPainter ptr painter, const QRect rect, Qt_QFlags_AlignmentFlag alignment = Qt::AlignCenter, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

Description: Method void QIcon::paint(QPainter *painter, const QRect &rect, QFlags<Qt::AlignmentFlag> alignment, QIcon::Mode mode, QIcon::State state)

(2) Signature: [const] void paint (QPainter ptr painter, int x, int y, int w, int h, Qt_QFlags_AlignmentFlag alignment = Qt::AlignCenter, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

Description: Method void QIcon::paint(QPainter *painter, int x, int y, int w, int h, QFlags<Qt::AlignmentFlag> alignment, QIcon::Mode mode, QIcon::State state)

pixmap

(1) Signature: [const] QPixmap pixmap (const QSize size, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

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

(2) Signature: [const] QPixmap pixmap (int w, int h, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

Description: Method QPixmap QIcon::pixmap(int w, int h, QIcon::Mode mode, QIcon::State state)

(3) Signature: [const] QPixmap pixmap (QWindow ptr window, const QSize size, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

Description: Method QPixmap QIcon::pixmap(QWindow *window, const QSize &size, QIcon::Mode mode, QIcon::State state)

pixmap_ext

Signature: [const] QPixmap pixmap_ext (int extent, const QIcon_Mode mode = QIcon::Normal, const QIcon_State state = QIcon::Off)

Description: Method QPixmap QIcon::pixmap(int extent, QIcon::Mode mode, QIcon::State state)

setFallbackSearchPaths

Signature: [static] void setFallbackSearchPaths (string[] paths)

Description: Static method void QIcon::setFallbackSearchPaths(const QStringList &paths)

This method is static and can be called without an instance.

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

setFallbackThemeName

Signature: [static] void setFallbackThemeName (string name)

Description: Static method void QIcon::setFallbackThemeName(const QString &name)

This method is static and can be called without an instance.

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

setIsMask

Signature: void setIsMask (bool isMask)

Description: Method void QIcon::setIsMask(bool isMask)

setThemeName

Signature: [static] void setThemeName (string path)

Description: Static method void QIcon::setThemeName(const QString &path)

This method is static and can be called without an instance.

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

setThemeSearchPaths

Signature: [static] void setThemeSearchPaths (string[] searchpath)

Description: Static method void QIcon::setThemeSearchPaths(const QStringList &searchpath)

This method is static and can be called without an instance.

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

swap

Signature: void swap (QIcon other)

Description: Method void QIcon::swap(QIcon &other)

themeName

Signature: [static] string themeName

Description: Static method QString QIcon::themeName()

This method is static and can be called without an instance.

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

themeName=

Signature: [static] void themeName= (string path)

Description: Static method void QIcon::setThemeName(const QString &path)

This method is static and can be called without an instance.

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

themeSearchPaths

Signature: [static] string[] themeSearchPaths

Description: Static method QStringList QIcon::themeSearchPaths()

This method is static and can be called without an instance.

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

themeSearchPaths=

Signature: [static] void themeSearchPaths= (string[] searchpath)

Description: Static method void QIcon::setThemeSearchPaths(const QStringList &searchpath)

This method is static and can be called without an instance.

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