Struct Window 

pub struct Window { /* private fields */ }

A live window: the tree of nodes built from a PanelWindow.

The platform owns one per layer surface. Each event-loop iteration it runs the reactive flush, then calls layout if needs_layout, then draws take_damage from view. When nothing changed, there is nothing to lay out or draw.

Dropping the window disposes its owner, which frees every node, binding and handler in it.

Implementations

impl Window

pub fn pointer_motion(&self, position: Point) -> CursorShape

The pointer entered the window or moved, to position in logical pixels. Returns the cursor to show.

pub fn pointer_leave(&self)

The pointer left the window.

pub fn pointer_button(&self, button: PointerButton, pressed: bool)

A pointer button went down or up. Releasing it over the button it went down on runs that button’s on_click, on_right_click or on_middle_click.

pub fn pointer_scroll(&self, delta: ScrollDelta)

The pointer scrolled. Once whole steps add up, the on_scroll of the button under the pointer runs with them.

pub fn pointer_scroll_end(&self)

A touchpad scroll gesture ended (wl_pointer.axis_stop): scrolling that hasn’t added up to a whole step is dropped, so it doesn’t carry into the next gesture. A wheel’s partial notch is kept.

pub fn cursor(&self) -> CursorShape

The cursor to show.

impl Window

pub fn take_popups(&self) -> Vec<Window>

Takes the popups this window’s widgets opened since the last call.

pub fn anchor(&self) -> Option<Rect>

For a popup, the rectangle of the widget that opened it, at its window’s last layout, in that window’s logical pixels. The platform places the popup next to it. None for a panel, once the widget is gone, or before its first layout.

pub fn is_popup(&self) -> bool

Whether this window is a popup.

pub fn wants_close(&self) -> bool

Whether this popup should close: Cx::close_popup asked, or the widget that opened it is gone. Always false for a panel.

impl Window

pub fn new(cx: &Cx, panel: PanelWindow) -> Window

Builds panel under a new child owner of cx.

Properties set to values take effect now. Bindings are effects, so they first run at the next Runtime::flush; run it before the first layout.

pub fn output(&self) -> Output

The output the window is on.

pub fn surface(&self) -> SurfaceConfig

The layer-surface settings. Read them only after the first Runtime::flush: settings given as closures are bindings, which first run then, and until they do these are the defaults.

pub fn take_surface_changed(&self) -> bool

Whether the settings in surface changed since the last call. The first call returns true, even before the first flush, when surface still holds the defaults.

pub fn size(&self) -> Size

The window’s size in logical pixels: the size the compositor gave a panel, or the size a popup’s content wants, from its last layout.

pub fn set_size(&self, size: Size)

Sets the size the compositor gave the window, from a configure event. A new size needs a layout.

pub fn needs_layout(&self) -> bool

Whether something changed that needs layout.

pub fn layout(&self, text: &mut TextSystem)

Lays the window out at its size, measuring text with text, and records the areas that moved or changed as damage.

pub fn has_damage(&self) -> bool

Whether any area needs repainting.

pub fn take_damage(&self) -> Vec<Rect>

Takes the areas to repaint since the last call, in logical pixels. They may overlap.

pub fn view(&self) -> WindowView<'_>

A read-only view of the laid-out tree, for drawing. Release it before the next flush or pointer event.

Trait Implementations

impl Drop for Window

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.