Класс QSystemTrayIcon

Класс QSystemTrayIcon предоставляет значок для приложения в системном трее. Подробнее...

Этот класс был представлен в Qt 4.2.

• Список всех членов, включая унаследованные

Типы публичного доступа

Свойства

• icon : QIcon
• toolTip : QString
• visible : bool

Функции публичного доступа

Свойства доступные только из слотов

Сигналы

Статические публичные члены

Переопределённые защищённые функции

Подробное описание

Современные операционные системы обычно предоставляют специальную область на рабочем столе, называемую системным треем или областью уведомлений, где долго выполняемые приложения могут отображать значки и короткие сообщения.

Класс QSystemTrayIcon может использоваться на следующих платформах:

• Все поддерживаемые версии Windows.
• Все менеджеры окон и независимые реализации треев для X11, которые реализуют спецификацию системного трея XEmbed.
• Все среды рабочего стола X11, которые реализуют спецификацию D-Bus, включая последние версии KDE и Unity.
• Все поддерживаемые версии macOS.

Чтобы проверить, присутствует ли системный трей на рабочем столе пользователя, вызовите статический метод QSystemTrayIcon::isSystemTrayAvailable().

Чтобы добавить запись в системный трей, создайте объект QSystemTrayIcon, вызовите setContextMenu() для предоставления контекстного меню для значка и вызовите show() для отображения его в системном трее. Сообщения о состоянии уведомления («шаровые сообщения») можно отображать в любое время с помощью showMessage().

Если системный трей недоступен при создании значка системного трея, но становится доступным позже, QSystemTrayIcon автоматически добавит запись для приложения в системный трей, если значок visible.

Сигнал activated() генерируется, когда пользователь активирует значок.

Только на X11, когда запрашивается всплывающая подсказка, QSystemTrayIcon получает событие QHelpEvent типа QEvent::ToolTip. Кроме того, QSystemTrayIcon получает события прокрутки типа QEvent::Wheel. Они не поддерживаются ни на какой другой платформе.

См. также QDesktopServices, QDesktopWidget, Интеграция с рабочим столом и Пример значка системного трея.

Документация по типам членов

перечисление QSystemTrayIcon::ActivationReason

Это перечисление описывает причину активации системного трея.

Примечание: В macOS двойной щелчок будет отправлен только в том случае, если контекстное меню не установлено, поскольку меню открывается при нажатии мыши

См. также activated().

перечисление QSystemTrayIcon::MessageIcon

Это перечисление описывает значок, отображаемый при отображении сообщения в виде шарика.

См. также QMessageBox.

Документация по членам-функциям

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

Конструктор объекта QSystemTrayIcon со заданным значком icon и родителем parent.

Значок по умолчанию невидим.

См. также visible.

QSystemTrayIcon::QSystemTrayIcon(QObject *parent = nullptr)

Конструктор объекта QSystemTrayIcon со заданным родителем parent.

Значок по умолчанию невидим.

См. также visible.

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

Этот сигнал излучается, когда пользователь активирует значок системного лотка. reason указывает причину активации. Перечисление QSystemTrayIcon::ActivationReason перечисляет различные причины.

См. также QSystemTrayIcon::ActivationReason.

[slot] void QSystemTrayIcon::hide()

Скрывает запись в системном лотке.

См. также show() и visible.

[signal] void QSystemTrayIcon::messageClicked()

Этот сигнал излучается, когда пользователь щелкнул по сообщению, отображенному с помощью showMessage(),

Примечание: Мы следуем поведению Microsoft Windows, поэтому сигнал также излучается, когда пользователь щелкает по значку лотка с отображенным сообщением в виде всплывающего сообщения.

См. также activated().

[slot] void QSystemTrayIcon::show()

Отображает значок в системном лотке.

См. также hide() и visible.

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

Отображает всплывающее сообщение для записи с заданным title, message и icon на указанное время в millisecondsTimeoutHint. title и message должны быть текстовыми строками.

Сообщение может быть щелкнуто пользователем; сигнал messageClicked() будет излучен, когда это произойдёт.

Обратите внимание, что отображение сообщений зависит от конфигурации системы и настроек пользователя, и сообщения могут вообще не отображаться. Поэтому на него не следует полагаться в качестве единственного способа предоставления критической информации.

В Windows параметр millisecondsTimeoutHint обычно игнорируется системой, когда приложение имеет фокус.

Преобразован в слот в Qt 5.2.

Эта функция была представлена в Qt 4.3.

См. также show() и supportsMessages().

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

Эта функция перегружает showMessage().

Отображает всплывающее сообщение для записи с заданным title, message и пользовательским значком icon на указанное время в millisecondsTimeoutHint.

Эта функция была представлена в Qt 5.9.

[virtual] QSystemTrayIcon::~QSystemTrayIcon()

Удаляет значок из системного лотка и освобождает все выделенные ресурсы.

QMenu *QSystemTrayIcon::contextMenu() const

Возвращает текущее контекстное меню для записи в системном лотке.

См. также setContextMenu().

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

Переопределяет: QObject::event(QEvent *e).

QRect QSystemTrayIcon::geometry() const

Возвращает геометрию значка системного лотка в координатах экрана.

Эта функция была представлена в Qt 4.3.

См. также visible.

[static] bool QSystemTrayIcon::isSystemTrayAvailable()

Возвращает true, если системный лоток доступен; в противном случае возвращает false.

Если системный лоток в настоящее время недоступен, но станет доступным позже, QSystemTrayIcon автоматически добавит запись в системный лоток, если он visible.

void QSystemTrayIcon::setContextMenu(QMenu *menu)

Устанавливает указанное menu в качестве контекстного меню для значка системного лотка.

Меню появится, когда пользователь запросит контекстное меню для значка системного лотка, щелкнув мышью.

В macOS это в настоящее время преобразуется в NSMenu, поэтому сигнал aboutToHide() не излучается.

Примечание: значок системного лотка не берет на себя владение меню. Вы должны убедиться, что оно удаляется в соответствующее время, например, создавая меню с соответствующим родительским объектом.

См. также contextMenu().

[static] bool QSystemTrayIcon::supportsMessages()

Возвращает true, если системный лоток поддерживает всплывающие сообщения; в противном случае возвращает false.

См. также showMessage().