Класс QToolTip

Класс QToolTip предоставляет всплывающие подсказки (balloon help) для любого виджета. Подробнее...

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

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

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

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

Отображаемый в подсказке богатый текст неявно переносится на новые строки, если не указано иное с помощью <p style='white-space:pre'>.

Простейший и наиболее распространённый способ установить подсказку виджета — вызвать его функцию QWidget::setToolTip().

Также можно отображать разные подсказки для разных областей виджета, используя QHelpEvent типа QEvent::ToolTip. Перехватывайте событие помощи в функции event() вашего виджета и вызывайте QToolTip::showText() с текстом, который вы хотите отобразить. Пример Tooltips иллюстрирует эту технику.

Если вы вызываете QToolTip::hideText() или QToolTip::showText() с пустой строкой в результате события ToolTip, вы также должны вызвать ignore() для события, чтобы указать, что вы не хотите запускать какие-либо специфичные для подсказок режимы.

Обратите внимание, что если вы хотите отображать подсказки в представлении элементов, модель/представление обеспечивает функциональность для установки подсказки элемента; например, функция QTableWidgetItem::setToolTip(). Однако, если вы хотите предоставить пользовательские подсказки в представлении элементов, вы должны перехватить событие помощи в функции QAbstractItemView::viewportEvent() и обработать его самостоятельно.

Цвет и шрифт по умолчанию для подсказок можно настроить с помощью setPalette() и setFont(). Когда подсказка отображается, isVisible() возвращает true, а text() — текущий видимый текст.

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

См. также QWidget::toolTip, QAction::toolTip и Пример подсказок.

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

[static] QFont QToolTip::font()

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

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

[static] void QToolTip::hideText()

Скрывает подсказку. Это то же самое, что вызов showText() с пустой строкой.

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

[static] bool QToolTip::isVisible()

Возвращает true, если эта подсказка в настоящее время отображается.

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

[static] QPalette QToolTip::palette()

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

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

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

[static] void QToolTip::setFont(const QFont &font)

Устанавливает шрифт font, используемый для отображения подсказок.

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

[static] void QToolTip::setPalette(const QPalette &palette)

Устанавливает палитру, используемую для отображения подсказок.

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

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

[static] void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w = nullptr, const QRect &rect = {}, int msecDisplayTime = -1)

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

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

rect находится в координатах виджета, указанного с помощью w. Если rect не пуста, вы должны указать виджет. В противном случае этот аргумент может быть nullptr, но он используется для определения соответствующего экрана на системах с несколькими мониторами.

Параметр msecDisplayTime указывает, в течение какого времени будет отображаться подсказка в миллисекундах. При значении по умолчанию -1 время основано на длине текста.

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

[static] QString QToolTip::text()

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