QCompressedHelpInfo#

The QCompressedHelpInfo class provides access to the details about a compressed help file. More…

Synopsis#

Functions#

def component ()
def isNull ()
def namespaceName ()
def swap (other)
def version ()

Static functions#

def fromCompressedHelpFile (documentationFileName)

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 is component() and version() provides version information.

See also

QHelpFilterEngine

class PySide6.QtHelp.QCompressedHelpInfo#

PySide6.QtHelp.QCompressedHelpInfo(other)

Parameters:: other – PySide6.QtHelp.QCompressedHelpInfo

Constructs empty information about a compressed help file.

Constructs a copy of other.

PySide6.QtHelp.QCompressedHelpInfo.component()#

Return type:: str

Returns the component of the compressed help file.

static PySide6.QtHelp.QCompressedHelpInfo.fromCompressedHelpFile(documentationFileName)#

Parameters:: documentationFileName – str
Return type:: PySide6.QtHelp.QCompressedHelpInfo

Returns the QCompressedHelpInfo instance for the documentationFileName of the existing qch file.

PySide6.QtHelp.QCompressedHelpInfo.isNull()#

Return type:: bool

Returns true if the info is invalid, otherwise returns false.

PySide6.QtHelp.QCompressedHelpInfo.namespaceName()#

Return type:: str

Returns the namespace name of the compressed help file.

PySide6.QtHelp.QCompressedHelpInfo.swap(other)#

Parameters:: other – PySide6.QtHelp.QCompressedHelpInfo

Swaps the compressed help file other with this compressed help file. This operation is very fast and never fails.

PySide6.QtHelp.QCompressedHelpInfo.version()#

Return type:: PySide6.QtCore.QVersionNumber

Returns the version of the compressed help file.