Класс QHelpEngineCore

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

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

Свойства

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

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

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

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

Сигналы

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

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

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

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

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

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

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

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

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

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

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

Этот класс не предоставляет никаких компонентов или функций интерфейса пользователя для индексов или содержимого. Если вам нужен один из них, используйте 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 Collection файлов (.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. Содержимое возвращаемой карты зависит от текущего фильтра, то есть возвращаются только ключевые слова, зарегистрированные для текущего фильтра.

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

Возвращает все документы, найденные для ключевого слова keyword. Возвращаемая карта состоит из заголовков документов и их URL.

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

[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.