ExampleExtension Class Reference

Minimal installed-SDK plugin contributing one ribbon command and a model-aware dock. More...

Inheritance diagram for ExampleExtension:

Collaboration diagram for ExampleExtension:

Public Member Functions
ExtensionInfo	info () const override
	Describe this extension and verify its identity against embedded metadata.
bool	initialize (ExtensionHost *host, QString *) override
	Register contributions after the main window exists and before projects restore.
void	shutdown () override
	Release plugin-owned resources after the host has cancelled and joined jobs.
QStringList	contributions () const override
	Advertise supported contribution families for diagnostics.
QString	id () const override
	Supply a stable extension-local dock ID.
QString	title () const override
	Supply a translated dock caption.
QWidget *	create (ExtensionHost *host) override
	Create dock contents on the GUI thread.
Public Member Functions inherited from OpenSWMM::Sdk::IGuiExtension
virtual	~IGuiExtension ()=default
	Destroy the interface; the Qt loader owns the implementing QObject.
virtual QList< ExtensionInfo >	children () const
	Enumerate extensions hosted by this plugin, such as Python-authored packages.
Public Member Functions inherited from OpenSWMM::Sdk::IDockPanelFactory
virtual	~IDockPanelFactory ()=default
	Destroy an unregistered factory; registered factories remain borrowed by the host.
virtual Qt::DockWidgetArea	defaultArea () const
	Choose initial placement before saved layout restore.
virtual QString	tabifyWith () const
	Request tabification beside an existing dock.

Detailed Description

Minimal installed-SDK plugin contributing one ribbon command and a model-aware dock.

Member Function Documentation

contributions()

QStringList ExampleExtension::contributions ( ) const

inlineoverridevirtual

Advertise supported contribution families for diagnostics.

Returns

Owning names; registration may still happen dynamically after initialize().

Reimplemented from OpenSWMM::Sdk::IGuiExtension.

create()

QWidget * ExampleExtension::create ( ExtensionHost *  host )

inlineoverridevirtual

Create dock contents on the GUI thread.

Parameters

[in]

host

Borrowed initialized host.

Returns

New widget transferred to host ownership, or null to refuse registration.

Implements OpenSWMM::Sdk::IDockPanelFactory.

Here is the call graph for this function:

id()

QString ExampleExtension::id ( ) const

inlineoverridevirtual

Supply a stable extension-local dock ID.

Returns

Nonempty identity unique within the extension.

Implements OpenSWMM::Sdk::IDockPanelFactory.

info()

ExtensionInfo ExampleExtension::info ( ) const

inlineoverridevirtual

Describe this extension and verify its identity against embedded metadata.

Returns

Owning metadata; id must equal the plugin.json id exactly.

Implements OpenSWMM::Sdk::IGuiExtension.

initialize()

bool ExampleExtension::initialize ( ExtensionHost *  host, QString *  error  )

inlineoverridevirtual

Register contributions after the main window exists and before projects restore.

Parameters

[in]	host	Borrowed per-extension host, valid until shutdown completes.
[out]	error	Optional human-readable startup failure reason.

Returns

True on success; false triggers partial-contribution cleanup and a Plugins diagnostic.

Note

GUI thread only. A failed initialization may still be followed by shutdown().

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the call graph for this function:

shutdown()

void ExampleExtension::shutdown ( )

inlineoverridevirtual

Release plugin-owned resources after the host has cancelled and joined jobs.

Note

GUI thread only; release outstanding leases/scopes and detach observers here. The host subsequently destroys its UI contributions. The native library remains loaded.

Implements OpenSWMM::Sdk::IGuiExtension.

title()

QString ExampleExtension::title ( ) const

inlineoverridevirtual

Supply a translated dock caption.

Returns

User-facing title.

Implements OpenSWMM::Sdk::IDockPanelFactory.

---

The documentation for this class was generated from the following file:

• /home/runner/work/openswmm.gui/openswmm.gui/examples/extensions/template/extension.cpp