API reference - Class QSystemTrayIcon

Notation used in Ruby API documentation

Description: Binding of QSystemTrayIcon

Class hierarchy: QSystemTrayIcon » QObject

Public constructors

new QSystemTrayIconnew(QObject ptr parent = 0)Constructor QSystemTrayIcon::QSystemTrayIcon(QObject *parent)
new QSystemTrayIconnew(const QIcon icon,
QObject ptr parent = 0)
Constructor QSystemTrayIcon::QSystemTrayIcon(const QIcon &icon, QObject *parent)

Public methods

[event]voidactivated(const QSystemTrayIcon_ActivationReason reason)Signal declaration for QSystemTrayIcon::activated(QSystemTrayIcon::ActivationReason reason)
[const]QMenu ptrcontextMenuMethod QMenu *QSystemTrayIcon::contextMenu()
voidcontextMenu=(QMenu ptr menu)Method void QSystemTrayIcon::setContextMenu(QMenu *menu)
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QSystemTrayIcon::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QSystemTrayIcon::eventFilter(QObject *, QEvent *)
[const]QRectgeometryMethod QRect QSystemTrayIcon::geometry()
voidhideMethod void QSystemTrayIcon::hide()
[const]QIconiconMethod QIcon QSystemTrayIcon::icon()
voidicon=(const QIcon icon)Method void QSystemTrayIcon::setIcon(const QIcon &icon)
[const]boolisVisibleMethod bool QSystemTrayIcon::isVisible()
[const]boolisVisible?Method bool QSystemTrayIcon::isVisible()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[event]voidmessageClickedSignal declaration for QSystemTrayIcon::messageClicked()
voidsetContextMenu(QMenu ptr menu)Method void QSystemTrayIcon::setContextMenu(QMenu *menu)
voidsetIcon(const QIcon icon)Method void QSystemTrayIcon::setIcon(const QIcon &icon)
voidsetToolTip(string tip)Method void QSystemTrayIcon::setToolTip(const QString &tip)
voidsetVisible(bool visible)Method void QSystemTrayIcon::setVisible(bool visible)
voidshowMethod void QSystemTrayIcon::show()
voidshowMessage(string title,
string msg,
const QSystemTrayIcon_MessageIcon icon = QSystemTrayIcon::Information,
int msecs = 10000)
Method void QSystemTrayIcon::showMessage(const QString &title, const QString &msg, QSystemTrayIcon::MessageIcon icon, int msecs)
[const]stringtoolTipMethod QString QSystemTrayIcon::toolTip()
voidtoolTip=(string tip)Method void QSystemTrayIcon::setToolTip(const QString &tip)
voidvisible=(bool visible)Method void QSystemTrayIcon::setVisible(bool visible)

Public static methods and constants

QSystemTrayIcon_ActivationReasonContextEnum constant QSystemTrayIcon::Context
QSystemTrayIcon_MessageIconCriticalEnum constant QSystemTrayIcon::Critical
QSystemTrayIcon_ActivationReasonDoubleClickEnum constant QSystemTrayIcon::DoubleClick
QSystemTrayIcon_MessageIconInformationEnum constant QSystemTrayIcon::Information
QSystemTrayIcon_ActivationReasonMiddleClickEnum constant QSystemTrayIcon::MiddleClick
QSystemTrayIcon_MessageIconNoIconEnum constant QSystemTrayIcon::NoIcon
QSystemTrayIcon_ActivationReasonTriggerEnum constant QSystemTrayIcon::Trigger
QSystemTrayIcon_ActivationReasonUnknownEnum constant QSystemTrayIcon::Unknown
QSystemTrayIcon_MessageIconWarningEnum constant QSystemTrayIcon::Warning
boolisSystemTrayAvailableStatic method bool QSystemTrayIcon::isSystemTrayAvailable()
boolisSystemTrayAvailable?Static method bool QSystemTrayIcon::isSystemTrayAvailable()
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
boolsupportsMessagesStatic method bool QSystemTrayIcon::supportsMessages()
stringtr(string s,
string c = 0)
Static method QString QSystemTrayIcon::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QSystemTrayIcon::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QSystemTrayIcon::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QSystemTrayIcon::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QSystemTrayIcon::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QSystemTrayIcon::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QSystemTrayIcon::disconnectNotify(const char *signal)
[virtual]boolevent(QEvent ptr event)Virtual method bool QSystemTrayIcon::event(QEvent *event)
[const]intreceivers(string signal)Method int QSystemTrayIcon::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QSystemTrayIcon::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QSystemTrayIcon::timerEvent(QTimerEvent *)

Detailed description

[static] QSystemTrayIcon_ActivationReason Context

Description: Enum constant QSystemTrayIcon::Context

[static] QSystemTrayIcon_MessageIcon Critical

Description: Enum constant QSystemTrayIcon::Critical

[static] QSystemTrayIcon_ActivationReason DoubleClick

Description: Enum constant QSystemTrayIcon::DoubleClick

[static] QSystemTrayIcon_MessageIcon Information

Description: Enum constant QSystemTrayIcon::Information

[static] QSystemTrayIcon_ActivationReason MiddleClick

Description: Enum constant QSystemTrayIcon::MiddleClick

[static] QSystemTrayIcon_MessageIcon NoIcon

Description: Enum constant QSystemTrayIcon::NoIcon

[static] QSystemTrayIcon_ActivationReason Trigger

Description: Enum constant QSystemTrayIcon::Trigger

[static] QSystemTrayIcon_ActivationReason Unknown

Description: Enum constant QSystemTrayIcon::Unknown

[static] QSystemTrayIcon_MessageIcon Warning

Description: Enum constant QSystemTrayIcon::Warning

[event] void activated(const QSystemTrayIcon_ActivationReason reason)

Description: Signal declaration for QSystemTrayIcon::activated(QSystemTrayIcon::ActivationReason reason)

You can bind a procedure to this signal.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QSystemTrayIcon::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

[const] QMenu ptr contextMenu

Description: Method QMenu *QSystemTrayIcon::contextMenu()

void contextMenu=(QMenu ptr menu)

Description: Method void QSystemTrayIcon::setContextMenu(QMenu *menu)

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.

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QSystemTrayIcon::customEvent(QEvent *)

This method can be reimplemented in a derived class.

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.

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QSystemTrayIcon::destroyed(QObject *)

You can bind a procedure to this signal.

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

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QSystemTrayIcon::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr event)

Description: Virtual method bool QSystemTrayIcon::event(QEvent *event)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QSystemTrayIcon::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[const] QRect geometry

Description: Method QRect QSystemTrayIcon::geometry()

void hide

Description: Method void QSystemTrayIcon::hide()

[const] QIcon icon

Description: Method QIcon QSystemTrayIcon::icon()

void icon=(const QIcon icon)

Description: Method void QSystemTrayIcon::setIcon(const QIcon &icon)

[static] bool isSystemTrayAvailable

Description: Static method bool QSystemTrayIcon::isSystemTrayAvailable()

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

[static] bool isSystemTrayAvailable?

Description: Static method bool QSystemTrayIcon::isSystemTrayAvailable()

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

[const] bool isVisible

Description: Method bool QSystemTrayIcon::isVisible()

[const] bool isVisible?

Description: Method bool QSystemTrayIcon::isVisible()

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

[event] void messageClicked

Description: Signal declaration for QSystemTrayIcon::messageClicked()

You can bind a procedure to this signal.

[static] new QSystemTrayIcon new(QObject ptr parent = 0)

Description: Constructor QSystemTrayIcon::QSystemTrayIcon(QObject *parent)

This method creates an object of class QSystemTrayIcon.

[static] new QSystemTrayIcon new(const QIcon icon,QObject ptr parent = 0)

Description: Constructor QSystemTrayIcon::QSystemTrayIcon(const QIcon &icon, QObject *parent)

This method creates an object of class QSystemTrayIcon.

[const] int receivers(string signal)

Description: Method int QSystemTrayIcon::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

[const] QObject ptr sender

Description: Method QObject *QSystemTrayIcon::sender()

This method is protected and can only be called from inside a derived class.

void setContextMenu(QMenu ptr menu)

Description: Method void QSystemTrayIcon::setContextMenu(QMenu *menu)

void setIcon(const QIcon icon)

Description: Method void QSystemTrayIcon::setIcon(const QIcon &icon)

void setToolTip(string tip)

Description: Method void QSystemTrayIcon::setToolTip(const QString &tip)

void setVisible(bool visible)

Description: Method void QSystemTrayIcon::setVisible(bool visible)

void show

Description: Method void QSystemTrayIcon::show()

void showMessage(string title,string msg,const QSystemTrayIcon_MessageIcon icon = QSystemTrayIcon::Information,int msecs = 10000)

Description: Method void QSystemTrayIcon::showMessage(const QString &title, const QString &msg, QSystemTrayIcon::MessageIcon icon, int msecs)

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[static] bool supportsMessages

Description: Static method bool QSystemTrayIcon::supportsMessages()

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

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QSystemTrayIcon::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[const] string toolTip

Description: Method QString QSystemTrayIcon::toolTip()

void toolTip=(string tip)

Description: Method void QSystemTrayIcon::setToolTip(const QString &tip)

[static] string tr(string s,string c = 0)

Description: Static method QString QSystemTrayIcon::tr(const char *s, const char *c)

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

[static] string tr(string s,string c,int n)

Description: Static method QString QSystemTrayIcon::tr(const char *s, const char *c, int n)

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

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QSystemTrayIcon::trUtf8(const char *s, const char *c)

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

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QSystemTrayIcon::trUtf8(const char *s, const char *c, int n)

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

void visible=(bool visible)

Description: Method void QSystemTrayIcon::setVisible(bool visible)