Класс QWhatsThis

Класс QWhatsThis предоставляет простое описание любого виджета, отвечая на вопрос "Что это?". Подробнее...

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

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

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

"What's This?" — часть системы справки приложения, предоставляющая пользователям информацию о функциональности и использовании конкретного виджета. Справки "What's This?" обычно более подробны, чем всплывающие подсказки, но содержат меньше информации, чем отдельные окна справки.

QWhatsThis предоставляет одно окно с текстом описания, которое всплывает, когда пользователь спрашивает "Что это?". Стандартный способ запроса — перевести фокус на соответствующий виджет и нажать Shift+F1. Текст справки появляется сразу; он исчезает, как только пользователь что-то делает. (Обратите внимание, что если есть ярлык для Shift+F1, этот механизм не будет работать). Некоторые диалоговые окна имеют кнопку «?» , которую пользователи могут нажать, чтобы перейти в режим "Что это?", а затем щелкнуть по соответствующему виджету, чтобы отобразить окно "Что это?". Также можно добавить пункт меню или кнопку на панели инструментов для переключения в режим "Что это?".

Для добавления текста "Что это?" к виджету или действию, просто вызовите QWidget::setWhatsThis() или QAction::setWhatsThis().

Текст может быть форматированным или обычным. Если вы укажете форматированный текст, он будет отображаться с использованием стандартной таблицы стилей, что позволит встраивать изображения в отображаемый текст. Для максимальной производительности стандартная таблица стилей использует простой метод определения того, может ли текст быть отображен как обычный. Подробности см. в Qt::mightBeRichText().

    newAct = new QAction(tr("&New"), this);
    newAct->setShortcut(tr("Ctrl+N"));
    newAct->setStatusTip(tr("Create a new file"));
    newAct->setWhatsThis(tr("Click this option to create a new file."));

Альтернативный способ перехода в режим "Что это?" — вызов createAction() и добавление возвращаемого QAction в меню или панель инструментов. Вызвав это действие контекстной справки (на рисунке ниже — кнопка со стрелкой и значком вопроса), пользователь переходит в режим "Что это?". Теперь, нажав на виджет, отобразится соответствующий текст справки. Режим покидается после получения справки или нажатия Esc.

Вы можете программно перейти в режим "Что это?" с помощью enterWhatsThisMode(), проверить режим с помощью inWhatsThisMode() и вернуться в обычный режим с помощью leaveWhatsThisMode().

Если вы хотите вручную управлять поведением "Что это?" виджета, см. Qt::WA_CustomWhatsThis.

Также можно отображать разные тексты справки для разных областей виджета, используя QHelpEvent типа QEvent::WhatsThis. Перехватывайте событие справки в функции QWidget::event() вашего виджета и вызывайте QWhatsThis::showText() с текстом, который вы хотите отобразить, для позиции, указанной в QHelpEvent::pos(). Если текст форматирован и пользователь нажимает на ссылку, виджет также получает QWhatsThisClickedEvent со ссылкой на ссылку в QWhatsThisClickedEvent::href(). Если QWhatsThisClickedEvent обработан (т.е. QWidget::event() возвращает true), окно справки остается видимым. Вызовите QWhatsThis::hideText() для явного скрытия.

См. также QToolTip.

Документация по функциям-членам

[static] QAction *QWhatsThis::createAction(QObject *parent = nullptr)

Возвращает готовый QAction, используемый для вызова контекстной справки "Что это?", с заданным parent.

Возвращаемый QAction предоставляет удобный способ перехода пользователей в режим "Что это?".

[static] void QWhatsThis::enterWhatsThisMode()

Эта функция переключает пользовательский интерфейс в режим "Что это?". Пользовательский интерфейс может быть переключен обратно в обычный режим пользователем (например, щелчком мыши или нажатием клавиши Esc) или программно, вызвав leaveWhatsThisMode().

При входе в режим "Что это?", событие QEvent типа Qt::EnterWhatsThisMode отправляется всем виджетам верхнего уровня.

См. также inWhatsThisMode() и leaveWhatsThisMode().

[static] void QWhatsThis::hideText()

Если окно "Что это?" отображается, это уничтожает его.

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

[static] bool QWhatsThis::inWhatsThisMode()

Возвращает true , если пользовательский интерфейс находится в режиме "Что это?"; в противном случае возвращает false.

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

[static] void QWhatsThis::leaveWhatsThisMode()

Если пользовательский интерфейс находится в режиме "Что это?", эта функция переключает его обратно в обычный режим; в противном случае ничего не делает.

При выходе из режима "Что это?", событие QEvent типа Qt::LeaveWhatsThisMode отправляется всем виджетам верхнего уровня.

См. также enterWhatsThisMode() и inWhatsThisMode().

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

Отображает text как окно "Что это?", в глобальной позиции pos. Дополнительный аргумент виджета w используется для определения соответствующего экрана на системах с несколькими дисплеями.

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