photons.plugins.base module

Base class for Plugins.

class photons.plugins.base.BasePlugin(main, **kwargs)[source]

Bases: QWidget

Base class for all Plugins.

Parameters:

  • main (MainWindow) – The main window.

  • **kwargs – All keyword arguments are passed to super().

closing: SignalInstance
after_show()[source]

Override in subclass. Called immediately after show().

Return type:

None

closeEvent(event)[source]

Overrides QtWidgets.QWidget.closeEvent().

Return type:

None

class photons.plugins.base.PluginInfo(cls, name, description)[source]

Bases: object

cls: type[BasePlugin]
name: str
description: str
photons.plugins.base.plugin(*, name, description)[source]

A decorator to register a Plugin.

Parameters:

  • name (str) – A name to associate with the Plugin.

  • description (str) – A short description about the Plugin.