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

API reference - Class QIcon

Notation used in Ruby API documentation

Description: Binding of QIcon

Sub-classes: Mode, State

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

Public constructors

Public methods

Public static methods and constants

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

Detailed description

[static,const] new QIcon_Mode ptr Active

Description: Enum constant QIcon::Active

[static,const] new QIcon_Mode ptr Disabled

Description: Enum constant QIcon::Disabled

[static,const] new QIcon_Mode ptr Normal

Description: Enum constant QIcon::Normal

[static,const] new QIcon_State ptr Off

Description: Enum constant QIcon::Off

[static,const] new QIcon_State ptr On

Description: Enum constant QIcon::On

[static,const] new QIcon_Mode ptr Selected

Description: Enum constant QIcon::Selected

void _assign(const QIcon other)

Description: Assigns another object to self

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.

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

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)

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)

QIcon assign(const QIcon other)

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

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

[const] long long cacheKey

Description: Method qint64 QIcon::cacheKey()

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

void detach

Description: Method void QIcon::detach()

[const] new QIcon ptr dup

Description: Creates a copy of self

[static] QIcon fromTheme(string name,const QIcon fallback = QIcon())

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

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

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

[const] bool isDetached?

Description: Method bool QIcon::isDetached()

[const] bool isNull?

Description: Method bool QIcon::isNull()

[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

[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

[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

[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

[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

[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

[static] new QIcon new(QIconEngineV2 ptr engine)

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

This method creates an object of class QIcon.

Python specific notes:

This method is the default initializer of the object

[const] void paint(QPainter ptr painter,const QRect rect,const 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)

[const] void paint(QPainter ptr painter,int x,int y,int w,int h,const 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)

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

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

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

[const] int serialNumber

Description: Method int QIcon::serialNumber()

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

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

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

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

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

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