Класс QHelpEngineCore

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

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

Свойства

• autoSaveFilter : bool
• collectionFile : QString
• currentFilter : QString

• 1 свойство, унаследованное от QObject

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

• 31 открытых функции, унаследованные от QObject

Сигналы

• 2 сигнала, унаследованные от QObject

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

• 11 статических открытых членов, унаследованных от QObject

Дополнительные унаследованные члены

• 1 открытый слот, унаследованный от QObject
• 9 защищённых функций, унаследованных от QObject

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

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

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

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

Каждый механизм справки может содержать любое количество пользовательских фильтров. Пользовательский фильтр определяется именем и набором атрибутов фильтра и может быть добавлен в механизм справки путем вызова addCustomFilter(). Аналогично, он удаляется путем вызова removeCustomFilter(). customFilters() возвращает все определенные фильтры.

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

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

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

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

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

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

[virtual] QHelpEngineCore::~QHelpEngineCore()

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

bool QHelpEngineCore::addCustomFilter(const QString &filterName, const QStringList &attributes)

Добавляет новый настраиваемый фильтр filterName. Атрибуты фильтра задаются attributes. Если фильтр уже существует, его набор атрибутов заменяется. Функция возвращает true, если операция выполнена успешно, в противном случае возвращает false.

См. также customFilters() и removeCustomFilter().

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

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

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

[signal] void QHelpEngineCore::currentFilterChanged(const QString &newFilter)

Этот сигнал подаётся, когда текущий фильтр изменяется на newFilter.

QStringList QHelpEngineCore::customFilters() const

Возвращает список настраиваемых фильтров.

См. также addCustomFilter() и removeCustomFilter().

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 QStringList &filterAttributes, const QString &extensionFilter = QString())

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

QList<QStringList> QHelpEngineCore::filterAttributeSets(const QString &namespaceName) const

Возвращает список атрибутов фильтра для различных разделов фильтра, определённых в файле сжатой справки Qt с данным пространством имён namespaceName.

QStringList QHelpEngineCore::filterAttributes() const

Возвращает список всех определённых атрибутов фильтра.

QStringList QHelpEngineCore::filterAttributes(const QString &filterName) const

Возвращает список атрибутов фильтра, используемых пользовательским фильтром filterName.

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

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

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

Возвращает карту найденных совпадений для id. Совпадение содержит заголовок документа и 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().

[signal] void QHelpEngineCore::readersAboutToBeInvalidated()

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

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

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

QStringList QHelpEngineCore::registeredDocumentations() const

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

bool QHelpEngineCore::removeCustomFilter(const QString &filterName)

Возвращает true, если фильтр filterName был успешно удален, иначе false.

См. также addCustomFilter() и customFilters().

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

bool QHelpEngineCore::setupData()

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

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

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

[signal] void QHelpEngineCore::setupFinished()

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

[signal] void QHelpEngineCore::setupStarted()

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

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

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

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

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

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