API reference - Class QSystemTrayIcon

Context

Signature: [static,const] QSystemTrayIcon_ActivationReason Context

Description: Enum constant QSystemTrayIcon::Context

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

Critical

Signature: [static,const] QSystemTrayIcon_MessageIcon Critical

Description: Enum constant QSystemTrayIcon::Critical

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

DoubleClick

Signature: [static,const] QSystemTrayIcon_ActivationReason DoubleClick

Description: Enum constant QSystemTrayIcon::DoubleClick

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

Information

Signature: [static,const] QSystemTrayIcon_MessageIcon Information

Description: Enum constant QSystemTrayIcon::Information

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

MiddleClick

Signature: [static,const] QSystemTrayIcon_ActivationReason MiddleClick

Description: Enum constant QSystemTrayIcon::MiddleClick

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

NoIcon

Signature: [static,const] QSystemTrayIcon_MessageIcon NoIcon

Description: Enum constant QSystemTrayIcon::NoIcon

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

Trigger

Signature: [static,const] QSystemTrayIcon_ActivationReason Trigger

Description: Enum constant QSystemTrayIcon::Trigger

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

Unknown

Signature: [static,const] QSystemTrayIcon_ActivationReason Unknown

Description: Enum constant QSystemTrayIcon::Unknown

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

Warning

Signature: [static,const] QSystemTrayIcon_MessageIcon Warning

Description: Enum constant QSystemTrayIcon::Warning

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

_const_cast

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

activated

Signature: [signal] void activated (const QSystemTrayIcon_ActivationReason reason)

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

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

contextMenu

Signature: [const] QMenu ptr contextMenu

Description: Method QMenu *QSystemTrayIcon::contextMenu()

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

contextMenu=

Signature: void contextMenu= (QMenu ptr menu)

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

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

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

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QSystemTrayIcon::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_activated

Signature: void emit_activated (const QSystemTrayIcon_ActivationReason reason)

Description: Emitter for signal void QSystemTrayIcon::activated(QSystemTrayIcon::ActivationReason reason)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QSystemTrayIcon::destroyed(QObject *)

Call this method to emit this signal.

emit_messageClicked

Signature: void emit_messageClicked

Description: Emitter for signal void QSystemTrayIcon::messageClicked()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QSystemTrayIcon::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

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

This method can be reimplemented in a derived class.

geometry

Signature: [const] QRect geometry

Description: Method QRect QSystemTrayIcon::geometry()

hide

Signature: void hide

Description: Method void QSystemTrayIcon::hide()

icon

Signature: [const] QIcon icon

Description: Method QIcon QSystemTrayIcon::icon()

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

icon=

Signature: void icon= (const QIcon icon)

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

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

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QSystemTrayIcon::isSignalConnected(const QMetaMethod &signal)

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

isSystemTrayAvailable?

Signature: [static] bool isSystemTrayAvailable?

Description: Static method bool QSystemTrayIcon::isSystemTrayAvailable()

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

isVisible?

Signature: [const] bool isVisible?

Description: Method bool QSystemTrayIcon::isVisible()

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

messageClicked

Signature: [signal] void messageClicked

Description: Signal declaration for QSystemTrayIcon::messageClicked()

You can bind a procedure to this signal.

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

new

(1) Signature: [static] new QSystemTrayIcon new (QObject ptr parent = nullptr)

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

This method creates an object of class QSystemTrayIcon.

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

(2) Signature: [static] new QSystemTrayIcon new (const QIcon icon, QObject ptr parent = nullptr)

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

This method creates an object of class QSystemTrayIcon.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QSystemTrayIcon::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSystemTrayIcon::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSystemTrayIcon::senderSignalIndex()

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

setContextMenu

Signature: void setContextMenu (QMenu ptr menu)

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

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

setIcon

Signature: void setIcon (const QIcon icon)

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

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

setToolTip

Signature: void setToolTip (string tip)

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

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

setVisible

Signature: void setVisible (bool visible)

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

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

show

Signature: void show

Description: Method void QSystemTrayIcon::show()

showMessage

(1) Signature: void showMessage (string title, string msg, const QIcon icon, int msecs = 10000)

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

(2) Signature: 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)

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

supportsMessages

Signature: [static] bool supportsMessages

Description: Static method bool QSystemTrayIcon::supportsMessages()

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

This method can be reimplemented in a derived class.

toolTip

Signature: [const] string toolTip

Description: Method QString QSystemTrayIcon::toolTip()

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

toolTip=

Signature: void toolTip= (string tip)

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

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

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

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.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

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.

visible

Signature: [const] bool visible

Description: Method bool QSystemTrayIcon::isVisible()

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

visible=

Signature: void visible= (bool visible)

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

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