Класс QHelpEngineCore

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

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

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

Свойства

• autoSaveFilter : bool
• collectionFile : QString

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

Сигналы

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

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

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

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

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

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

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

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

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

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

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

void QHelpEngineCore::setupFinished()

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

void QHelpEngineCore::setupStarted()

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

void QHelpEngineCore::warning(const QString &msg)

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

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

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.

QMap<QString, QUrl> QHelpEngineCore::linksForIdentifier(const QString &id) const

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

QMap<QString, QUrl> QHelpEngineCore::linksForKeyword(const QString &keyword) const

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

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

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

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)

Сохраняет значение под ключом. Если ключ уже существует, значение будет перезаписано. Возвращает 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().