Класс QToolTip

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

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

[static] void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w = Q_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.