Класс 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.0/qhelpenginecore.html
