ViewsExample Class Reference

Small native view monitor with a separate, user-initiated visibility command. More...

Inheritance diagram for ViewsExample:

Collaboration diagram for ViewsExample:

Public Member Functions
ExtensionInfo	info () const override
	Return metadata matching the configured independent module.
bool	initialize (ExtensionHost *host, QString *error) override
	Discover optional interfaces, subscribe before snapshotting and mount a panel.
void	shutdown () override
	End managed subscriptions and release borrowed capabilities before unload.
QString	id () const override
	Identify the extension-local dock contribution.
QString	title () const override
	Name the view monitor.
QWidget *	create (ExtensionHost *host) override
	Construct a copied metadata summary and an explicit layer command.
Public Member Functions inherited from OpenSWMM::Sdk::IGuiExtension
virtual	~IGuiExtension ()=default
	Destroy the interface; the Qt loader owns the implementing QObject.
virtual QStringList	contributions () const
	Advertise supported contribution families for diagnostics.
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

Small native view monitor with a separate, user-initiated visibility command.

Member Function Documentation

create()

QWidget * ViewsExample::create ( ExtensionHost *  host )

inlineoverridevirtual

Construct a copied metadata summary and an explicit layer command.

Parameters

[in]

host

Borrowed host; the capabilities have already been discovered.

Returns

New widget transferred to host ownership.

Implements OpenSWMM::Sdk::IDockPanelFactory.

Here is the call graph for this function:

id()

QString ViewsExample::id ( ) const

inlineoverridevirtual

Identify the extension-local dock contribution.

Returns

Stable local dock key.

Implements OpenSWMM::Sdk::IDockPanelFactory.

info()

ExtensionInfo ViewsExample::info ( ) const

inlineoverridevirtual

Return metadata matching the configured independent module.

Returns

Owning identity/caption/license values.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the caller graph for this function:

initialize()

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

inlineoverridevirtual

Discover optional interfaces, subscribe before snapshotting and mount a panel.

Parameters

[in]	host	Borrowed per-plugin host.
[out]	error	Missing service or panel-registration detail.

Returns

True after all required services and the panel are registered.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the call graph for this function:

shutdown()

void ViewsExample::shutdown ( )

inlineoverridevirtual

End managed subscriptions and release borrowed capabilities before unload.

Implements OpenSWMM::Sdk::IGuiExtension.

title()

QString ViewsExample::title ( ) const

inlineoverridevirtual

Name the view monitor.

Returns

User-facing caption.

Implements OpenSWMM::Sdk::IDockPanelFactory.

---

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

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