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
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
QCompressedHelpInfo
¶ QCompressedHelpInfo(other)
- param other
Constructs empty information about a compressed help file.
Constructs a copy of
other
.
-
PySide2.QtHelp.QCompressedHelpInfo.
component
()¶ - Return type
unicode
Returns the component of the compressed help file.
-
static
PySide2.QtHelp.QCompressedHelpInfo.
fromCompressedHelpFile
(documentationFileName)¶ - Parameters
documentationFileName – unicode
- Return type
Returns the
QCompressedHelpInfo
instance for thedocumentationFileName
of the existing qch file.
-
PySide2.QtHelp.QCompressedHelpInfo.
namespaceName
()¶ - Return type
unicode
Returns the namespace name of the compressed help file.
-
PySide2.QtHelp.QCompressedHelpInfo.
swap
(other)¶ - Parameters
other –
QCompressedHelpInfo
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
QVersionNumber
Returns the version of the compressed help file.