Files

craft-window

Decide who draws the window frame — the desktop or the app — so every Craft app shows the same titlebar and borders on a given desktop, and make the app's own top strip act as the title bar when it draws one.

Why

egui apps either keep the desktop's window frame (titlebar, borders, window buttons) or turn it off and draw their own. Across the suite this had drifted:

  • some apps always drew their own frame on Linux (so KDE's titlebar was replaced by the app's),
  • some always kept the desktop's,
  • some probed the compositor and only drew their own on GNOME.

So two Craft apps open side by side on KDE could wear different titlebars. This crate makes the decision in one place, matching each desktop.

The rule

Platform Frame
macOS, Windows desktop (the OS)
Linux/BSD on X11 desktop (the window manager)
Linux/BSD on Wayland with zxdg_decoration_manager_v1 (KDE, Sway, Hyprland, COSMIC) desktop (the compositor)
Linux/BSD on Wayland without it (GNOME's Mutter) the app

When the app draws the frame, the decision carries the window-button Layout the desktop names (GNOME's button-layout), so the app's header bar puts minimize/maximize/close where that desktop puts them. This crate decides whether and where; drawing the buttons stays in each app, whose title bars differ.

Override

<PREFIX>_TITLEBAR forces the choice. With the default prefix CRAFT: CRAFT_TITLEBAR=app forces the app frame, =system (or =desktop) forces the desktop frame. Apps pass their own prefix (Prefix::new("PDFCRAFT") → PDFCRAFT_TITLEBAR) so each keeps its own variable name.

Use

use craft_window::{Choice, Prefix, decorate};

// Once at startup, before the window is created:
let choice = Choice::probe(Prefix::new("PHOTOCRAFT"));
let viewport = decorate(egui::ViewportBuilder::default().with_title("PhotoCraft"), choice.frame());

// If the app draws the frame, lay the header-bar buttons out by the desktop's order:
if let Some(layout) = choice.frame().layout() {
    // layout.left / layout.right -> draw Minimize/Maximize/Close there
}

An app that offers a "System title bar" preference checks choice.overridden() and its own setting, and can override the probe by setting the frame to Frame::Desktop.

The egui feature adds [decorate] and the title_bar module. Without it, the crate is pure decision logic (Choice, Frame, Layout) with no egui dependency.

The app's own title bar

An app that draws over the title bar — a hidden macOS title bar with a full-size content view, or Frame::App — makes its top strip act as one with craft_window::title_bar (egui feature):

Where the drag or double-click starts What happens
The strip's empty part A drag moves the window (ViewportCommand::StartDrag); a double-click follows the system setting (macOS AppleActionOnDoubleClick: zoom, minimize or nothing; zoom elsewhere)
A control on the strip The control gets it; the window stays put
An in-window panel over the strip (an Order::Middle layer: a floating dock, an egui::Window) The panel gets it; the window stays put
A modal's backdrop or a tooltip (Foreground/Tooltip) The window moves, as under AppKit's own title bar
Anything, in full screen Nothing happens to the window
egui::Panel::top("app_bar").show(ui, |ui| {
    // Before the bar's controls, so they sit on top and take their own clicks.
    craft_window::title_bar::empty_area(ui, ui.max_rect());
    // ... the bar's controls ...
});
// macOS, once per frame after the UI: `applied` is app state, starting at `None`.
#[cfg(target_os = "macos")]
craft_window::title_bar::sync_movable(ui.ctx(), &mut self.applied);

On macOS, AppKit moves a full-size-content window from a drag anywhere in the title-bar band, the app's controls and panels included, unless NSWindow.movable is false. sync_movable sets that flag from title_bar::window_movable, which is false while the pointer is on a control or a panel over the strip. It leaves windows with hidden window buttons alone, such as floating panels in their own windows.

Notes

  • The Wayland probe opens a short-lived connection and reads the global registry once, on its own thread with a 500 ms timeout; on failure or timeout it keeps the desktop's frame. Call it once at startup.
  • It never touches the connection winit inherits: when WAYLAND_SOCKET is set (a compositor handed the app an open descriptor), the probe skips connecting and keeps the desktop frame, so it can't consume the socket winit needs.
  • The GNOME button-layout lookup (gsettings) runs behind the same bounded worker, so a stalled gsettings can't block startup either.
  • #![forbid(unsafe_code)], and the never-crash lints the workspace requires.