Класс QWhatsThis

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

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

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

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

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

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

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

Текст может быть форматированным или обычным. Если вы укажете строку с форматированием rich text, она будет отображаться с помощью стандартной таблицы стилей, что позволит встраивать изображения в отображаемый текст. Для максимальной скорости стандартная таблица стилей использует простой метод для определения, можно ли отобразить текст как обычный текст. Подробности см. в 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(). Если текст форматирован с использованием rich text и пользователь нажимает на ссылку, виджет также получает событие 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().

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

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

[static] void QWhatsThis::hideText()

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

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

[static] bool QWhatsThis::inWhatsThisMode()

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

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

[static] void QWhatsThis::leaveWhatsThisMode()

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

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

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

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

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

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