Класс 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

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

QList<QVersionNumber> QHelpFilterEngine::availableVersions() const

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

Эта функция была представлена в Qt 5.15.

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

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

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

QStringList QHelpFilterEngine::filters() const

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

QStringList QHelpFilterEngine::indices() const

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

Эта функция была представлена в Qt 5.15.

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

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

Эта функция была представлена в Qt 5.15.

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