Класс QHelpFilterEngine

Класс QHelpFilterEngine предоставляет отфильтрованный вид содержимого справки. Подробнее...

Этот класс был представлен в Qt 5.13.

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

Открытые функции

Сигналы

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

Двигатель фильтров позволяет управлять фильтрами, связанными с экземпляром QHelpEngineCore. Двигатель справки внутри создаёт экземпляр двигателя фильтров, который можно получить, вызвав QHelpEngineCore::filterEngine(). Поэтому публичный конструктор этого класса отключён.

Фильтры идентифицируются строкой имени фильтра. Подробности фильтра описаны в классе QHelpFilterData.

Двигатель фильтров позволяет добавлять новые фильтры и изменять данные существующих фильтров с помощью метода setFilterData(). Существующий фильтр можно удалить с помощью метода removeFilter().

Из зарегистрированных фильтров один можно пометить как активный. Активный фильтр будет использоваться связанным движком справки для возврата отфильтрованных результатов многих различных функций, таких как содержимое, индекс или результаты поиска. Если ни один фильтр не помечен как активный, движок справки возвращает полный доступный список результатов.

Активный фильтр возвращается функцией activeFilter(), и его можно изменить функцией setActiveFilter().

См. также QHelpEngineCore.

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

[signal] void QHelpFilterEngine::filterActivated(const QString &newFilter)

Этот сигнал испускается при установке активного фильтра. newFilter задаёт имя фильтра.

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

QString QHelpFilterEngine::activeFilter() const

Возвращает имя текущего активного фильтра.

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

QStringList QHelpFilterEngine::availableComponents() const

Возвращает список всех доступных компонентов, определённых во всех зарегистрированных файлах документации.

QHelpFilterData QHelpFilterEngine::filterData(const QString &filterName) const

Возвращает подробности фильтра, связанные с filterName.

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

QStringList QHelpFilterEngine::filters() const

Возвращает список всех имён фильтров, определённых внутри двигателя фильтров.

QMap<QString, QString> QHelpFilterEngine::namespaceToComponent() const

Возвращает карту всех доступных пространств имён в качестве ключей вместе с их связанными компонентами в качестве значений.

QMap<QString, QVersionNumber> QHelpFilterEngine::namespaceToVersion() const

Возвращает карту всех доступных пространств имён в качестве ключей вместе с их связанными версиями в качестве значений.

QStringList QHelpFilterEngine::namespacesForFilter(const QString &filterName) const

Возвращает список всех зарегистрированных пространств имён документации, которые соответствуют фильтру, идентифицируемому filterName.

bool QHelpFilterEngine::removeFilter(const QString &filterName)

Удаляет фильтр, идентифицируемый filterName.

Возвращает true если удаление фильтра прошло успешно, в противном случае возвращает false.

bool QHelpFilterEngine::setActiveFilter(const QString &filterName)

Изменяет текущий активный фильтр на filterName.

Возвращает true если изменение фильтра прошло успешно, в противном случае возвращает false.

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

bool QHelpFilterEngine::setFilterData(const QString &filterName, const QHelpFilterData &filterData)

Изменяет существующие данные фильтра, идентифицируемого filterName, на filterData. Если фильтра не существует, создаётся новый.

Возвращает true если установка фильтра прошла успешно, в противном случае возвращает false.

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