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

API reference - Class QIcon

Notation used in Ruby API documentation

Description: Binding of QIcon

Public constructors

new QIconnewConstructor QIcon::QIcon()
new QIconnew(const QPixmap pixmap)Constructor QIcon::QIcon(const QPixmap &pixmap)
new QIconnew(const QIcon other)Constructor QIcon::QIcon(const QIcon &other)
new QIconnew(string fileName)Constructor QIcon::QIcon(const QString &fileName)
new QIconnew(QIconEngine ptr engine)Constructor QIcon::QIcon(QIconEngine *engine)
new QIconnew(QIconEngineV2 ptr engine)Constructor QIcon::QIcon(QIconEngineV2 *engine)

Public methods

[const]QSizeactualSize(const QSize size,
const QIcon_Mode mode = QIcon::Normal,
const QIcon_State state = QIcon::Off)		Method QSize QIcon::actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state)
voidaddFile(string fileName,
const QSize size = QSize(),
const QIcon_Mode mode = QIcon::Normal,
const QIcon_State state = QIcon::Off)		Method void QIcon::addFile(const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state)
voidaddPixmap(const QPixmap pixmap,
const QIcon_Mode mode = QIcon::Normal,
const QIcon_State state = QIcon::Off)		Method void QIcon::addPixmap(const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state)
QIconassign(const QIcon other)Method QIcon &QIcon::operator=(const QIcon &other)
[const]voidassign(const QIcon other)Assign the contents of another object to self
[const]QSize[]availableSizes(const QIcon_Mode mode = QIcon::Normal,
const QIcon_State state = QIcon::Off)		Method QList<QSize> QIcon::availableSizes(QIcon::Mode mode, QIcon::State state)
[const]long longcacheKeyMethod qint64 QIcon::cacheKey()
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
voiddetachMethod void QIcon::detach()
[const]QIcondupCreates a copy of self
[const]boolisDetachedMethod bool QIcon::isDetached()
[const]boolisDetached?Method bool QIcon::isDetached()
[const]boolisNullMethod bool QIcon::isNull()
[const]boolisNull?Method bool QIcon::isNull()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]voidpaint(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)		Method void QIcon::paint(QPainter *painter, const QRect &rect, QFlags<Qt::AlignmentFlag> alignment, QIcon::Mode mode, QIcon::State state)
[const]voidpaint(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)		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]QPixmappixmap(const QSize size,
const QIcon_Mode mode = QIcon::Normal,
const QIcon_State state = QIcon::Off)		Method QPixmap QIcon::pixmap(const QSize &size, QIcon::Mode mode, QIcon::State state)
[const]QPixmappixmap(int w,
int h,
const QIcon_Mode mode = QIcon::Normal,
const QIcon_State state = QIcon::Off)		Method QPixmap QIcon::pixmap(int w, int h, QIcon::Mode mode, QIcon::State state)
[const]QPixmappixmap_ext(int extent,
const QIcon_Mode mode = QIcon::Normal,
const QIcon_State state = QIcon::Off)		Method QPixmap QIcon::pixmap(int extent, QIcon::Mode mode, QIcon::State state)
[const]intserialNumberMethod int QIcon::serialNumber()

Public static methods and constants

QIcon_ModeActiveEnum constant QIcon::Active
QIcon_ModeDisabledEnum constant QIcon::Disabled
QIcon_ModeNormalEnum constant QIcon::Normal
QIcon_StateOffEnum constant QIcon::Off
QIcon_StateOnEnum constant QIcon::On
QIcon_ModeSelectedEnum constant QIcon::Selected
QIconfromTheme(string name,
const QIcon fallback = QIcon())		Static method QIcon QIcon::fromTheme(const QString &name, const QIcon &fallback)
boolhasThemeIcon(string name)Static method bool QIcon::hasThemeIcon(const QString &name)
voidsetThemeName(string path)Static method void QIcon::setThemeName(const QString &path)
voidsetThemeSearchPaths(string[] searchpath)Static method void QIcon::setThemeSearchPaths(const QStringList &searchpath)
stringthemeNameStatic method QString QIcon::themeName()
voidthemeName=(string path)Static method void QIcon::setThemeName(const QString &path)
string[]themeSearchPathsStatic method QStringList QIcon::themeSearchPaths()
voidthemeSearchPaths=(string[] searchpath)Static method void QIcon::setThemeSearchPaths(const QStringList &searchpath)

Detailed description

[static] QIcon_Mode Active

Description: Enum constant QIcon::Active

[static] QIcon_Mode Disabled

Description: Enum constant QIcon::Disabled

[static] QIcon_Mode Normal

Description: Enum constant QIcon::Normal

[static] QIcon_State Off

Description: Enum constant QIcon::Off

[static] QIcon_State On

Description: Enum constant QIcon::On

[static] QIcon_Mode Selected

Description: Enum constant QIcon::Selected

[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] void assign(const QIcon 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.

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

void detach

Description: Method void QIcon::detach()

[const] QIcon 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 isDetached?

Description: Method bool QIcon::isDetached()

[const] bool isNull

Description: Method bool QIcon::isNull()

[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

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[static] new QIcon new

Description: Constructor QIcon::QIcon()

This method creates an object of class QIcon.

[static] new QIcon new(const QPixmap pixmap)

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

This method creates an object of class QIcon.

[static] new QIcon new(const QIcon other)

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

This method creates an object of class QIcon.

[static] new QIcon new(string fileName)

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

This method creates an object of class QIcon.

[static] new QIcon new(QIconEngine ptr engine)

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

This method creates an object of class QIcon.

[static] new QIcon new(QIconEngineV2 ptr engine)

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

This method creates an object of class QIcon.

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

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

[static] string themeName

Description: Static method QString QIcon::themeName()

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

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

[static] string[] themeSearchPaths

Description: Static method QStringList QIcon::themeSearchPaths()

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

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