QHelpEngine¶
The QHelpEngine
class provides access to contents and indices of the help engine. More…
Synopsis¶
Functions¶
def
contentModel
()def
contentWidget
()def
indexModel
()def
indexWidget
()def
searchEngine
()
Detailed Description¶
- class PySide6.QtHelp.QHelpEngine(collectionFile[, parent=None])¶
- Parameters
collectionFile – str
parent –
PySide6.QtCore.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.
- PySide6.QtHelp.QHelpEngine.contentModel()¶
- Return type
Returns the content model.
- PySide6.QtHelp.QHelpEngine.contentWidget()¶
- Return type
Returns the content widget.
- PySide6.QtHelp.QHelpEngine.indexModel()¶
- Return type
Returns the index model.
- PySide6.QtHelp.QHelpEngine.indexWidget()¶
- Return type
Returns the index widget.
- PySide6.QtHelp.QHelpEngine.searchEngine()¶
- Return type
Returns the default search engine.