Класс QHelpFilterEngine

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

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

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

Сигналы

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

Двигатель фильтрации позволяет управлять фильтрами, связанными с экземпляром 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

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

[since 5.15] QList<QVersionNumber> QHelpFilterEngine::availableVersions() const

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

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

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

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

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

QStringList QHelpFilterEngine::filters() const

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

[since 5.15] QStringList QHelpFilterEngine::indices() const

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

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

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