Spec-Zone.ru › Qt 6.0

Класс QSystemTrayIcon

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

Заголовок: #include <QSystemTrayIcon>
CMake: find_package(Qt6 COMPONENTS Widgets REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake: QT += widgets
Наследует: QObject
  • Список всех членов, включая унаследованные

Открытые типы

Перечисление ActivationReason { Unknown, Context, DoubleClick, Trigger, MiddleClick }
Перечисление MessageIcon { NoIcon, Information, Warning, Critical }

Свойства

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

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

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

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

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()

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

bool isSystemTrayAvailable()
bool supportsMessages()

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

virtual bool event(QEvent *e) override

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

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

The system tray on Windows XP.

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

  • Все поддерживаемые версии Windows.
  • Все диспетчеры окон и независимые реализации треев для X11, которые реализуют спецификацию системного трея XEmbed. http://standards.freedesktop.org/systemtray-spec/systemtray-spec-0.2.html freedesktop.org
  • Все среды рабочего стола X11, которые реализуют спецификацию D-Bus, включая последние версии KDE и Unity. http://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/StatusNotifierItem
  • Все поддерживаемые версии 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.

void QSystemTrayIcon::activated(QSystemTrayIcon::ActivationReason reason)

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

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

void QSystemTrayIcon::hide()

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

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

void QSystemTrayIcon::messageClicked()

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

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

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

void QSystemTrayIcon::show()

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

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

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().

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

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

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

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

QSystemTrayIcon::~QSystemTrayIcon()

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

QMenu *QSystemTrayIcon::contextMenu() const

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

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

bool QSystemTrayIcon::event(QEvent *e)

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

QRect QSystemTrayIcon::geometry() const

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

См. также visible.

bool QSystemTrayIcon::isSystemTrayAvailable()

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

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

void QSystemTrayIcon::setContextMenu(QMenu *menu)

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

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

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

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

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

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.0/qsystemtrayicon.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API