Класс QWhatsThis

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

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

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

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

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

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

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().