PySide6.QtHelp.QHelpEngine¶

class QHelpEngine¶

The QHelpEngine class provides access to contents and indices of the help engine. More…

Synopsis¶

Methods¶

def __init__()
def contentModel()
def contentWidget()
def indexModel()
def indexWidget()
def searchEngine()

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¶

__init__(collectionFile[, parent=None])¶

Parameters:

collectionFile – str
parent – QObject

Constructs a new help engine with the given parent. The help engine uses the information stored in the collectionFile for providing help. If the collection file does not already exist, it will be created.

contentModel()¶

Return type:: QHelpContentModel

Returns the content model.

contentWidget()¶

Return type:: QHelpContentWidget

Returns the content widget.

indexModel()¶

Return type:: QHelpIndexModel

Returns the index model.

indexWidget()¶

Return type:: QHelpIndexWidget

Returns the index widget.

searchEngine()¶

Return type:: QHelpSearchEngine

Returns the default search engine.