API Reference¶

Complete API reference for EzQt App.

Overview¶

EzQt App API is organized by architectural responsibility rather than by widget families.

Quick Reference¶

Component	Description	Documentation
Application Layer	Main app shell and bootstrap entrypoints	Initialization and runtime flow
Config and Runtime	Configuration and mutable runtime state	Config, settings, runtime ports
Translation	Translation manager and auto-translation	Language, TS, providers
UI Services and Widgets	UI orchestration and reusable components	Theme, menus, panels, widgets

Import Examples¶

Primary imports are exposed from the root package:

from ezqt_app import EzApplication, EzQt_App, init

Service-level imports can be done from submodules:

from ezqt_app.services.settings import get_settings_service
from ezqt_app.services.translation import get_translation_service

Modules¶

Module	Scope	Notes
Application Layer	Main window, bootstrap orchestration	Entrypoint and app shell
Config and Runtime	Config/settings/runtime services	Stateful infrastructure
Translation	Translation manager and providers	Local TS + optional API
UI Services and Widgets	UI services and reusable widgets	Presentation and interaction

Core Entry Points¶

ezqt_app.init(...)
ezqt_app.EzApplication
ezqt_app.EzQt_App

API Sections¶

Source Tree¶

Main package: src/ezqt_app/

domain/
services/
widgets/
utils/
cli/

API Design Principles¶

Type Safety¶

Typed domain ports and models in domain/
Service interfaces represented by protocols
Static type checks configured in project tooling

from ezqt_app.domain.ports.config_service import ConfigServiceProtocol
from ezqt_app.services.config.config_service import ConfigService

# ConfigService satisfies ConfigServiceProtocol at the boundary
service: ConfigServiceProtocol = ConfigService()

Layered Boundaries¶

domain/ defines contracts
services/ implement adapters
widgets/ consume services and render UI

# Services are accessed via helper functions, not instantiated directly
from ezqt_app.services.settings import get_settings_service
from ezqt_app.services.translation import get_translation_service

settings = get_settings_service()
translation = get_translation_service()

Translation Behavior¶

Widget registration and string collection are local workflow features
auto_translation_enabled gates external provider calls

from ezqt_app.services.translation import change_language_by_code

# Switch language at runtime
change_language_by_code("fr")

# Control auto-translation per window
window = EzQt_App()
window.enable_auto_translation(False)

Quick Start Example¶

import sys
from ezqt_app import EzApplication, EzQt_App, init

init()
app = EzApplication(sys.argv)
window = EzQt_App()
window.show()
sys.exit(app.exec())

Installation¶

pip install ezqt-app

For development installation:

git clone https://github.com/neuraaak/ezqt-app.git
cd ezqt_app
pip install -e ".[dev]"

Detailed Documentation¶

Select a module from the navigation menu or the table above to view detailed service documentation with:

Complete method signatures
Protocol/port definitions
Initialization flows
Usage examples

Module Documentation¶

Module	Description
Application Layer	Main window, bootstrap orchestration, app shell
Config and Runtime	Config, settings, runtime state services
Translation	Translation manager, providers, string collection
UI Services and Widgets	UI orchestration, theme, menus, panels, core widgets