IViewControls.hpp File Reference

Versioned validated canvas and attached-results commands for extensions. More...

#include <QList>
#include <QObject>
#include <QString>
#include <QUuid>

Include dependency graph for IViewControls.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	OpenSWMM::Sdk::ViewCommand
	Owning bounded request for one native view-controller action. More...
class	OpenSWMM::Sdk::IViewControls
	Frozen optional validated controller entry point for view changes. More...

Namespaces
namespace	OpenSWMM
namespace	OpenSWMM::Sdk
	Public header-only ABI for independently compiled native GUI extensions.

Macros
#define	OPENSWMM_VIEW_CONTROLS_IID   "io.opensimulator.openswmm.IViewControls/1.0"
	Frozen discovery identity for validated SDK view commands.

Enumerations
enum class	OpenSWMM::Sdk::ViewCommandKind : quint32 {   OpenSWMM::Sdk::RenameLayer = 1 ,   OpenSWMM::Sdk::SetLayerVisible = 2 ,   OpenSWMM::Sdk::SetLayerOpacity = 3 ,   OpenSWMM::Sdk::MoveLayer = 4 ,   OpenSWMM::Sdk::RemoveLayer = 5 ,   OpenSWMM::Sdk::SetLayerFilter = 6 ,   OpenSWMM::Sdk::SelectLayerFeatures = 7 ,   OpenSWMM::Sdk::ActivateResults = 8 ,   OpenSWMM::Sdk::SetResultsTime ,   OpenSWMM::Sdk::SetResultsVariable = 10 }
	Supported, typed view commands without exposing private Qt slots. More...

Detailed Description

Versioned validated canvas and attached-results commands for extensions.

Discover on ExtensionHost::lifetime(). GUI-thread commands target a Ready session and its runtime attachment UUID. They use native controllers, return explicit refusal details and suppress no-op writes. Metadata queries remain separate on IViewEvents. Interface layout is frozen for this IID.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License

GPL-3.0-or-later

Macro Definition Documentation

OPENSWMM_VIEW_CONTROLS_IID

#define OPENSWMM_VIEW_CONTROLS_IID   "io.opensimulator.openswmm.IViewControls/1.0"

Frozen discovery identity for validated SDK view commands.