Класс QSystemTrayIcon
Класс QSystemTrayIcon предоставляет значок для приложения в системном трее. Подробнее...
| Заголовок: | #include <QSystemTrayIcon> |
| CMake: | find_package(Qt6 COMPONENTS Widgets REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Widgets) |
| qmake: | QT += widgets |
| Наследует: | QObject |
Типы public
| перечисление | ActivationReason { Unknown, Context, DoubleClick, Trigger, MiddleClick } |
| перечисление | MessageIcon { NoIcon, Information, Warning, Critical } |
Свойства
Функции public
| QSystemTrayIcon(const QIcon &icon, QObject *parent = nullptr) | |
| QSystemTrayIcon(QObject *parent = nullptr) | |
| virtual | ~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 |
Свойства public
| 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) |
Сигналы
| void | activated(QSystemTrayIcon::ActivationReason reason) |
| void | messageClicked() |
Статические public члены
| bool | isSystemTrayAvailable() |
| bool | supportsMessages() |
Переопределенные защищенные функции
| virtual bool | event(QEvent *e) override |
Подробное описание
Современные операционные системы обычно предоставляют специальную область на рабочем столе, называемую системным треем или областью уведомлений, где долгоживущие приложения могут отображать значки и короткие сообщения.
Класс 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, Интеграция с рабочим столом и Пример значка системного трея.
Документация по типам членов
перечисление QSystemTrayIcon::ActivationReason
Это перечисление описывает причину активации системного трея.
| Постоянная | Значение | Описание |
|---|---|---|
QSystemTrayIcon::Unknown |
0 |
Неизвестная причина |
QSystemTrayIcon::Context |
1 |
Было запрошено контекстное меню для записи в системном трее |
QSystemTrayIcon::DoubleClick |
2 |
Запись в системном трее была дважды щелкнута. |
Примечание: В macOS двойной щелчок будет сгенерирован только если контекстное меню не установлено, так как меню открывается при нажатии мыши
| Постоянная | Значение | Описание |
|---|---|---|
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(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()
Скрывает запись в системном трее.
[signal] void QSystemTrayIcon::messageClicked()
Этот сигнал испускается, когда пользователь нажимает на сообщение, отображенное с помощью showMessage(),.
Примечание: Мы следуем поведению Microsoft Windows, поэтому сигнал также испускается, когда пользователь нажимает на значок системного трея с отображаемым сообщением в виде всплывающего окна.
См. также activated().
[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.
См. также show() и supportsMessages().
[slot, since 5.9] 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
Возвращает геометрию значка системного трея в координатах экрана.
См. также visible.
[static] bool QSystemTrayIcon::isSystemTrayAvailable()
Возвращает true если системный трей доступен; в противном случае возвращает false.
Если системный трей в настоящее время недоступен, но становится доступным позже, QSystemTrayIcon автоматически добавит запись в системный трей, если он видимый.
void QSystemTrayIcon::setContextMenu(QMenu *menu)
Устанавливает указанное menu в качестве контекстного меню для значка системного трея.
Меню появится, когда пользователь запросит контекстное меню для значка системного трея, щелкнув по нему мышкой.
В macOS в настоящее время это преобразуется в NSMenu, поэтому сигнал aboutToHide() не испускается.
Примечание: Значок системного трея не берет на себя владение меню. Вы должны убедиться, что он удаляется в соответствующее время, например, создавая меню с соответствующим родительским объектом.
См. также contextMenu().
[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-6.2/qsystemtrayicon.html
