Spec-Zone.ru › Qt 5.12

Класс QToolTip

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

Заголовок: #include <QToolTip>
qmake: QT += widgets
  • Список всех членов, включая унаследованные

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

QFont font()
void hideText()
bool isVisible()
QPalette palette()
void setFont(const QFont &font)
void setPalette(const QPalette &palette)
void showText(const QPoint &pos, const QString &text, QWidget *w, const QRect &rect)
void showText(const QPoint &pos, const QString &text, QWidget *w = nullptr)
void showText(const QPoint &pos, const QString &text, QWidget *w, const QRect &rect, int msecDisplayTime)
QString text()

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

Класс 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()

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

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

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

[static] void QToolTip::hideText()

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

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

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

[static] bool QToolTip::isVisible()

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

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

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

[static] QPalette QToolTip::palette()

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

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

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

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

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

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

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

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

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

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

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

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

[static] void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w, const QRect &rect)

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

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

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

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

[static] void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w = nullptr)

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

Это аналогично вызову QToolTip::showText(pos, text, w, QRect())

[static] void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w, const QRect &rect, int msecDisplayTime)

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

Это похоже на QToolTip::showText(pos, text, w, rect), но с дополнительным параметром msecDisplayTime, который определяет, как долго всплывающая подсказка будет отображаться в миллисекундах.

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

[static] QString QToolTip::text()

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

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.12/qtooltip.html

Spec-Zone.ru

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