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

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

Эта функция была добавлена в 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 не пуста, вы должны указать виджет. В противном случае этот аргумент может быть nullptr, но он используется для определения соответствующего экрана на системах с несколькими мониторами.

Если 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.