SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmmvis::ActivityDocuments Class Referencefinal

Canonical window-owned MDI membership tracker, independent of plugin count. More...

Inheritance diagram for openswmmvis::ActivityDocuments:
Collaboration diagram for openswmmvis::ActivityDocuments:

Signals

void changed (OpenSWMM::Sdk::ActivityEventKind kind, const QUuid &id)
 Report a committed native membership/title/active change to scoped hosts.
 

Public Member Functions

 ActivityDocuments (QMainWindow *window, QMdiArea *mdi, ExtensionStateRegistry *registry)
 Track explicit native MDI membership and queued child-list reconciliation.
 
QList< DocumentState > documents () const
 Copy already tracked document metadata in native attachment order.
 
QUuid activeId () const
 Read the current actual document identity.
 
QMdiSubWindow * resolve (const QUuid &id) const
 Resolve a tracked live runtime attachment without creating identities.
 
DocumentState state (const QUuid &id) const
 Read an existing association without touching native widgets.
 
void attach (QMdiSubWindow *sub, const QUuid &session, const QString &owner)
 Annotate a successfully mounted extension document.
 
QUuid origin () const
 Read the synchronous command token without tagging nested modal work.
 
std::pair< QUuid, int > originFrame () const
 Retain the current origin frame for nested command restoration.
 
void setOriginFrame (const std::pair< QUuid, int > &frame)
 Set the explicit synchronous origin frame.
 

Protected Member Functions

bool eventFilter (QObject *object, QEvent *event) override
 Reconcile native utilities after Qt finishes child insertion/removal.
 

Detailed Description

Canonical window-owned MDI membership tracker, independent of plugin count.

Constructor & Destructor Documentation

◆ ActivityDocuments()

openswmmvis::ActivityDocuments::ActivityDocuments ( QMainWindow *  window,
QMdiArea *  mdi,
ExtensionStateRegistry *  registry 
)
inline

Track explicit native MDI membership and queued child-list reconciliation.

Parameters
[in]windowNative QObject owner.
[in]mdiCurrent central MDI area.
[in]registryExisting native session registry, used only for model association.

Member Function Documentation

◆ activeId()

QUuid openswmmvis::ActivityDocuments::activeId ( ) const
inline

Read the current actual document identity.

Returns
Null when MDI has no active document, independently of cached model context.

◆ attach()

void openswmmvis::ActivityDocuments::attach ( QMdiSubWindow *  sub,
const QUuid &  session,
const QString &  owner 
)
inline

Annotate a successfully mounted extension document.

Parameters
[in]subCurrent native member.
[in]sessionExplicit model association, possibly null.
[in]ownerExtension identity owning the view.

◆ changed

void openswmmvis::ActivityDocuments::changed ( OpenSWMM::Sdk::ActivityEventKind  kind,
const QUuid &  id 
)
signal

Report a committed native membership/title/active change to scoped hosts.

Parameters
[in]kindUI invalidation reason.
[in]idCaptured runtime document identity, null for no active document.
Here is the caller graph for this function:

◆ documents()

QList< DocumentState > openswmmvis::ActivityDocuments::documents ( ) const
inline

Copy already tracked document metadata in native attachment order.

Returns
Owning values without touching native document widgets.

◆ eventFilter()

bool openswmmvis::ActivityDocuments::eventFilter ( QObject *  object,
QEvent *  event 
)
inlineoverrideprotected

Reconcile native utilities after Qt finishes child insertion/removal.

Parameters
[in]objectWatched MDI area/viewport.
[in]eventBorrowed native event.
Returns
False, preserving ordinary native dispatch.

◆ origin()

QUuid openswmmvis::ActivityDocuments::origin ( ) const
inline

Read the synchronous command token without tagging nested modal work.

Returns
Token only at the originating event-loop depth.

◆ originFrame()

std::pair< QUuid, int > openswmmvis::ActivityDocuments::originFrame ( ) const
inline

Retain the current origin frame for nested command restoration.

Returns
Stored token and originating event-loop depth.

◆ resolve()

QMdiSubWindow * openswmmvis::ActivityDocuments::resolve ( const QUuid &  id) const
inline

Resolve a tracked live runtime attachment without creating identities.

Parameters
[in]idRuntime document UUID.
Returns
Borrowed MDI member, null after removal/destruction.

◆ setOriginFrame()

void openswmmvis::ActivityDocuments::setOriginFrame ( const std::pair< QUuid, int > &  frame)
inline

Set the explicit synchronous origin frame.

Parameters
[in]frameCaller token and event-loop depth.

◆ state()

DocumentState openswmmvis::ActivityDocuments::state ( const QUuid &  id) const
inline

Read an existing association without touching native widgets.

Parameters
[in]idRuntime document UUID.
Returns
Copied metadata, with null documentId when absent.

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