Member Function Documentation

QSystemTrayIcon::QSystemTrayIcon(QObject *parent = Q_NULLPTR)

Constructs a QSystemTrayIcon object with the given parent.

The icon is initially invisible.

See also visible.

QSystemTrayIcon::QSystemTrayIcon(const QIcon &icon, QObject *parent = Q_NULLPTR)

Constructs a QSystemTrayIcon object with the given icon and parent.

The icon is initially invisible.

See also visible.

QSystemTrayIcon::~QSystemTrayIcon()

Removes the icon from the system tray and frees all allocated resources.

[signal] void QSystemTrayIcon::activated(QSystemTrayIcon::ActivationReason reason)

This signal is emitted when the user activates the system tray icon. reason specifies the reason for activation. QSystemTrayIcon::ActivationReason enumerates the various reasons.

See also QSystemTrayIcon::ActivationReason.

QMenu *QSystemTrayIcon::contextMenu() const

Returns the current context menu for the system tray entry.

See also setContextMenu().

[virtual protected] bool QSystemTrayIcon::event(QEvent *e)

Reimplemented from QObject::event().

QRect QSystemTrayIcon::geometry() const

Returns the geometry of the system tray icon in screen coordinates.

This function was introduced in Qt 4.3.

See also visible.

[slot] void QSystemTrayIcon::hide()

Hides the system tray entry.

See also show() and visible.

[static] bool QSystemTrayIcon::isSystemTrayAvailable()

Returns true if the system tray is available; otherwise returns false.

If the system tray is currently unavailable but becomes available later, QSystemTrayIcon will automatically add an entry in the system tray if it is visible.

[signal] void QSystemTrayIcon::messageClicked()

This signal is emitted when the message displayed using showMessage() was clicked by the user.

Currently this signal is not sent on macOS.

Note: We follow Microsoft Windows XP/Vista behavior, so the signal is also emitted when the user clicks on a tray icon with a balloon message displayed.

See also activated().

void QSystemTrayIcon::setContextMenu(QMenu *menu)

Sets the specified menu to be the context menu for the system tray icon.

The menu will pop up when the user requests the context menu for the system tray icon by clicking the mouse button.

On macOS, this is currenly converted to a NSMenu, so the aboutToHide() signal is not emitted.

Note: The system tray icon does not take ownership of the menu. You must ensure that it is deleted at the appropriate time by, for example, creating the menu with a suitable parent object.

See also contextMenu().

[slot] void QSystemTrayIcon::show()

Shows the icon in the system tray.

See also hide() and visible.

[slot] void QSystemTrayIcon::showMessage(const QString &title, const QString &message, QSystemTrayIcon::MessageIcon icon = QSystemTrayIcon::Information, int millisecondsTimeoutHint = 10000)

Shows a balloon message for the entry with the given title, message and icon for the time specified in millisecondsTimeoutHint. title and message must be plain text strings.

Message can be clicked by the user; the messageClicked() signal will emitted when this occurs.

Note that display of messages are dependent on the system configuration and user preferences, and that messages may not appear at all. Hence, it should not be relied upon as the sole means for providing critical information.

On Windows, the millisecondsTimeoutHint is usually ignored by the system when the application has focus.

On macOS, the Growl notification system must be installed for this function to display messages.

Has been turned into a slot in Qt 5.2.

This function was introduced in Qt 4.3.

See also show() and supportsMessages().

[static] bool QSystemTrayIcon::supportsMessages()

Returns true if the system tray supports balloon messages; otherwise returns false.

See also showMessage().