QCompressedHelpInfo¶
The
QCompressedHelpInfo
class provides access to the details about a compressed help file. More…
New in version 5.13.
Synopsis¶
Functions¶
def
component
()def
isNull
()def
namespaceName
()def
swap
(other)def
version
()
Static functions¶
def
fromCompressedHelpFile
(documentationFileName)
Detailed Description¶
The detailed information about the compressed help file can be fetched by calling the
fromCompressedHelpFile()
static method, providing the path to the compressed help file.The class provides access to various information about a compressed help file. The namespace associated with the given compressed help file is
namespaceName()
, the associated component name iscomponent()
andversion()
provides version information.See also
- class PySide2.QtHelp.QCompressedHelpInfo¶
PySide2.QtHelp.QCompressedHelpInfo(other)
- param other:
Constructs empty information about a compressed help file.
- PySide2.QtHelp.QCompressedHelpInfo.component()¶
- Return type:
str
Returns the component of the compressed help file.
- static PySide2.QtHelp.QCompressedHelpInfo.fromCompressedHelpFile(documentationFileName)¶
- Parameters:
documentationFileName – str
- Return type:
Returns the
QCompressedHelpInfo
instance for thedocumentationFileName
of the existing qch file.
- PySide2.QtHelp.QCompressedHelpInfo.isNull()¶
- Return type:
bool
Returns
true
if the info is invalid, otherwise returnsfalse
.
- PySide2.QtHelp.QCompressedHelpInfo.namespaceName()¶
- Return type:
str
Returns the namespace name of the compressed help file.
- PySide2.QtHelp.QCompressedHelpInfo.swap(other)¶
- Parameters:
Swaps the compressed help file
other
with this compressed help file. This operation is very fast and never fails.
- PySide2.QtHelp.QCompressedHelpInfo.version()¶
- Return type:
Returns the version of the compressed help file.
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.