Класс QHelpEngineCore

Класс QHelpEngineCore предоставляет основные функциональные возможности системы справки. Подробнее...

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

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

Свойства

• autoSaveFilter : bool
• collectionFile : QString

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

Сигналы

Статические открытые члены

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

Прежде чем можно будет использовать движок справки, его необходимо инициализировать, вызвав setupData(). В начале процесса настройки генерируется сигнал setupStarted(). С этого момента и до момента генерации сигнала setupFinished() данные справки находятся в неопределённом, непригодном для использования состоянии.

Ядро движка справки можно использовать для выполнения различных задач. Вызвав documentsForIdentifier(), движок возвращает URL-адреса, указывающие на расположение файлов в системе справки. Фактические данные файла можно затем получить, вызвав fileData().

Движок справки может содержать любое количество пользовательских фильтров. Управление фильтрами, включая добавление новых фильтров, изменение определений фильтров или удаление существующих фильтров, осуществляется через класс QHelpFilterEngine, к которому можно получить доступ с помощью метода filterEngine().

Примечание: QHelpFilterEngine заменяет более старую API-интерфейс фильтров, устаревшую начиная с Qt 5.13. Вызовите setUsesFilterEngine() с true для активации новой функциональности.

Движок справки также предоставляет возможность устанавливать и считывать значения в устойчивом формате, сопоставимом с файлами INI или записями реестра Windows. Дополнительную информацию см. в setValue() или value().

Этот класс не предоставляет никаких компонентов графического интерфейса пользователя или функциональности для индексов или содержания. Если вам нужен один из них, используйте QHelpEngine вместо этого.

При создании пользовательского просмотра справки просмотрщик можно настроить, написав пользовательский файл коллекции, который может содержать различные ключевые слова для настройки движка справки. Эти ключевые слова и значения, а также их смысл, можно найти в справке по созданию пользовательского файла коллекции справки для Assistant.

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

QHelpEngineCore::QHelpEngineCore(const QString &collectionFile, QObject *parent = nullptr)

Создаёт новый ядро движка справки с parent. Движок справки использует информацию, хранящуюся в collectionFile, для предоставления справки. Если файл коллекции ещё не существует, он будет создан.

[signal] void QHelpEngineCore::setupFinished()

Этот сигнал излучается, когда установка завершена.

[signal] void QHelpEngineCore::setupStarted()

Этот сигнал излучается при запуске установки.

[signal] void QHelpEngineCore::warning(const QString &msg)

Этот сигнал излучается, когда происходит некритическая ошибка. Сообщение об ошибке хранится в msg.

[virtual] QHelpEngineCore::~QHelpEngineCore()

Уничтожает движок справки.

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

Создаёт файл fileName и копирует всё содержимое из текущего файла коллекции в недавно созданный файл, возвращая true, если операция прошла успешно; иначе возвращает false.

Процесс копирования гарантирует, что ссылки на файлы Qt Collection (.qch) обновляются соответствующим образом.

QVariant QHelpEngineCore::customValue(const QString &key, const QVariant &defaultValue = QVariant()) const

Возвращает значение, присвоенное ключу key. Если запрашиваемый ключ не существует, возвращается указанное значение по умолчанию defaultValue.

См. также setCustomValue() и removeCustomValue().

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

Возвращает абсолютное имя файла сжатой справки Qt (.qch), идентифицированное по namespaceName. Если файл сжатой справки Qt с указанным именем пространства имён не зарегистрирован, возвращается пустая строка.

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

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id) const

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

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

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id, const QString &filterName) const

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

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

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword) const

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

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

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword, const QString &filterName) const

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

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

QString QHelpEngineCore::error() const

Возвращает описание последней произошедшей ошибки.

QByteArray QHelpEngineCore::fileData(const QUrl &url) const

Возвращает данные файла, указанного по url. Если файл не существует, возвращается пустой QByteArray.

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

QList<QUrl> QHelpEngineCore::files(const QString namespaceName, const QString &filterName, const QString &extensionFilter = QString())

Возвращает список файлов, содержащихся в файле сжатой справки Qt для namespaceName. Файлы могут быть отфильтрованы по filterName, а также по расширению extensionFilter (например, 'html').

QHelpFilterEngine *QHelpEngineCore::filterEngine() const

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

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

QUrl QHelpEngineCore::findFile(const QUrl &url) const

Возвращает скорректированный URL для url, который может ссылаться на другое пространство имён, определённое виртуальной папкой, определённой как часть url. Если виртуальная папка совпадает со пространством имён url, метод просто проверяет, существует ли файл, и возвращает тот же url. Когда виртуальная папка не совпадает со пространством имён url, он пытается найти наиболее соответствующее пространство имён в соответствии с активным фильтром. Когда пространство имён найдено, он возвращает скорректированный URL, если файл существует; в противном случае возвращает недопустимый URL.

[static] QVariant QHelpEngineCore::metaData(const QString &documentationFileName, const QString &name)

Возвращает метаданные для файла сжатой справки Qt documentationFileName. Если данные для name недоступны, возвращается недействительная QVariant(). Метаданные определяются при создании файла сжатой справки Qt и не могут быть изменены позднее. Типичные метаданные включают, например, автора документации.

[static] QString QHelpEngineCore::namespaceName(const QString &documentationFileName)

Возвращает имя пространства имён, определённое для файла сжатой справки Qt (.qch), указанного по его documentationFileName. Если файл недействителен, возвращается пустая строка.

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

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

Регистрирует сжатый файл справки Qt (.qch), содержащийся в файле documentationFileName. Один сжатый файл справки, уникально идентифицируемый по своему пространству имен, может быть зарегистрирован только один раз. Возвращает true, если регистрация прошла успешно, в противном случае — false.

См. также unregisterDocumentation() и error().

QStringList QHelpEngineCore::registeredDocumentations() const

Возвращает список всех зарегистрированных сжатых файлов справки Qt в текущем файле коллекции. Возвращаемые имена являются пространствами имен зарегистрированных сжатых файлов справки Qt (.qch).

bool QHelpEngineCore::removeCustomValue(const QString &key)

Удаляет key из раздела настроек в файле коллекции. Возвращает true, если значение было удалено успешно, в противном случае — false.

См. также customValue() и setCustomValue().

bool QHelpEngineCore::setCustomValue(const QString &key, const QVariant &value)

Сохраняет value под key. Если ключ уже существует, значение будет перезаписано. Возвращает true, если значение было сохранено успешно, в противном случае — false.

См. также customValue() и removeCustomValue().

void QHelpEngineCore::setUsesFilterEngine(bool uses)

Включает или выключает новую функциональность фильтрации внутри движка справки в соответствии с переданным параметром uses.

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

См. также usesFilterEngine() и filterEngine().

bool QHelpEngineCore::setupData()

Настраивает движок справки, обрабатывая информацию, найденную в файле коллекции, и возвращает true, если процесс успешен; в противном случае возвращает false.

Вызывая функцию, движок справки принудительно инициализируется немедленно. Большинство раз, эта функция не должна вызываться явно, так как функции-получатели, зависящие от правильно настроенного движка справки, делают это сами.

Примечание: qsqlite4.dll необходимо развернуть вместе с приложением, так как система справки использует драйвер sqlite при загрузке коллекций справки.

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

Удаляет сжатый файл справки Qt (.qch), идентифицируемый по его namespaceName, из коллекции справки. Возвращает true при успехе, в противном случае — false.

См. также registerDocumentation() и error().

bool QHelpEngineCore::usesFilterEngine() const

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

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

См. также setUsesFilterEngine() и filterEngine().