QHelpEngine¶

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

Inheritance diagram of PySide2.QtHelp.QHelpEngine

Synopsis¶

Functions¶

Detailed Description¶

class PySide2.QtHelp.QHelpEngine(collectionFile[, parent=None])¶
param parent:

PySide2.QtCore.QObject

param collectionFile:

str

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.

PySide2.QtHelp.QHelpEngine.contentModel()¶
Return type:

PySide2.QtHelp.QHelpContentModel

Returns the content model.

PySide2.QtHelp.QHelpEngine.contentWidget()¶
Return type:

PySide2.QtHelp.QHelpContentWidget

Returns the content widget.

PySide2.QtHelp.QHelpEngine.indexModel()¶
Return type:

PySide2.QtHelp.QHelpIndexModel

Returns the index model.

PySide2.QtHelp.QHelpEngine.indexWidget()¶
Return type:

PySide2.QtHelp.QHelpIndexWidget

Returns the index widget.

PySide2.QtHelp.QHelpEngine.searchEngine()¶
Return type:

PySide2.QtHelp.QHelpSearchEngine

Returns the default search engine.