- class QCompressedHelpInfo#
The
QCompressedHelpInfo
class provides access to the details about a compressed help file. More…Synopsis#
Methods#
def
__init__()
def
component()
def
isNull()
def
namespaceName()
def
swap()
def
version()
Static functions#
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
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
- __init__()#
Constructs empty information about a compressed help file.
- __init__(other)
- Parameters:
other –
QCompressedHelpInfo
Constructs a copy of
other
.- component()#
- Return type:
str
Returns the component of the compressed help file.
- static fromCompressedHelpFile(documentationFileName)#
- Parameters:
documentationFileName – str
- Return type:
Returns the
QCompressedHelpInfo
instance for thedocumentationFileName
of the existing qch file.- isNull()#
- Return type:
bool
Returns
true
if the info is invalid, otherwise returnsfalse
.- namespaceName()#
- Return type:
str
Returns the namespace name of the compressed help file.
- swap(other)#
- Parameters:
other –
QCompressedHelpInfo
Swaps the compressed help file
other
with this compressed help file. This operation is very fast and never fails.- version()#
- Return type:
Returns the version of the compressed help file.