Struct Window 

pub struct Window<Msg> { /* private fields */ }

A window: a title strip one row tall above a body, with no border lines, for applications that put surfaces where the user drags them, such as a desktop or a tool box. Place it with View::place inside a stack; the body is built with View::add_with.

The title strip shows the icon and the name, then a faint subtitle (a program’s own title, a folder). A window that is focused is one tone raised, its name bright, and the pillar ▌ runs down its whole left edge; others sit one tone lower with a quieter name. On a narrow window the subtitle shortens first, then the name, each with …. The body keeps the pillar column and one cell after it on the left, and the right column and the bottom row free for the handles.

With no options the window is only a surface. on_event makes it one the pointer moves: the three marks near the right end of the title (minimize, maximize or restore, close) light up together under the pointer like every close mark; dragging the title moves the window and double-clicking it maximizes. Every side resizes with a plain drag: the left column, the right column and the bottom row are handles, with their four corners. The top side is the title strip, which moves the window, so only its two end cells are handles, the top left and top right corners; the marks sit left of the right column to leave that corner free. Handles brighten under the pointer and take the accent while dragged, like a splitter’s boundary, and on terminals that can change the pointer’s shape the pointer turns into the matching resize arrow over them (see PaintCx::pointer_shape). Alt with the left button drags the window from anywhere, alt with the right button resizes it from the nearest edge or corner, the top edge too. A drag belongs to the window until the button comes up, which arrives as WindowEvent::Dropped, wherever the pointer goes. The title, the marks, the handles and alt drags are the window’s even when the body holds a Terminal whose program reads the mouse; other presses in the body reach the body. The window reports all of it through WindowEvents and changes nothing itself: stacking order, focus, size limits and snapping are the application’s.

shadow darkens one column right of the window and one row below it. It is not drawn with reduced motion or in 16 colours.

Style keys: window (bg, pillar), window-title (bg, fg, bold), window-subtitle (fg), all with focus for a focused window; close-mark for the marks (active while focused, hover); split-handle for the handles (hover, active while dragged); window-shadow (scrim, strength in percent).

Implementations

impl<Msg: 'static> Window<Msg>

pub fn new(title: impl Into<String>) -> Self

A window named title, unfocused, with an empty body.

pub fn subtitle(self, subtitle: impl Into<String>) -> Self

A faint second title after the name, such as the title a program set or its folder.

pub fn icon(self, glyph: impl Into<Glyph>) -> Self

The glyph before the name: an icon key such as "folder", or a Glyph::literal.

pub fn focused(self, focused: bool) -> Self

Whether this is the window the user works in: raised one tone, bright name and the pillar down its left edge. A press on a window that is not focused sends WindowEvent::Focus.

pub fn maximized(self, maximized: bool) -> Self

Whether the window fills its desktop; the maximize mark then offers to restore it.

pub fn shadow(self, shadow: bool) -> Self

Darkens one column right of the window and one row below it, as if it floated; drawn in the cell a placed child may reach past its rectangle. Not drawn with reduced motion or in 16 colours.

pub fn on_event(self, message: impl Fn(WindowEvent) -> Msg + 'static) -> Self

Makes the window one the pointer moves, resizes and closes, and shows its marks; message turns each WindowEvent into the application’s message.

pub fn on_drag(self, message: impl Fn(WindowDrag) -> Msg + 'static) -> Self

Sends the steps of a move or a resize as WindowDrags, which also carry how far the pointer has gone since the button went down, instead of as WindowEvent::Move and WindowEvent::Resize through on_event. Every other event still goes through on_event, which is also what makes the window one the pointer moves: this does nothing without it.

Trait Implementations

impl<Msg: 'static> Container<Msg> for Window<Msg>

fn set_children(&mut self, children: Vec<Node<Msg>>)

Receives the children built for this widget.

impl<Msg: 'static> Widget<Msg> for Window<Msg>

fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.