HelpEngineCoreMixin

Base classes

Name	Children	Inherits
ObjectMixin prettyqt.core.object	Object SocketNotifier SharedMemory SignalMapper TimeLine AbstractEventDispatcher EventLoop AbstractAnimationMixin TranslatorMixin CoreApplicationMixin ...	object

Subclasses

Class	Module	Description
HelpEngineCore	prettyqt.qthelp.helpenginecore
HelpEngine	prettyqt.qthelp.helpengine

⋔ Inheritance diagram

graph TD
  1473572363792["qthelp.HelpEngineCoreMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473299815024 --> 1473572363792
  140713234304496 --> 1473299815024

🛈 DocStrings

Bases: ObjectMixin

The core functionality of the help system.

Source code in prettyqt\qthelp\helpenginecore.py

class HelpEngineCoreMixin(core.ObjectMixin):
    """The core functionality of the help system."""

    def get_file_data(self, url: core.QUrl) -> bytes:
        return self.fileData(url).data()

    def get_files(
        self,
        namespace_name: str,
        filter_name: str,
        extension_filter: str | None = None,
    ) -> list[core.Url]:
        if extension_filter is None:
            extension_filter = ""
        return [
            core.Url(i) for i in self.files(namespace_name, filter_name, extension_filter)
        ]

    def find_file(self, url: datatypes.UrlType) -> core.Url:
        if not isinstance(url, core.QUrl):
            url = core.QUrl(url)
        return core.Url(self.findFile(url))

    def get_filter_engine(self) -> qthelp.HelpFilterEngine:
        return qthelp.HelpFilterEngine(self.filterEngine())