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

Устанавливает 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.