HelpSearchEngine

Qt Base Class: QHelpSearchEngine

Signature: QHelpSearchEngine(self, helpEngine: PySide6.QtHelp.QHelpEngineCore, parent: Optional[PySide6.QtCore.QObject] = None) -> None

Base classes

Name	Children	Inherits
ObjectMixin prettyqt.core.object	Object SocketNotifier SharedMemory SignalMapper TimeLine AbstractEventDispatcher EventLoop AbstractAnimationMixin TranslatorMixin CoreApplicationMixin ...	object
QHelpSearchEngine PySide6.QtHelp QHelpSearchEngine(self, helpEngine: PySide6.QtHelp.QHelpEngineCore, parent: Optional[PySide6.QtCore.QObject] \= None) -> None	HelpSearchEngine	QObject

⋔ Inheritance diagram

graph TD
  1473572352080["qthelp.HelpSearchEngine"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473572314016["QtHelp.QHelpSearchEngine"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473299815024 --> 1473572352080
  140713234304496 --> 1473299815024
  1473572314016 --> 1473572352080
  1473288842240 --> 1473572314016
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: ObjectMixin, QHelpSearchEngine

Access to widgets reusable to integrate fulltext search.

Source code in prettyqt\qthelp\helpsearchengine.py

class HelpSearchEngine(core.ObjectMixin, qthelp.QHelpSearchEngine):
    """Access to widgets reusable to integrate fulltext search."""

    def search_results(self, start: int, end: int) -> list[qthelp.HelpSearchResult]:
        return [qthelp.HelpSearchResult(i) for i in self.searchResults(start, end)]

    def get_result_widget(self) -> qthelp.HelpSearchResultWidget:
        return qthelp.HelpSearchResultWidget(self.resultWidget())

⌗ Property table

Qt Property	Type	Doc
objectName	QString