Класс QSystemTrayIcon
Класс QSystemTrayIcon предоставляет значок для приложения в системном трее. Подробнее...
| Заголовок: | #include <QSystemTrayIcon> |
| qmake: | QT += widgets |
| С момента: | Qt 4.2 |
| Наследует: | QObject |
Типы публичного интерфейса
| Перечисление | ActivationReason { Unknown, Context, DoubleClick, Trigger, MiddleClick } |
| Перечисление | MessageIcon { NoIcon, Information, Warning, Critical } |
Свойства
- 1 свойство унаследовано от QObject
Публичные функции
| QSystemTrayIcon(QObject *parent = Q_NULLPTR) | |
| QSystemTrayIcon(const QIcon &icon, QObject *parent = Q_NULLPTR) | |
| ~QSystemTrayIcon() | |
| QMenu * | contextMenu() const |
| QRect | geometry() const |
| QIcon | icon() const |
| bool | isVisible() const |
| void | setContextMenu(QMenu *menu) |
| void | setIcon(const QIcon &icon) |
| void | setToolTip(const QString &tip) |
| QString | toolTip() const |
- 32 public functions inherited from QObject
Публичные слоты
| void | hide() |
| void | setVisible(bool visible) |
| void | show() |
| void | showMessage(const QString &title, const QString &message, QSystemTrayIcon::MessageIcon icon = QSystemTrayIcon::Information, int millisecondsTimeoutHint = 10000) |
| void | showMessage(const QString &title, const QString &message, const QIcon &icon, int millisecondsTimeoutHint = 10000) |
- 1 public slot inherited from QObject
Сигналы
| void | activated(QSystemTrayIcon::ActivationReason reason) |
| void | messageClicked() |
- 2 signals inherited from QObject
Статические публичные члены
| bool | isSystemTrayAvailable() |
| bool | supportsMessages() |
- 11 static public members inherited from QObject
Переопределенные защищенные функции
| virtual bool | event(QEvent *e) |
- 9 protected functions inherited from 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.
Чтобы проверить наличие системного трея на рабочем столе пользователя, вызовите статическую функцию QSystemTrayIcon::isSystemTrayAvailable().
Для добавления записи в системный трей создайте объект QSystemTrayIcon, вызовите setContextMenu() для предоставления контекстного меню для значка и вызовите show() для отображения его в системном трее. Сообщения об уведомлениях статуса («шаровые сообщения») можно отображать в любое время, используя showMessage().
Если системный трей недоступен при создании значка системного трея, но становится доступным позже, QSystemTrayIcon автоматически добавит запись для приложения в системный трей, если значок visible.
Сигнал activated() генерируется при активации значка пользователем.
Только на X11, когда запрашивается всплывающая подсказка, QSystemTrayIcon получает QHelpEvent типа QEvent::ToolTip. Кроме того, QSystemTrayIcon получает события прокрутки типа QEvent::Wheel. Они не поддерживаются ни на одной другой платформе.
См. также QDesktopServices, QDesktopWidget, Интеграция с рабочим столом и Пример значка системного трея.
Документация по типам членов
перечисление QSystemTrayIcon::ActivationReason
Это перечисление описывает причину активации системного трея.
| Константа | Значение | Описание |
|---|---|---|
QSystemTrayIcon::Unknown |
0 |
Неизвестная причина |
QSystemTrayIcon::Context |
1 |
Запрошено контекстное меню для записи в системном трее |
QSystemTrayIcon::DoubleClick |
2 |
Запись в системном трее была дважды щелкнута |
QSystemTrayIcon::Trigger |
3 |
Запись в системном трее была щелкнута |
QSystemTrayIcon::MiddleClick |
4 |
Запись в системном трее была щелкнута средней кнопкой мыши |
См. также activated().
перечисление QSystemTrayIcon::MessageIcon
Это перечисление описывает значок, который отображается при отображении сообщения в виде шарика.
| Константа | Значение | Описание |
|---|---|---|
QSystemTrayIcon::NoIcon |
0 |
Значок не отображается. |
QSystemTrayIcon::Information |
1 |
Отображается значок информации. |
QSystemTrayIcon::Warning |
2 |
Отображается стандартный значок предупреждения. |
QSystemTrayIcon::Critical |
3 |
Отображается значок критического предупреждения. |
См. также QMessageBox.
Документация по свойствам
icon : QIcon
Это свойство содержит значок системного трея.
В Windows размер значка системного трея составляет 16x16; в X11 предпочтительный размер — 22x22. Значок будет масштабироваться до соответствующего размера при необходимости.
Функции доступа:
| QIcon | icon() const |
| void | setIcon(const QIcon &icon) |
toolTip : QString
Это свойство содержит всплывающую подсказку для записи в системном трее.
В некоторых системах длина всплывающей подсказки ограничена. Подсказка будет усечена при необходимости.
Функции доступа:
| QString | toolTip() const |
| void | setToolTip(const QString &tip) |
visible : bool
Это свойство содержит значение, указывающее, отображается ли запись в системном трее.
Установка этого свойства в true или вызов show() делает значок системного трея видимым; установка этого свойства в false или вызов hide() скрывает его.
Функции доступа:
| bool | isVisible() const |
| void | setVisible(bool visible) |
Документация по членам-функциям
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()
Скрывает запись в системном трее.
[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()
Отображает значок в системном трее.
[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.
[static] bool QSystemTrayIcon::supportsMessages()
Возвращает true, если системный трей поддерживает всплывающие сообщения; в противном случае возвращает false.
См. также showMessage().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qsystemtrayicon.html
