openswmmvis::platform Namespace Reference

Functions
void	attachAsChildWindow (QWidget *dialog)
	Attach dialog as an NSWindow child window of the nearest non-dialog top-level window above it (the main / project window).
void	detachFromParentWindow (QWidget *dialog)
	Detach dialog from its parent NSWindow (inverse of attachAsChildWindow).
void	beginSimulationActivity ()
	Hold a user-initiated NSProcessInfo activity while a simulation runs, so App Nap does not throttle a backgrounded run (a run the user Cmd-Tabbed away from could take far longer than the same deck in a terminal). Reference counted: nested begin/end pairs from overlapping runs hold one activity. Idle system sleep stays allowed. Only defined on macOS — callers must guard with Q_OS_MACOS.
void	endSimulationActivity ()
	Release the activity taken by beginSimulationActivity(); ends it when the last overlapping run finishes. Extra calls are ignored.

Function Documentation

attachAsChildWindow()

void openswmmvis::platform::attachAsChildWindow

(

QWidget *

dialog

)

Attach dialog as an NSWindow child window of the nearest non-dialog top-level window above it (the main / project window).

A child window stays ordered above its parent (so a click on the main window can't bury the dialog) but keeps its own normal window level — so when SWMMVis is deactivated the dialog drops behind the other application's windows instead of floating over them, and it stays visible rather than hiding. This is the macOS-native equivalent of the always-on-top hint, scoped to the application's own windows.

Note

The host is deliberately NOT dialog->parentWidget()->window(). AppKit child windows move rigidly with their parent, so attaching a dialog to another dialog glues the pair together (dragging a profile plot dragged its time-series overlay with it). Dialogs are Qt-parented to other dialogs on purpose — for lifetime coupling — so the walk skips over any dialog in the parent chain and attaches to the first ordinary window. When the chain holds nothing but dialogs, nothing is attached.

Idempotent (safe to call again on re-show). No-op when dialog is not a window, has no non-dialog top-level ancestor, or the native windows aren't realised yet. Only defined on macOS — callers must guard with Q_OS_MACOS.

Here is the caller graph for this function:

beginSimulationActivity()

void openswmmvis::platform::beginSimulationActivity

(

)

Hold a user-initiated NSProcessInfo activity while a simulation runs, so App Nap does not throttle a backgrounded run (a run the user Cmd-Tabbed away from could take far longer than the same deck in a terminal). Reference counted: nested begin/end pairs from overlapping runs hold one activity. Idle system sleep stays allowed. Only defined on macOS — callers must guard with Q_OS_MACOS.

detachFromParentWindow()

void openswmmvis::platform::detachFromParentWindow

(

QWidget *

dialog

)

Detach dialog from its parent NSWindow (inverse of attachAsChildWindow).

AppKit requires a child window to be removed from its parent before it is ordered out or closed — Qt's cocoa backend knows nothing about the attachment and calls orderOut:/close directly, which leaves the parent window with a stale child registration (phantom click-eating regions, broken key-window routing). Call this when the dialog is about to hide or close. If the dialog is already hidden (detach arrived after Qt's orderOut:), the window is ordered out again after detaching so it can't linger on screen glued to the parent.

Idempotent. No-op when dialog is not a window, has no realised native window, or is not currently attached. Only defined on macOS — callers must guard the call with Q_OS_MACOS.

Here is the caller graph for this function:

endSimulationActivity()

void openswmmvis::platform::endSimulationActivity

(

)

Release the activity taken by beginSimulationActivity(); ends it when the last overlapping run finishes. Extra calls are ignored.