QHelpEngineCore Class

成员函数文档

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

使用parent 构建一个新的核心帮助引擎。帮助引擎使用collectionFile 中存储的信息提供帮助。如果集合文件尚不存在，则将创建该文件。

[virtual noexcept] QHelpEngineCore::~QHelpEngineCore()

销毁帮助引擎。

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

创建文件fileName ，并将当前集合文件中的所有内容复制到新创建的文件中，如果成功则返回 true，否则返回 false。

复制过程会确保对 Qt XML Collection 文件 (.qch) 文件的文件引用得到相应更新。

QVariant QHelpEngineCore::customValue(const QString &key, const QVariant &defaultValue = {}) const

返回分配给key 的值。如果请求的键不存在，则返回指定的defaultValue 。

另请参阅 setCustomValue() 和removeCustomValue()。

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

返回由namespaceName 标识的 Qt 压缩帮助文件 (.qch) 的绝对文件名。如果没有注册指定名称空间的 Qt 压缩帮助文件，则返回空字符串。

另请参阅 namespaceName().

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id) const

返回为id 找到的所有文档链接的列表。返回的列表内容取决于当前筛选器，因此只会返回为当前筛选器注册的关键词。

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id, const QString &filterName) const

返回为id 找到的文档链接列表，按filterName 进行筛选。返回的列表内容取决于传递的过滤器，因此只会返回为该过滤器注册的关键字。如果您想得到所有未经筛选的结果，请将空字符串作为filterName 。

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword) const

返回为keyword 找到的所有文档链接的列表。返回的列表内容取决于当前筛选器，因此只会返回为当前筛选器注册的关键词。

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword, const QString &filterName) const

返回为keyword 找到的文档链接列表，按filterName 进行筛选。返回的列表内容取决于传递的过滤器，因此只会返回为该过滤器注册的关键字。如果您想得到所有未经筛选的结果，请将空字符串作为filterName 。

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 = {})

返回namespaceName 的 Qt 压缩帮助文件中包含的文件列表。文件可按filterName 以及扩展名extensionFilter （如 "html"）筛选。

QHelpFilterEngine *QHelpEngineCore::filterEngine() const

返回与此帮助引擎相关的过滤器引擎。过滤器引擎允许为该帮助引擎添加、更改和删除现有过滤器。要使用该引擎，还必须调用setUsesFilterEngine() 设置为true 。

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

Returns the corrected URL for theurl that may refer to a different namespace defined by the virtual folder defined as a part of theurl. If the virtual folder matches the namespace of theurl, the method just checks if the file exists and returns the sameurl.如果虚拟文件夹与url 的命名空间不匹配，则会尝试根据活动过滤器查找最匹配的命名空间。找到命名空间后，如果文件存在，则返回更正后的 URL，否则返回无效 URL。

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

返回 Qt XML 压缩帮助文件documentationFileName 的元数据。如果name 没有可用数据，则返回无效的 QVariant()。元数据是在创建 Qt 压缩帮助文件时定义的，以后不能修改。常见的元数据包括文档的作者等。

[static] QString QHelpEngineCore::namespaceName(const QString &documentationFileName)

返回由documentationFileName 指定的 Qt 压缩帮助文件 (.qch) 所定义的命名空间名称。如果文件无效，则返回空字符串。

另请参阅 documentationFileName().

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

注册文件documentationFileName 中包含的 Qt 压缩帮助文件（.qch）。一个压缩帮助文件只能注册一次，其名称空间唯一标识。如果注册成功，则返回 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)

保存key 下的value 。如果键值已经存在，该值将被覆盖。如果值保存成功，则返回 true，否则返回 false。

另请参阅 customValue() 和removeCustomValue()。

void QHelpEngineCore::setUsesFilterEngine(bool uses)

根据传入的uses 参数，启用或禁用帮助引擎内部的新过滤引擎功能。

另请参阅 usesFilterEngine() 和filterEngine()。

bool QHelpEngineCore::setupData()

通过处理集合文件中的信息来设置帮助引擎，如果成功则返回 true，否则返回 false。

调用该函数后，帮助引擎将被迫立即初始化。大多数情况下，无需明确调用该函数，因为依赖于正确设置的帮助引擎的获取函数会自行完成初始化。

[signal] void QHelpEngineCore::setupFinished()

设置完成时发出该信号。

[signal] void QHelpEngineCore::setupStarted()

该信号在设置开始时发出。

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

从 help 集合中取消注册由namespaceName 标识的 Qt 压缩帮助文件 (.qch) 。成功时返回 true，否则返回 false。

另请参阅 registerDocumentation() 和error()。

bool QHelpEngineCore::usesFilterEngine() const

返回帮助引擎是否使用了新的过滤器功能。

另请参阅 setUsesFilterEngine() 和filterEngine()。

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

当发生非严重错误时会发出该信号。警告信息存储在msg 中。