Класс QHelpEngineCore

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

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

Свойства

• autoSaveFilter : bool
• collectionFile : QString
• readOnly : bool

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

Сигналы

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

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

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

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

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

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

Ядро движка справки имеет два режима:

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

Режим можно изменить, вызвав метод setReadOnly() до вызова setupData().

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

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

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

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

[since 5.15] QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id) const

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

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

[since 5.15] QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id, const QString &filterName) const

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

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

[since 5.15] QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword) const

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

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

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

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

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

[since 5.13] bool QHelpEngineCore::usesFilterEngine() const

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

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

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