pyqt_reactive.services.window_navigation

Nominal window-navigation capabilities used by pyqt-reactive services.

Classes

CompositeWindowNavigationDriver(drivers)

Combine independent navigation drivers declared by one window.

FieldWindowNavigationDriver(select_field)

Navigate field paths through an explicit field-scrolling callable.

FormFieldWindowNavigationDriver(...)

Field navigation driver that can report async form-build readiness.

FormNavigationManager()

Form manager surface needed for deferred field navigation.

ListItemWindowNavigationDriver(select_item, ...)

Navigate list items through explicit item-selection/readiness callables.

NavigationWaitReason(*values)

NullWindowNavigationDriver()

No-op navigation driver for windows without navigation behavior.

RegisteredWindowNavigationReadiness([...])

Readiness result from a registered window navigation driver.

RegisteredWindowNavigationRequest(window[, ...])

Navigation request after a WindowManager scope resolved to a widget.

WindowNavigationDriver()

Registered navigation behavior for one WindowManager scope.

WindowNavigationRequest(scope_id[, ...])

Typed request to focus a scope window and reveal an item or field.

WindowNavigationResult(request, window, ...)

Outcome of one scope-window navigation request.

class pyqt_reactive.services.window_navigation.WindowNavigationRequest(scope_id: str, object_state: ObjectState | None = None, item_id: str | None = None, field_path: str | None = None, create_if_missing: bool = True, avoid_widgets: tuple[QWidget, ...] = ())[source]

Typed request to focus a scope window and reveal an item or field.

scope_id: str
object_state: ObjectState | None
item_id: str | None
field_path: str | None
create_if_missing: bool
avoid_widgets: tuple[QWidget, ...]
property has_target: bool
__init__(scope_id: str, object_state: ObjectState | None = None, item_id: str | None = None, field_path: str | None = None, create_if_missing: bool = True, avoid_widgets: tuple[QWidget, ...] = ()) None
class pyqt_reactive.services.window_navigation.WindowNavigationResult(request: WindowNavigationRequest, window: QWidget | None, focused: bool, created: bool, window_scope_id: str | None = None)[source]

Outcome of one scope-window navigation request.

request: WindowNavigationRequest
window: QWidget | None
focused: bool
created: bool
window_scope_id: str | None
property navigated: bool
__init__(request: WindowNavigationRequest, window: QWidget | None, focused: bool, created: bool, window_scope_id: str | None = None) None
class pyqt_reactive.services.window_navigation.NavigationWaitReason(*values)[source]
FORM_MANAGER = 'form manager'
ROOT_WIDGETS = 'root widgets'
NESTED_MANAGER = 'nested manager'
FIELD_TARGET = 'field target'
LAYOUT = 'layout'
LIST_ITEMS = 'list items'
class pyqt_reactive.services.window_navigation.RegisteredWindowNavigationRequest(window: QWidget, item_id: str | None = None, field_path: str | None = None)[source]

Navigation request after a WindowManager scope resolved to a widget.

window: QWidget
item_id: str | None
field_path: str | None
property has_target: bool
__init__(window: QWidget, item_id: str | None = None, field_path: str | None = None) None
class pyqt_reactive.services.window_navigation.RegisteredWindowNavigationReadiness(window_alive: bool = True, wait_reason: NavigationWaitReason | None = None)[source]

Readiness result from a registered window navigation driver.

window_alive: bool
wait_reason: NavigationWaitReason | None
property needs_wait: bool
__init__(window_alive: bool = True, wait_reason: NavigationWaitReason | None = None) None
class pyqt_reactive.services.window_navigation.WindowNavigationDriver[source]

Registered navigation behavior for one WindowManager scope.

readiness(request: RegisteredWindowNavigationRequest) RegisteredWindowNavigationReadiness[source]
build_complete_callbacks() tuple[list[Callable[[], None]], ...][source]
execute(request: RegisteredWindowNavigationRequest) None[source]
class pyqt_reactive.services.window_navigation.NullWindowNavigationDriver[source]

No-op navigation driver for windows without navigation behavior.

class pyqt_reactive.services.window_navigation.CompositeWindowNavigationDriver(drivers: tuple[WindowNavigationDriver, ...])[source]

Combine independent navigation drivers declared by one window.

__init__(drivers: tuple[WindowNavigationDriver, ...]) None[source]
readiness(request: RegisteredWindowNavigationRequest) RegisteredWindowNavigationReadiness[source]
build_complete_callbacks() tuple[list[Callable[[], None]], ...][source]
execute(request: RegisteredWindowNavigationRequest) None[source]
class pyqt_reactive.services.window_navigation.FieldWindowNavigationDriver(select_field: Callable[[str], None])[source]

Navigate field paths through an explicit field-scrolling callable.

__init__(select_field: Callable[[str], None]) None[source]
execute(request: RegisteredWindowNavigationRequest) None[source]
class pyqt_reactive.services.window_navigation.FormFieldWindowNavigationDriver(select_field: Callable[[str], None], form_manager: Callable[[], FormNavigationManager | None])[source]

Field navigation driver that can report async form-build readiness.

__init__(select_field: Callable[[str], None], form_manager: Callable[[], FormNavigationManager | None]) None[source]
readiness(request: RegisteredWindowNavigationRequest) RegisteredWindowNavigationReadiness[source]
build_complete_callbacks() tuple[list[Callable[[], None]], ...][source]
class pyqt_reactive.services.window_navigation.ListItemWindowNavigationDriver(select_item: Callable[[str], None], has_navigation_items: Callable[[], bool])[source]

Navigate list items through explicit item-selection/readiness callables.

__init__(select_item: Callable[[str], None], has_navigation_items: Callable[[], bool]) None[source]
readiness(request: RegisteredWindowNavigationRequest) RegisteredWindowNavigationReadiness[source]
execute(request: RegisteredWindowNavigationRequest) None[source]
class pyqt_reactive.services.window_navigation.FormNavigationManager[source]

Form manager surface needed for deferred field navigation.

widgets: dict
nested_managers: dict