Класс QToolTip

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

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

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

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

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

Форматированный текст, отображаемый в всплывающей подсказке, неявно переносится на следующую строку, если не указано иное с помощью <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)

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

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

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

[static] void QToolTip::setPalette(const QPalette &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.