mafw.steering_gui.main_window

Main window orchestrator for the steering GUI layout.

Author:

Bulgheroni Antonio (antonio.bulgheroni@ec.europa.eu)

Description:

Build the menu, splitter, tree, stacked editors, and status bar required by the GUI.

Classes

MainWindow([controller, parent, ...])

Compose the steering GUI main window without executing controller logic.

class mafw.steering_gui.main_window.MainWindow(controller: SteeringController | None = None, parent: QWidget | None = None, *, startup_file: Path | None = None, recent_files: RecentFileService | None = None)

Bases: QMainWindow

Compose the steering GUI main window without executing controller logic.

static _normalize_text(value: str) → str | None

Treat empty or whitespace-only strings as unset.

_confirm_discard() → bool

Ask whether the user wants to save/discard/cancel when the document is dirty.

_confirm_unsaved_changes(action: str) → bool

Ask whether to save, discard, or cancel before replacing the current document.

_create_actions() → None

Declare the main window actions and store them for later menu wiring.

_create_central_widget() → None

Build the splitter containing the tree and editor stack.

_create_group(parent_group: str | None) → str | None

Create a new group and attach it to the requested parent list.

_create_menus() → None

Compose the menu bar using the actions previously created.

_create_status_bar() → None

Initialise the status bar to keep the user informed.

_display_section(section: str) → None

Show the editor that corresponds to the selected tree section.

_drop_filters() → None

Remove filters from the current document and mark it modified.

_exit_app() → None

Close the window after ensuring dirty state obeys the user.

_export_filters(*, strip: bool = False) → None

Export current filters, optionally stripping them after a successful write.

_finalize_connection_test(result: object | None = None) → None

Reset worker references and re-enable the test button.

_generate_group_name() → str

Return a unique group name based on the current builder state.

_import_filters() → None

Overlay a filter file and refresh the existing editors.

_load_file(path: Path) → bool

Confirm replacement, load a steering file, and record it on success.

_load_startup_file() → None

Load a requested startup file after processor plugins are available.

_new_file() → None

Reset the UI state in preparation for a new steering file.

_on_add_group_requested() → None

Create a new top-level group and open it in the editor.

_on_add_processor_requested() → None

Open the Add Processor dialog and append selections to the pipeline.

_on_connection_test_failure(exc: Exception) → None

Report a failure with the provided exception message.

_on_connection_test_success(_: object) → None

Report a successful connection and reset the UI state.

_on_database_configuration_changed(data: dict[str, Any]) → None

Commit every database widget change back to the controller.

_on_dirty_changed(dirty: bool) → None

Update the window title when the controller dirty state changes.

_on_env_files_changed(paths: list[str]) → None

Update the steering path list and refresh its safe validation status.

_on_group_add_group_requested() → None

Create a new group nested within the currently edited group.

_on_group_add_processor_requested() → None

Add processors to the currently edited group.

_on_group_description_changed(description: str) → None

Update the description for the currently edited group.

_on_group_move_requested(direction: str, items: list[PipelineItem]) → None

Reorder items inside the currently edited group.

_on_group_name_changed(new_name: str) → None

Rename the currently edited group.

_on_group_remove_requested(items: list[PipelineItem]) → None

Remove items from the currently edited group.

_on_pipeline_edit_requested(item: PipelineItem) → None

Switch to the appropriate placeholder editor for the selected item.

_on_pipeline_error(exc: Exception) → None

Report pipeline building failures to the user.

_on_pipeline_move_requested(direction: str, items: list[PipelineItem]) → None

Reorder the selected items within the top-level pipeline list.

_on_pipeline_ready(pipeline: ProcessorPipeline) → None

Update the tree and editors with the built pipeline.

_on_pipeline_remove_requested(items: list[PipelineItem]) → None

Remove selected items from the top-level processors_to_run list.

_on_pipeline_selection_changed(items: list[PipelineItem]) → None

Switch editors when a pipeline item is selected in the tree.

_on_plugin_load_failure(exc: Exception) → None

Report plugin loading failures to the user and refresh the UI.

_on_plugins_loaded(_: object) → None

Handle successful plugin loading and refresh the UI.

_on_storage_enabled_changed(enabled: bool) → None

Commit storage section enablement and refresh validation feedback.

_on_storage_volume_added(name: str, configuration: dict[str, Any]) → None

Add a storage volume and refresh dependent editor choices.

_on_storage_volume_changed(name: str, changes: dict[str, Any]) → None

Commit edited storage fields through controller mutation tracking.

_on_storage_volumes_removed(names: list[str]) → None

Remove selected storage volumes as a single UI action.

_on_test_connection_requested(config: dict[str, Any]) → None

Start an asynchronous database connection test and update the UI.

_on_ui_interface_changed(interface: str) → None

Tell the controller to use the selected UI interface.

_on_validation_level_changed(level: ValidationLevel | None) → None

Tell the controller about the user-selected validation level.

_open_file() → None

Stub that requests a filename without yet loading it.

_open_steering_text_editor() → None

Open the manual TOML editor for advanced steering edits.

_perform_save() → bool

Persist the current builder to its tracked path (or prompt Save As).

_perform_save_as() → bool

Prompt the user for a location and persist the current builder there.

_populate_from_model() → None

Refresh the tree and metadata editor from the controller model.

_record_current_file() → None

Promote the current file after a successful save.

_redo() → None

Placeholder redo action until controller wiring occurs.

_refresh_database_editor() → None

Push the controller database metadata into the database editor.

_refresh_globals_editor() → None

Push the controller globals data into the globals editor.

_refresh_metadata_summary() → None

Update the metadata view with configured and available plugin data.

_refresh_open_recent_menu() → None

Rebuild recent-file actions from the reusable history service.

_refresh_pipeline_after_change(select_name: str | None = None) → None

Rebuild the pipeline and refresh dependent widgets.

_refresh_storage_editor() → None

Refresh storage controls and validation messages from the controller.

_refresh_title_from_controller(dirty: bool | None = None) → None

Compose the window title with the associated file and dirty marker.

_refresh_ui_editor() → None

Update the UI combobox once plugin metadata or configuration changes.

_reload_environment() → None

Refresh dotenv values and show only safe path/status information.

_restore_window_geometry() → None

Restore the last-window size and position when available.

_save_file() → None

Action handler that keeps the QAction signature while delegating to DoSave.

_save_file_as() → None

Action handler for Save As that satisfies the QAction signature.

_save_window_geometry() → None

Persist the current geometry before exit.

_set_test_button_enabled(enabled: bool) → None

Toggle the database editor test button when the feature is active.

_show_about() → None

Display the About dialog describing the GUI.

_start_connection_test_worker(task: Callable[[], bool]) → None

Start the worker via a thread pool and bind completion callbacks.

_start_plugin_loading() → None

Trigger the controller to load plugins in the background.

_strip_filters() → None

Export filters and remove them from the current document.

_undo() → None

Placeholder undo action until controller wiring occurs.

_wire_controller_signals() → None

Wire controller dirty notifications and globals signals to the editor.

closeEvent(event: QCloseEvent) → None

Prompt the user to save if the current state is dirty.

mafw.steering_gui.main_window._DEFAULT_SAVE_NAME = 'mysteerfile.toml'

Default suggestion when the user invokes Save As.