openswmmvis::ExtensionActivityUi::Data Struct Reference

Private scoped native records and copied metadata for one host lifetime. More...

Collaboration diagram for openswmmvis::ExtensionActivityUi::Data:

Classes
struct	Command
	Registered own/approved QAction state. More...
struct	Dock
	Registered own dock state, including exposure separate from logical openness. More...

Public Member Functions
UiActivityState	snapshot () const
	Copy already captured state into the public scoped shape.
void	publish (ActivityEventKind kind, const QUuid &id)
	Publish one scoped UI invalidation with current copied metadata.
CommandState	read (const Command &record) const
	Read one native action after a semantic Qt signal.
void	removeCommand (const QString &key, const QUuid &expected={})
	Remove one command before emitting its historical registration identity.
void	refreshCommand (const QString &key, const QUuid &expected)
	Diff native action state, including an approved command leaving the catalogue.
void	addCommand (const QString &id, QAction *action, bool builtin)
	Capture a new own/approved QAction registration.
void	syncBuiltins ()
	Reconcile only the native approved dialog catalogue, never foreign extension actions.
DockState	read (const Dock &record) const
	Read native dock state after its property/visibility signal.
void	refreshDock (const QString &id, const QUuid &expected, bool exposure=false, bool exposed=false)
	Diff native dock properties without observing repaints.
void	removeDock (const QString &id, const QUuid &expected={})
	Retire an own dock registration before native destruction.

Public Attributes
ExtensionActivityUi *	context
	Owning QObject connection guard.
QPointer< GuiExtensionHost >	host
	Private per-plugin native host.
QPointer< ExtensionStateRegistry >	registry
	Shared registry, never recreated by queries.
QPointer< QMainWindow >	window
	Runtime window scope.
QPointer< QMdiArea >	mdi
	Native focus controller.
QPointer< ActivityDocuments >	documents
	Shared canonical MDI state.
QUuid	ownerId
	Private host-lifetime identity.
QUuid	windowId
	Shared main-window runtime identity.
QString	pluginId
	Configured extension identity.
std::function< QStringList()>	builtinIds
	Approved native dialog catalogue.
std::function< QAction *(const QString &)>	builtinAction
	Approved action resolver.
std::function< bool(const QString &)>	openBuiltin
	Existing dialog controller.
QHash< QString, Command >	commands
	Own/approved registrations by prefixed local key.
QHash< QString, Dock >	docks
	Own docks by extension-local key.
QList< QMetaObject::Connection >	connections
	Shared native/catalogue connections.
bool	stopped = false
	Teardown suppresses all later native publication.
bool	initializing = true
	Initial backfill refreshes state without synthetic changes.

Detailed Description

Private scoped native records and copied metadata for one host lifetime.

Member Function Documentation

addCommand()

void openswmmvis::ExtensionActivityUi::Data::addCommand ( const QString &  id, QAction *  action, bool  builtin  )

inline

Capture a new own/approved QAction registration.

Parameters

[in]	id	Public local/approved ID.
[in]	action	Borrowed native object.
[in]	builtin	True for an approved existing dialog command.

Here is the call graph for this function:

Here is the caller graph for this function:

publish()

void openswmmvis::ExtensionActivityUi::Data::publish ( ActivityEventKind  kind, const QUuid &  id  )

inline

Publish one scoped UI invalidation with current copied metadata.

Parameters

[in]	kind	Reason.
[in]	id	Runtime target identity, null for no active document.

Here is the call graph for this function:

Here is the caller graph for this function:

read() [1/2]

CommandState openswmmvis::ExtensionActivityUi::Data::read ( const Command &  record ) const

inline

Read one native action after a semantic Qt signal.

Parameters

[in]

record

Current managed registration.

Returns

Owning public metadata retaining its registration UUID.

Here is the caller graph for this function:

read() [2/2]

DockState openswmmvis::ExtensionActivityUi::Data::read ( const Dock &  record ) const

inline

Read native dock state after its property/visibility signal.

Parameters

[in]

record

Managed own registration.

Returns

Current copied state, preserving exposure from its native signal.

refreshCommand()

void openswmmvis::ExtensionActivityUi::Data::refreshCommand ( const QString &  key, const QUuid &  expected  )

inline

Diff native action state, including an approved command leaving the catalogue.

Parameters

[in]	key	Internal registration key.
[in]	expected	Captured registration identity.

Here is the call graph for this function:

Here is the caller graph for this function:

refreshDock()

void openswmmvis::ExtensionActivityUi::Data::refreshDock ( const QString &  id, const QUuid &  expected, bool  exposure = false, bool  exposed = false  )

inline

Diff native dock properties without observing repaints.

Parameters

[in]	id	Own local key.
[in]	expected	Captured runtime identity.
[in]	exposure	Whether a visibility signal supplied an exposure value.
[in]	exposed	New actual native exposure when supplied.

Here is the call graph for this function:

removeCommand()

void openswmmvis::ExtensionActivityUi::Data::removeCommand ( const QString &  key, const QUuid &  expected = {}  )

inline

Remove one command before emitting its historical registration identity.

Parameters

[in]	key	Prefixed internal catalogue key.
[in]	expected	Optional captured runtime identity guarding stale destruction callbacks.

Here is the caller graph for this function:

removeDock()

void openswmmvis::ExtensionActivityUi::Data::removeDock ( const QString &  id, const QUuid &  expected = {}  )

inline

Retire an own dock registration before native destruction.

Parameters

[in]	id	Local key.
[in]	expected	Optional old runtime identity guarding stale callbacks.

snapshot()

UiActivityState openswmmvis::ExtensionActivityUi::Data::snapshot ( ) const

inline

Copy already captured state into the public scoped shape.

Returns

Owning metadata without querying native widget state.

Here is the caller graph for this function:

syncBuiltins()

void openswmmvis::ExtensionActivityUi::Data::syncBuiltins ( )

inline

Reconcile only the native approved dialog catalogue, never foreign extension actions.

Here is the call graph for this function:

Member Data Documentation

builtinAction

std::function<QAction *(const QString &)> openswmmvis::ExtensionActivityUi::Data::builtinAction

Approved action resolver.

builtinIds

std::function<QStringList()> openswmmvis::ExtensionActivityUi::Data::builtinIds

Approved native dialog catalogue.

commands

QHash<QString, Command> openswmmvis::ExtensionActivityUi::Data::commands

Own/approved registrations by prefixed local key.

connections

QList<QMetaObject::Connection> openswmmvis::ExtensionActivityUi::Data::connections

Shared native/catalogue connections.

context

ExtensionActivityUi* openswmmvis::ExtensionActivityUi::Data::context

Owning QObject connection guard.

docks

QHash<QString, Dock> openswmmvis::ExtensionActivityUi::Data::docks

Own docks by extension-local key.

documents

QPointer<ActivityDocuments> openswmmvis::ExtensionActivityUi::Data::documents

Shared canonical MDI state.

host

QPointer<GuiExtensionHost> openswmmvis::ExtensionActivityUi::Data::host

Private per-plugin native host.

initializing

bool openswmmvis::ExtensionActivityUi::Data::initializing = true

Initial backfill refreshes state without synthetic changes.

mdi

QPointer<QMdiArea> openswmmvis::ExtensionActivityUi::Data::mdi

Native focus controller.

openBuiltin

std::function<bool(const QString &)> openswmmvis::ExtensionActivityUi::Data::openBuiltin

Existing dialog controller.

ownerId

QUuid openswmmvis::ExtensionActivityUi::Data::ownerId

Private host-lifetime identity.

pluginId

QString openswmmvis::ExtensionActivityUi::Data::pluginId

Configured extension identity.

registry

QPointer<ExtensionStateRegistry> openswmmvis::ExtensionActivityUi::Data::registry

Shared registry, never recreated by queries.

stopped

bool openswmmvis::ExtensionActivityUi::Data::stopped = false

Teardown suppresses all later native publication.

window

QPointer<QMainWindow> openswmmvis::ExtensionActivityUi::Data::window

Runtime window scope.

windowId

QUuid openswmmvis::ExtensionActivityUi::Data::windowId

Shared main-window runtime identity.

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/src/plugins/extensionactivityui.cpp