Skip to content

HelpEngine

Qt Base Class: QHelpEngine

Signature: QHelpEngine(self, collectionFile: str, parent: Optional[PySide6.QtCore.QObject] = None) -> None

Base classes

Name Children Inherits
HelpEngineCoreMixin
prettyqt.qthelp.helpenginecore
The core functionality of the help system.
QHelpEngine
PySide6.QtHelp
QHelpEngine(self, collectionFile: str, parent: Optional[PySide6.QtCore.QObject] \= None) -> None

⋔ Inheritance diagram

graph TD
  1473572368672["qthelp.HelpEngine"]
  1473572363792["qthelp.HelpEngineCoreMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473572310112["QtHelp.QHelpEngine"]
  1473572342320["QtHelp.QHelpEngineCore"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473572363792 --> 1473572368672
  1473299815024 --> 1473572363792
  140713234304496 --> 1473299815024
  1473572310112 --> 1473572368672
  1473572342320 --> 1473572310112
  1473288842240 --> 1473572342320
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: HelpEngineCoreMixin, QHelpEngine

Access to contents and indices of the help engine.

Source code in prettyqt\qthelp\helpengine.py 
 6
 7
 8
 9
10
class HelpEngine(qthelp.HelpEngineCoreMixin, qthelp.QHelpEngine):
    """Access to contents and indices of the help engine."""

    def get_content_model(self) -> qthelp.HelpContentModel:
        return qthelp.HelpContentModel(self.contentModel())

⌗ Property table

Qt Property Type Doc
objectName QString
autoSaveFilter bool
collectionFile QString
readOnly bool
currentFilter QString