class QHelpEngineCore#

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

Inheritance diagram of PySide6.QtHelp.QHelpEngineCore

继承自: QHelpEngine

摘要#

属性#

方法#

信号#

静态函数#

注意

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

详细描述#

在帮助引擎可以使用之前，必须通过调用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时，可以直接使用属性。否则，通过访问器函数使用。

属性autoSaveFilter:bool#

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

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

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

访问函数
propertycollectionFile:str#

这个属性包含当前正在使用的集合文件的绝对文件名。

设置此属性会使帮助引擎处于无效状态。请务必调用 setupData() 或任何获取函数，以便重新设置帮助引擎。

访问函数
propertycurrentFilter:str#

这个属性包含当前应用的自定义过滤器的名称。

应使用 activeFilter() 替代。

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

另请参阅

autoSaveFilter()

访问函数
propertyreadOnly:bool#

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

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

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

访问函数
__init__(collectionFile[, parent=None])#
参数:

  • collectionFile – str

  • parent – QObject

用父节点构建一个新的核心帮助引擎。帮助引擎会使用存储在 collectionFile 中的信息来提供帮助。如果收集文件还不存在，将会被创建。

addCustomFilter(filterName, attributes)#
参数:

  • filterName – 字符串

  • attributes – 字符串列表

返回类型：

布尔值

setFilterData() 应该被使用。

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

autoSaveFilter()#
返回类型：

布尔值

另请参阅

setAutoSaveFilter()

属性 autoSaveFilterᅟ 的获取器。

collectionFile()#
返回类型：

字符串

另请参阅

setCollectionFile()

属性 collectionFileᅟ 的获取器。

copyCollectionFile(fileName)#
参数:

fileName – 字符串

返回类型：

布尔值

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

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

currentFilter()#
返回类型：

字符串

另请参阅

setCurrentFilter()

属性 currentFilterᅟ 的获取器。

currentFilterChanged(newFilter)#
参数:

newFilter – 字符串

filterActivated() 应该被使用。

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

customFilters()#
返回类型：

字符串列表

应使用 filters()。

返回一个自定义过滤器列表。

customValue(key[, defaultValue=None])#
参数:

  • key – str

  • defaultValue – object

返回类型：

object

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

documentationFileName(namespaceName)#
参数:

namespaceName – str

返回类型：

字符串

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

另请参阅

namespaceName()

documentsForIdentifier(id)#
参数:

id – str

返回类型：

. QHelpLink 列表

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

documentsForIdentifier(id, filterName)
参数:

  • id – str

  • filterName – 字符串

返回类型：

. QHelpLink 列表

返回针对 id 找到的文档链接列表，由 filterName 过滤。返回列表的内容取决于传递的过滤器，因此只返回注册到此过滤器的关键字。如果要获取未过滤的所有结果，将空字符串作为 filterName 传递。

documentsForKeyword(keyword)#
参数:

keyword – str

返回类型：

. QHelpLink 列表

返回所有在keyword中找到的文档链接列表。返回列表的内容取决于当前筛选条件，因此仅返回当前筛选条件中注册的关键字。

documentsForKeyword(keyword, filterName)
参数:

  • keyword – str

  • filterName – 字符串

返回类型：

. QHelpLink 列表

返回所有找到的文档链接列表，按filterName筛选。返回的列表内容取决于传递的筛选条件，因此仅返回此筛选条件中注册的关键字。如果您想获取所有未筛选的结果，请将空字符串作为filterName传递。

error()#
返回类型：

字符串

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

fileData(url)#
参数:

url – QUrl

返回类型：

QByteArray

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

另请参阅

findFile()

files(namespaceName, filterName[, extensionFilter=""])#
参数:

  • namespaceName – str

  • filterName – 字符串

  • extensionFilter – 字符串

返回类型：

列表 of QUrl

返回包含在指定名称空间namespaceName的Qt压缩帮助文件中的文件列表。文件可以按filterName和它们的扩展名extensionFilter（例如，'html'）进行筛选。

files(namespaceName, filterAttributes[, extensionFilter=""])
参数:

  • namespaceName – str

  • filterAttributes – 字符串列表

  • extensionFilter – 字符串

返回类型：

列表 of QUrl

应使用files()代替。

返回包含在指定名称空间namespaceName的Qt压缩帮助文件中的文件列表。文件可以按filterAttributes和它们的扩展名extensionFilter（例如，'html'）进行筛选。

filterAttributeSets(namespaceName)#
参数:

namespaceName – str

返回类型：

列表 of QStringList

应使用filterData()代替。

返回给定命名空间 namespaceName 中定义的 Qt 压缩帮助文件中不同过滤器节点的过滤器属性列表。

filterAttributes()#
返回类型：

字符串列表

应使用 availableComponents() 来代替。

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

filterAttributes(filterName)
参数:

filterName – 字符串

返回类型：

字符串列表

应使用filterData()代替。

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

filterEngine()#
返回类型：

QHelpFilterEngine

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

findFile(url)#
参数:

url – QUrl

返回类型：

QUrl

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

isReadOnly()#
返回类型：

布尔值

属性 readOnly 的获取器。

static metaData(documentationFileName, name)#
参数:

  • documentationFileName – str

  • name – str

返回类型：

object

返回 Qt 压缩帮助文件 documentationFileName 的元数据。如果无法获取 name 的数据，则返回一个无效的 QVariant()。元数据在创建 Qt 压缩帮助文件时定义，以后无法修改。通用的元数据包括例如文档的作者。

static namespaceName(documentationFileName)#
参数:

documentationFileName – str

返回类型：

字符串

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

readersAboutToBeInvalidated()#
registerDocumentation(documentationFileName)#
参数:

documentationFileName – str

返回类型：

布尔值

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

registeredDocumentations()#
返回类型：

字符串列表

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

removeCustomFilter(filterName)#
参数:

filterName – 字符串

返回类型：

布尔值

应使用 removeFilter() 代替。

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

removeCustomValue(key)#
参数:

key – str

返回类型：

布尔值

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

setAutoSaveFilter(save)#
参数:

save – bool

另请参阅

autoSaveFilter()

属性 autoSaveFilter 的设置器。

setCollectionFile(fileName)#
参数:

fileName – 字符串

另请参阅

collectionFile()

属性 collectionFile 的设置器。

setCurrentFilter(filterName)#
参数:

filterName – 字符串

另请参阅

currentFilter()

属性 currentFilter 的设置器。

setCustomValue(key, value)#
参数:

  • key – str

  • value – 对象

返回类型：

布尔值

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

setReadOnly(enable)#
参数:

enable – bool

另请参阅

isReadOnly()

属性 readOnly 的设置器。

setUsesFilterEngine(uses)#
参数:

uses – bool

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

setupData()#
返回类型：

布尔值

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

通过调用此函数，帮助引擎将被强制立即初始化。大多数情况下，无需显式调用此函数，因为依赖于正确设置的帮助引擎的获取函数会自行执行。

注意

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

setupFinished()#

在设置完成时发出此信号。

setupStarted()#

当启动设置时，会发出此信号。

unregisterDocumentation(namespaceName)#
参数:

namespaceName – str

返回类型：

布尔值

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

usesFilterEngine()#
返回类型：

布尔值

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

warning(msg)#
参数:

msg – str

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