Класс QSystemTrayIcon

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

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

Типы

Свойства

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

• 1 свойство унаследовано от QObject

Открытые функции

• 31 открытая функция унаследована от QObject

Открытые слоты

• 1 открытый слот унаследован от QObject

Сигналы

• 2 сигнала унаследованы от QObject

Статические открытые члены

• 11 статических открытых членов унаследованы от QObject

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

• 9 защищенных функций унаследованы от QObject

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

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

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

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

• Все поддерживаемые версии Windows.
• Все диспетчеры окон и независимые реализации треев для X11, которые реализуют спецификацию системного трея XEmbed по адресу http://standards.freedesktop.org/systemtray-spec/systemtray-spec-0.2.html freedesktop.org.
• Все среды рабочего стола X11, которые реализуют спецификацию D-Bus http://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/StatusNotifierItem, включая последние версии KDE и Unity.
• Все поддерживаемые версии macOS. Обратите внимание, что система уведомлений Growl должна быть установлена для QSystemTrayIcon::showMessage(), чтобы отображать сообщения на macOS до версии 10.8 (Mountain Lion).

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

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

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

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

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

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

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

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

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

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

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

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

См. также QMessageBox.

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

QSystemTrayIcon::QSystemTrayIcon(QObject *parent = Q_NULLPTR)

Создаёт объект QSystemTrayIcon с указанным parent.

Иконка изначально невидима.

См. также visible.

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

Создаёт объект QSystemTrayIcon с указанной icon и parent.

Иконка изначально невидима.

См. также visible.

QSystemTrayIcon::~QSystemTrayIcon()

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

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

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

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

QMenu *QSystemTrayIcon::contextMenu() const

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

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

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

Переопределено из QObject::event().

QRect QSystemTrayIcon::geometry() const

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

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

См. также visible.

[slot] void QSystemTrayIcon::hide()

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

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

[static] bool QSystemTrayIcon::isSystemTrayAvailable()

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

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

[signal] void QSystemTrayIcon::messageClicked()

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

В настоящее время этот сигнал не отправляется на macOS.

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

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

void QSystemTrayIcon::setContextMenu(QMenu *menu)

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

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

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

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

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

[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 обычно игнорируется системой, когда приложение имеет фокус.

В macOS для отображения сообщений необходимо установить систему уведомлений Growl.

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

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

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

[static] bool QSystemTrayIcon::supportsMessages()

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

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