Класс QHelpEngineCore
Класс QHelpEngineCore предоставляет основные функциональные возможности системы справки. Подробнее...
| Заголовок: | #include <QHelpEngineCore> |
| CMake: | find_package(Qt6 COMPONENTS Help REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake: | QT += help |
| Наследует: | QObject |
| Наследует: |
Свойства
- autoSaveFilter : bool
- collectionFile : QString
- readOnly : bool
Открытые функции
| QHelpEngineCore(const QString &collectionFile, QObject *parent = nullptr) | |
| virtual | ~QHelpEngineCore() |
| bool | autoSaveFilter() const |
| QString | collectionFile() const |
| bool | copyCollectionFile(const QString &fileName) |
| QVariant | customValue(const QString &key, const QVariant &defaultValue = QVariant()) const |
| QString | documentationFileName(const QString &namespaceName) |
| QList<QHelpLink> | documentsForIdentifier(const QString &id) const |
| QList<QHelpLink> | documentsForIdentifier(const QString &id, const QString &filterName) const |
| QList<QHelpLink> | documentsForKeyword(const QString &keyword) const |
| QList<QHelpLink> | documentsForKeyword(const QString &keyword, const QString &filterName) const |
| QString | error() const |
Сигналы
| void | setupFinished() |
| void | setupStarted() |
| void | warning(const QString &msg) |
Статические открытые члены
| QVariant | metaData(const QString &documentationFileName, const QString &name) |
| QString | namespaceName(const QString &documentationFileName) |
Подробное описание
Перед использованием движка справки, необходимо его инициализировать, вызвав setupData(). В начале процесса настройки генерируется сигнал setupStarted(). С этого момента и до момента генерации сигнала setupFinished() данные справки находятся в неопределённом состоянии и недоступны для использования.
Ядро движка справки может быть использовано для выполнения различных задач. Вызывая documentsForIdentifier(), движок возвращает URL-адреса, указывающие на расположение файлов внутри системы справки. Фактические данные файла могут быть получены вызовом fileData().
Движок справки может содержать любое количество пользовательских фильтров. Управление фильтрами, включая добавление новых фильтров, изменение определений фильтров или удаление существующих фильтров, осуществляется через класс QHelpFilterEngine, к которому можно получить доступ с помощью метода filterEngine().
Примечание: QHelpFilterEngine заменяет устаревший API фильтров, который устарел начиная с Qt 5.13. Вызовите setUsesFilterEngine() со значением true для активации новой функциональности.
Ядро движка справки имеет два режима:
- Режим только для чтения, где файл коллекции справки не изменяется, если явно не запрошено. Это также работает, если файл коллекции находится в месте только для чтения, и является режимом по умолчанию.
- Полностью изменяемый режим, который требует, чтобы файл коллекции справки был изменяемым.
Режим можно изменить, вызвав метод setReadOnly() до вызова setupData().
Движок справки также предоставляет возможность устанавливать и считывать значения постоянным способом, аналогично файлам ini или записям реестра Windows. Для получения дополнительной информации см. setValue() или value().
Этот класс не предоставляет никаких компонентов или функциональности пользовательского интерфейса для индексов или содержимого. Если вам нужен один из них, используйте QHelpEngine вместо этого.
Документация свойств
autoSaveFilter : bool
Это свойство указывает, находится ли QHelpEngineCore в режиме автоматической фильтрации сохранения или нет.
Если QHelpEngineCore находится в режиме автоматической фильтрации сохранения, текущий фильтр автоматически сохраняется при его изменении функцией QHelpFilterEngine::setActiveFilter(). Фильтр сохраняется постоянно в файле коллекции справки.
По умолчанию этот режим включен.
Функции доступа:
| bool | autoSaveFilter() const |
| void | setAutoSaveFilter(bool save) |
collectionFile : QString
Это свойство содержит абсолютное имя файла коллекции, который используется в данный момент.
Установка этого свойства приводит движок справки в некорректное состояние. Важно вызвать setupData() или любую функцию-получатель, чтобы снова настроить движок справки.
Функции доступа:
| QString | collectionFile() const |
| void | setCollectionFile(const QString &fileName) |
[since 6.0] readOnly : bool
Это свойство указывает, является ли движок справки только для чтения.
В режиме только для чтения пользователь может использовать движок справки с файлом коллекции, установленным в месте только для чтения. В этом случае некоторые функции будут недоступны, такие как регистрация дополнительной документации, редактирование фильтров или любые действия, требующие изменения файла коллекции. Установка в false позволяет использовать все возможности движка справки.
По умолчанию это свойство true.
Это свойство было введено в Qt 6.0.
Функции доступа:
| bool | isReadOnly() const |
| void | setReadOnly(bool enable) |
Документация функций-членов
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().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qhelpenginecore.html
