PySide6.QtHelp.QHelpEngineCore¶

class QHelpEngineCore¶

QHelpEngineCore 类提供了帮助系统的核心功能。更多…

继承者： QHelpEngine

概要¶

属性¶

autoSaveFilterᅟ - QHelpEngineCore 是否处于自动保存过滤器模式
collectionFileᅟ - 当前使用的集合文件的绝对文件名
currentFilterᅟ - 当前应用的自定义过滤器的名称
readOnlyᅟ - 帮助引擎是否为只读

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述¶

在使用帮助引擎之前，必须通过调用setupData()来初始化它。在设置过程开始时，会发出信号setupStarted()。从这一点开始，直到发出信号setupFinished()，帮助数据处于未定义的不可用状态。

核心帮助引擎可用于执行不同的任务。通过调用documentsForIdentifier()，引擎返回指定帮助系统内文件位置的URL。然后可以通过调用fileData()来检索实际的文件数据。

帮助引擎可以包含任意数量的自定义过滤器。过滤器的管理，包括添加新过滤器、更改过滤器定义或删除现有过滤器，都是通过QHelpFilterEngine类完成的，可以通过filterEngine()方法访问。

注意

QHelpFilterEngine 替换了自 Qt 5.13 起已弃用的旧过滤器 API。调用 setUsesFilterEngine() 并传入 true 以启用新功能。

核心帮助引擎有两种模式：

只读模式，除非明确请求，否则不会更改帮助集合文件。如果集合文件位于只读位置，此模式也适用，并且是默认设置。

完全可写模式，需要帮助集合文件可写。

模式可以通过在调用setupData()之前调用setReadOnly()方法来更改。

帮助引擎还提供了以类似于ini文件或Windows注册表条目的方式设置和读取值的可能性。有关更多信息，请参见setValue()或value()。

此类不提供任何用于索引或内容的GUI组件或功能。如果您需要这些功能，请改用QHelpEngine。

注意

当使用from __feature__ import true_property时，属性可以直接使用，否则通过访问器函数使用。

property autoSaveFilterᅟ: bool¶

此属性表示QHelpEngineCore是否处于自动保存过滤器模式。

如果QHelpEngineCore处于自动保存过滤器模式，当通过setActiveFilter()函数更改当前过滤器时，过滤器会自动保存。过滤器会持久保存在帮助集合文件中。

默认情况下，此模式处于开启状态。

Access functions:

autoSaveFilter()
setAutoSaveFilter()

property collectionFileᅟ: str¶

此属性保存当前使用的集合文件的绝对文件名。

设置此属性会使帮助引擎处于无效状态。重要的是要调用setupData()或任何getter函数以重新设置帮助引擎。

Access functions:

collectionFile()
setCollectionFile()

property currentFilterᅟ: str¶

此属性保存当前应用的自定义过滤器的名称。

activeFilter() 应该被使用。

设置此属性将永久保存新的自定义过滤器到帮助集合文件中。要设置自定义过滤器而不永久保存，请禁用自动保存过滤器模式。

另请参阅

autoSaveFilter()

Access functions:

currentFilter()
setCurrentFilter()

property readOnlyᅟ: bool¶

此属性表示帮助引擎是否为只读。

在只读模式下，用户可以使用安装在只读位置的集合文件的帮助引擎。在这种情况下，某些功能将不可用，例如注册额外的文档、过滤器编辑或任何需要对集合文件进行更改的操作。将其设置为false可以启用帮助引擎的全部功能。

默认情况下，此属性为 true。

Access functions:

isReadOnly()
setReadOnly()

__init__(collectionFile[, parent=None])¶

Parameters:

collectionFile – str
parent – QObject

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

addCustomFilter(filterName, attributes)¶

Parameters:

filterName – str
attributes – 字符串列表

Return type:

布尔

setFilterData() 应该被使用。

添加新的自定义过滤器 filterName。过滤器的属性由 attributes 指定。如果过滤器已经存在，其属性集将被替换。如果操作成功，函数返回 true，否则返回 false。

另请参阅

customFilters() removeCustomFilter()

autoSaveFilter()¶

Return type:: 布尔

另请参阅

setAutoSaveFilter()

属性 autoSaveFilterᅟ 的获取器。

collectionFile()¶

Return type:: 字符串

另请参阅

setCollectionFile()

属性 collectionFileᅟ 的获取器。

copyCollectionFile(fileName)¶

Parameters:: fileName – str
Return type:: 布尔

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

复制过程确保对Qt集合文件（.qch）文件的引用会相应更新。

currentFilter()¶

Return type:: 字符串

另请参阅

setCurrentFilter()

属性 currentFilterᅟ 的获取器。

currentFilterChanged(newFilter)¶

Parameters:: newFilter – str

filterActivated() 应该被使用。

当当前过滤器更改为 newFilter 时，会发出此信号。

customFilters()¶

Return type:: 字符串列表

filters() 应该被使用。

返回自定义过滤器的列表。

另请参阅

addCustomFilter() removeCustomFilter()

customValue(key[, defaultValue={}])¶

Parameters:

key – str
defaultValue – 对象

Return type:

对象

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

另请参阅

setCustomValue() removeCustomValue()

documentationFileName(namespaceName)¶

Parameters:: namespaceName – str
Return type:: 字符串

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

另请参阅

namespaceName()

documentsForIdentifier(id)¶

Parameters:: id – str
Return type:: QHelpLink的列表

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

documentsForIdentifier(id, filterName)

Parameters:

id – str
filterName – str

Return type:

QHelpLink的列表

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

documentsForKeyword(keyword)¶

Parameters:: keyword – str
Return type:: QHelpLink的列表

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

documentsForKeyword(keyword, filterName)

Parameters:

keyword – str
filterName – str

Return type:

QHelpLink的列表

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

error()¶

Return type:: 字符串

返回最后发生的错误的描述。

fileData(url)¶

Parameters:: url – QUrl
Return type:: QByteArray

返回由url指定的文件的数据。如果文件不存在，则返回一个空的QByteArray。

另请参阅

findFile()

files(namespaceName, filterName[, extensionFilter={}])¶

Parameters:

namespaceName – str
filterName – str
extensionFilter – str

Return type:

.list of QUrl

返回包含在Qt压缩帮助文件中的文件列表，这些文件可以通过namespaceName进行过滤。文件还可以通过filterName以及它们的扩展名extensionFilter（例如，‘html’）进行过滤。

files(namespaceName, filterAttributes[, extensionFilter={}])

Parameters:

namespaceName – str
filterAttributes – 字符串列表
extensionFilter – str

Return type:

.list of QUrl

files() 应该被使用。

返回包含在Qt压缩帮助文件namespaceName中的文件列表。文件可以通过filterAttributes以及它们的扩展名extensionFilter（例如‘html’）进行过滤。

filterAttributeSets(namespaceName)¶

Parameters:: namespaceName – str
Return type:: .QStringList 列表

filterData() 应该被使用。

返回在Qt压缩帮助文件中定义的不同过滤器部分的过滤器属性列表，使用给定的命名空间namespaceName。

filterAttributes()¶

Return type:: 字符串列表

availableComponents() 应该被使用。

返回所有已定义的过滤器属性的列表。

filterAttributes(filterName)

Parameters:: filterName – str
Return type:: 字符串列表

filterData() 应该被使用。

返回由自定义过滤器filterName使用的过滤器属性列表。

filterEngine()¶

Return type:: QHelpFilterEngine

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

findFile(url)¶

Parameters:: url – QUrl
Return type:: QUrl

返回可能引用由虚拟文件夹定义的不同命名空间的url的修正URL。如果虚拟文件夹与url的命名空间匹配，该方法仅检查文件是否存在并返回相同的url。当虚拟文件夹与url的命名空间不匹配时，它会尝试根据活动过滤器找到最佳匹配的命名空间。找到命名空间后，如果文件存在，则返回修正的URL，否则返回无效的URL。

isReadOnly()¶

Return type:: 布尔

属性 readOnlyᅟ 的获取器。

static metaData(documentationFileName, name)¶

Parameters:

documentationFileName – str
name – str

Return type:

对象

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

static namespaceName(documentationFileName)¶

Parameters:: documentationFileName – str
Return type:: 字符串

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

另请参阅

documentationFileName()

readersAboutToBeInvalidated()¶

registerDocumentation(documentationFileName)¶

Parameters:: documentationFileName – str
Return type:: 布尔

注册包含在文件documentationFileName中的Qt压缩帮助文件(.qch)。一个由其命名空间唯一标识的压缩帮助文件只能注册一次。如果注册成功，则返回true，否则返回false。

另请参阅

unregisterDocumentation() error()

registeredDocumentations()¶

Return type:: 字符串列表

返回当前集合文件中所有已注册的Qt压缩帮助文件的列表。返回的名称是已注册的Qt压缩帮助文件（.qch）的命名空间。

removeCustomFilter(filterName)¶

Parameters:: filterName – str
Return type:: 布尔

removeFilter() 应该被使用。

如果过滤器 filterName 被成功移除，则返回 true，否则返回 false。

另请参阅

addCustomFilter() customFilters()

removeCustomValue(key)¶

Parameters:: key – str
Return type:: 布尔

从集合文件的设置部分移除key。如果值成功移除，则返回true，否则返回false。

另请参阅

customValue() setCustomValue()

setAutoSaveFilter(save)¶

Parameters:: save – 布尔值

另请参阅

autoSaveFilter()

属性 autoSaveFilterᅟ 的设置器。

setCollectionFile(fileName)¶

Parameters:: fileName – str

另请参阅

collectionFile()

属性 collectionFileᅟ 的设置器。

setCurrentFilter(filterName)¶

Parameters:: filterName – str

另请参阅

currentFilter()

属性 currentFilterᅟ 的设置器。

setCustomValue(key, value)¶

Parameters:

key – str
value – 对象

Return type:

布尔

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

另请参阅

customValue() removeCustomValue()

setReadOnly(enable)¶

Parameters:: enable – 布尔值

另请参阅

isReadOnly()

属性 readOnlyᅟ 的设置器。

setUsesFilterEngine(uses)¶

Parameters:: 用途 – bool

根据传递的uses参数，启用或禁用帮助引擎中的新过滤器引擎功能。

另请参阅

usesFilterEngine() filterEngine()

setupData()¶

Return type:: 布尔

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

通过调用该函数，帮助引擎被迫立即初始化自身。大多数情况下，不需要显式调用此函数，因为依赖于正确设置的帮助引擎的getter函数会自行完成此操作。

注意

qsqlite4.dll 需要与应用程序一起部署，因为帮助系统在加载帮助集合时使用 sqlite 驱动程序。

setupFinished()¶

当设置完成时，会发出此信号。

setupStarted()¶

当设置开始时发出此信号。

unregisterDocumentation(namespaceName)¶

Parameters:: namespaceName – str
Return type:: 布尔

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

另请参阅

registerDocumentation() error()

usesFilterEngine()¶

Return type:: 布尔

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

另请参阅

setUsesFilterEngine() filterEngine()

warning(msg)¶

Parameters:: msg – 字符串

当发生非关键错误时，会发出此信号。警告消息存储在msg中。

PySide6.QtHelp.QHelpEngineCore¶

概要¶

属性¶

方法¶

信号¶

静态函数¶

详细描述¶