The Basics — Builder 3.26.4 documentation

# The Basics

The basic mechanics of extending the workbench requires first creating an `Ide.WorkbenchAddin`. Your subclass will created for each instance of the `Ide.Workbench`. This conveniently allows you to track the state needed for your plugin for each workbench.

A Basic WorkbenchAddin to demonstrate scaffolding

    import gi

    from gi.repository import GObject
    from gi.repository import Ide

    class BasicWorkbenchAddin(GObject.Object, Ide.WorkbenchAddin):

        def do_load(self, workbench: Ide.Workbench):
            pass

        def do_unload(self, workbench: Ide.Workbench):
            pass

You will notice that at the top we import the packages we’ll be using. Here we use the `GObject` and `Ide` packages from GObject Introspection.

We then create a class which inherits from `GObject.Object` and implements the `Ide.WorkbenchAddin` interface. The `Ide.WorkbenchAddin` interface has two virtual methods to override, `Ide.WorkbenchAddin.load()` and `Ide.WorkbenchAddin.unload()`.

Note

PyGObject uses `do_` prefix to indicate we are overriding a virtual method.

The `load` virtual method is called to allow the plugin to initialize itself. This method is called when the workbench is setup or your plugin is loaded.

When the `unload` virtual method is called the plugin should clean up after itself to leave Builder and the workbench in a consistent state. This method is called when the workbench is destroyed or your plugin is unloaded.