Files
ltk/examples/dialog.rs
Pedro M. de Echanove Pasquin ccf07de593
Some checks failed
CI / build + test (push) Has been cancelled
CI / cargo audit (push) Has been cancelled
Session management: xdg-session-management-v1 client, mandatory App::app_id / save_state / restore_state, runtime-managed state persistence and clean exit on signals (0.3.0)
Applications built on ltk had no way to come back where the user left them: the toolkit hardcoded `app_id = "ltk"` on every toplevel, never wrote anything to disk, and died on SIGTERM without a chance to save. This release gives the runtime the whole plumbing and asks each application only for the bytes worth keeping, in the spirit of Android's saved-instance state.
The `App` trait gains three mandatory methods, deliberately without default bodies so every application states its position: `app_id()` (reverse-DNS, used for `xdg_toplevel.set_app_id`, the AccessKit application name and the state directory — the `app_id` element of the deprecated `window_config` tuple is now ignored and a one-time warning reports a mismatch), `save_state() -> Option<Vec<u8>>` and `restore_state(Vec<u8>)`. The bytes are opaque; the trait carries no serde bound. Their rustdoc is the contract: when the runtime saves, where the files live, when the bytes come back and when they do not, what must never go in them, and a worked serde_json example.
The runtime persists under `$XDG_STATE_HOME/<app_id>/` (falling back to `~/.local/state`): `session.json` holds the compositor session id, a clean-exit marker and the writer's pid; `state.bin` holds the application bytes. Writes are atomic (temp file + rename, mode 0600, directory 0700) and best-effort. State is saved every 30 s when the bytes changed, once after the event loop exits (which covers `on_close_requested`, `requested_exit` and lost connections), and on SIGTERM/SIGINT — a calloop signal source, installed before any thread exists, now turns those into a clean exit of the loop instead of process death. `restore_state` runs synchronously in `try_run` before the window is created and before the first `view()`, and only when the process is relaunched as part of a session restore (`LTK_SESSION_RESTORE=1`, removed from the environment before the app can spawn children) or when the previous run left `clean_exit: false`; a plain launch starts fresh. A second concurrent instance detects the live pid and runs with persistence disabled rather than clobbering the first.
The compositor side of geometry restore goes through `xdg-session-management-v1`. Neither wayland-protocols nor sctk ship generated code for it yet, so the XML is vendored under `protocols/` and `wayland-scanner` generates the client module in-tree (`src/protocol/`), resolving the crate names through sctk's reexports so the bindings stay on the crate instances sctk links. Before the first commit of a `ShellMode::Window` toplevel the runtime binds `xdg_session_manager_v1`, calls `get_session(reason, stored_id)` and `restore_toplevel(toplevel, "main")`; the three window-creation paths in `run.rs` are folded into one `make_window` helper so the attach always sits immediately before `commit()`. `created` persists the id, `replaced` destroys the objects and stops persisting. Compositors without the global lose only the geometry half. Layer-shell and session-lock surfaces skip the whole machinery.
Every `App` implementor in the tree is updated: the twelve examples (`showcase`, `scroll` and `mini_shell` persist real state; the rest return `None`), both integration tests (`event_loop_flow` gains `save_restore_round_trip`), the in-source and markdown doctests, README, onboarding, cookbook (new recipe "Surviving relaunch: session state") and architecture docs, and the changelog. `src/session_state.rs` carries unit tests over a temporary state directory. `Makefile install` now copies `protocols/` into the cargo registry — without it downstream builds would fail inside the proc-macro — and `debian/copyright` covers the vendored XML.
The trait change is breaking, hence 0.3.0. Also fixes the pre-existing `viewport_tests` module in `render/mod.rs`, which used `Length` without importing it and broke `cargo test`.
2026-08-15 10:16:30 +02:00

249 lines
6.3 KiB
Rust

//! Example for the `dialog` widget.
//!
//! Demonstrates the three shapes the widget covers:
//!
//! * **Modal confirm** — title + subtitle + "Cancel" / "Delete"
//! actions. Backed by `cancel( Msg::Cancel )` so pressing `Esc`
//! matches tapping the Cancel button. Pointer events outside the
//! card are silently absorbed.
//! * **Non-modal pick** — `modal( false ) + dismiss_on_scrim( … )`. A
//! tap on the scrim outside the card emits the dismiss message; ESC
//! still fires `cancel`.
//! * **Custom body** — a body element (here, a slider) injected
//! between the subtitle and the action row.
use ltk::{
App, ButtonVariant, Element, Keysym,
button, column, dialog, slider, spacer, stack, text,
};
#[ derive( Clone, Copy, PartialEq, Eq ) ]
enum Open
{
None,
Modal,
NonModal,
CustomBody,
}
#[ derive( Clone ) ]
enum Msg
{
Open( Open ),
Close,
Confirm,
PickAlpha,
PickBeta,
PickGamma,
BrightnessChanged( f32 ),
}
struct DialogApp
{
open: Open,
last_event: String,
brightness: f32,
}
impl DialogApp
{
fn new() -> Self
{
Self
{
open: Open::None,
last_event: "(no dialog interactions yet)".to_string(),
brightness: 0.5,
}
}
}
impl App for DialogApp
{
type Message = Msg;
fn app_id( &self ) -> &str { "net.liberux.ltk.example.dialog" }
fn save_state( &self ) -> Option<Vec<u8>> { None }
fn restore_state( &mut self, _state: Vec<u8> ) {}
fn view( &self ) -> Element<Msg>
{
let palette = ltk::theme_palette();
let primary = palette.text_primary;
let secondary = palette.text_secondary;
let header = column::<Msg>()
.spacing( 8.0 )
.push( text( "ltk · dialog widget" ).size( 24.0 ).color( primary ) )
.push( text( "Open one of the dialogs below. ESC always fires the dialog's `cancel` message." )
.size( 14.0 )
.color( secondary )
.wrap( true ) );
// Stacked, not a row: a centered row overflows both edges as
// soon as the fluid button sizes outgrow the window, while a
// column clamps each button to the available width.
let openers = column::<Msg>()
.padding( 0.0 )
.spacing( 12.0 )
.push(
button::<Msg>( "Modal confirm" )
.variant( ButtonVariant::Primary )
.on_press( Msg::Open( Open::Modal ) ),
)
.push(
button::<Msg>( "Non-modal pick" )
.variant( ButtonVariant::Secondary )
.on_press( Msg::Open( Open::NonModal ) ),
)
.push(
button::<Msg>( "Custom body" )
.variant( ButtonVariant::Tertiary )
.on_press( Msg::Open( Open::CustomBody ) ),
);
let event_label = text( format!( "Last event: {}", self.last_event ) )
.size( 13.0 )
.color( secondary )
.wrap( true );
let main = column::<Msg>()
.spacing( 24.0 )
.padding( 32.0 )
.push( header )
.push( openers )
.push( spacer() )
.push( event_label );
// Build the active dialog (if any) and stack it on top of the
// main column. Stack draws children in order, so the dialog
// always sits over the main UI.
let overlay: Option<Element<Msg>> = match self.open
{
Open::None => None,
Open::Modal => Some( modal_confirm() ),
Open::NonModal => Some( non_modal_pick() ),
Open::CustomBody => Some( custom_body_dialog( self.brightness ) ),
};
match overlay
{
Some( o ) =>
{
stack::<Msg>()
.push( main )
.push( o )
.into()
}
None => main.into(),
}
}
fn update( &mut self, msg: Msg )
{
match msg
{
Msg::Open( o ) => { self.open = o; self.last_event = "opened".into(); }
Msg::Close => { self.open = Open::None; self.last_event = "cancelled (button or ESC or scrim)".into(); }
Msg::Confirm => { self.open = Open::None; self.last_event = "confirmed".into(); }
Msg::PickAlpha => { self.open = Open::None; self.last_event = "picked Alpha".into(); }
Msg::PickBeta => { self.open = Open::None; self.last_event = "picked Beta".into(); }
Msg::PickGamma => { self.open = Open::None; self.last_event = "picked Gamma".into(); }
Msg::BrightnessChanged( v ) => { self.brightness = v; }
}
}
// Only reached when no dialog is open: with one on screen, the ESC
// dispatch chain fires the scrim's `on_escape` (the dialog's cancel)
// before the app ever sees the key. First ESC closes, second quits.
fn on_key( &mut self, keysym: Keysym ) -> Option<Msg>
{
if keysym == Keysym::Escape { std::process::exit( 0 ); }
None
}
}
fn modal_confirm() -> Element<Msg>
{
dialog::<Msg>()
.title( "Delete partition?" )
.subtitle( "This will permanently erase every file in /dev/sda2 and cannot be undone. Make sure you have a backup before continuing." )
.cancel( Msg::Close )
.action(
button::<Msg>( "Cancel" )
.variant( ButtonVariant::Tertiary )
.on_press( Msg::Close ),
)
.action(
button::<Msg>( "Delete" )
.variant( ButtonVariant::Primary )
.on_press( Msg::Confirm ),
)
.into()
}
fn non_modal_pick() -> Element<Msg>
{
dialog::<Msg>()
.modal( false )
.title( "Pick a flavour" )
.subtitle( "Tap the dim background or press ESC to cancel." )
.cancel( Msg::Close )
.dismiss_on_scrim( Msg::Close )
.action(
button::<Msg>( "Alpha" )
.variant( ButtonVariant::Tertiary )
.on_press( Msg::PickAlpha ),
)
.action(
button::<Msg>( "Beta" )
.variant( ButtonVariant::Tertiary )
.on_press( Msg::PickBeta ),
)
.action(
button::<Msg>( "Gamma" )
.variant( ButtonVariant::Primary )
.on_press( Msg::PickGamma ),
)
.into()
}
fn custom_body_dialog( brightness: f32 ) -> Element<Msg>
{
let palette = ltk::theme_palette();
let secondary = palette.text_secondary;
let body = column::<Msg>()
.spacing( 8.0 )
.push( text( format!( "Brightness: {:>3.0} %", brightness * 100.0 ) )
.size( 14.0 )
.color( secondary ) )
.push(
slider::<Msg>( brightness )
.on_change( |v| Msg::BrightnessChanged( v ) )
.accent_thumb( true ),
);
dialog::<Msg>()
.title( "Display brightness" )
.subtitle( "Drag the slider, then accept or cancel." )
.cancel( Msg::Close )
.body( body )
.action(
button::<Msg>( "Cancel" )
.variant( ButtonVariant::Tertiary )
.on_press( Msg::Close ),
)
.action(
button::<Msg>( "Accept" )
.variant( ButtonVariant::Primary )
.on_press( Msg::Confirm ),
)
.into()
}
fn main()
{
ltk::run( DialogApp::new() );
}