Struct kas_core::Window

pub struct Window<Data: 'static> { /* private fields */ }

The window widget

This widget is the root of any UI tree used as a window. It manages window decorations.

To change window properties at run-time, send a WindowCommand from a child widget.

Implementations

impl<Data: 'static> Window<Data>

pub fn new(ui: impl Widget<Data = Data> + 'static, title: impl ToString) -> Self

Construct a window with a W: Widget and a title

pub fn new_boxed(ui: Box<dyn Widget<Data = Data>>, title: impl ToString) -> Self

Construct a window from a boxed ui widget and a title

pub fn title(&self) -> &str

Get the window’s title

pub fn with_icon(self, icon: impl Into<Option<Icon>>) -> Self

Set the window’s icon (inline)

Default: None

pub fn decorations(&self) -> Decorations

Get the preference for window decorations

pub fn with_decorations(self, decorations: Decorations) -> Self

Set the preference for window decorations

“Windowing” platforms (i.e. not mobile or web) usually include a title-bar, icons and potentially side borders. These are known as decorations.

This controls the preferred type of decorations. The resulting behaviour is platform-dependent.

Default: Decorations::Server.

pub fn restrictions(&self) -> (bool, bool)

Get window resizing restrictions: (restrict_min, restrict_max)

pub fn with_restrictions(self, restrict_min: bool, restrict_max: bool) -> Self

Whether to limit the maximum size of a window

All widgets’ size rules allow calculation of two sizes: the minimum size and the ideal size. Windows are initially sized to the ideal size.

If restrict_min, the window may not be sized below the minimum size. Default value: true.

If restrict_max, the window may not be sized above the ideal size. Default value: false.

pub fn drag_anywhere(&self) -> bool

Get “drag anywhere” state

pub fn with_drag_anywhere(self, drag_anywhere: bool) -> Self

Whether to allow dragging the window from the background

If true, then any unhandled click+drag in the window may be used to drag the window on supported platforms. Default value: true.

pub fn transparent(&self) -> bool

Get whether this window should use transparent rendering

pub fn with_transparent(self, transparent: bool) -> Self

Whether the window supports transparency

If true, painting with alpha < 1.0 makes the background visible. Additionally, window draw targets are cleared to transparent. This does not stop theme elements from drawing a solid background.

Note: results may vary by platform. Current output does not use pre-multiplied alpha which some platforms expect, thus pixels with partial transparency may have incorrect appearance.

Default: false.

Trait Implementations

impl<Data: 'static> Debug for Window<Data>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Data: 'static> Events for Window<Data>

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn handle_event( &mut self, cx: &mut EventCx<'_>, _: &Self::Data, event: Event ) -> IsUsed

Handle an Event

fn handle_messages(&mut self, cx: &mut EventCx<'_>, _: &Self::Data)

Handler for messages from children/descendants

fn handle_scroll(&mut self, cx: &mut EventCx<'_>, data: &Data, _: Scroll)

Handler for scrolling

fn steal_event( &mut self, _: &mut EventCx<'_>, _: &Self::Data, _: &Id, _: &Event ) -> IsUsed

Potentially steal an event before it reaches a child

fn make_child_id(&mut self, index: usize) -> Id

Make an identifier for a child

fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Configure children

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update children

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn handle_hover(&mut self, cx: &mut EventCx<'_>, state: bool) -> IsUsed

Mouse focus handler

impl<Data: 'static> Layout for Window<Data>

fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, _: Coord) -> Option<Id>

Translate a coordinate to an Id

fn draw(&mut self, _: DrawCx<'_>)

Draw a widget and its children

fn as_layout(&self) -> &dyn Layout

Get as a dyn Layout

fn id_ref(&self) -> &Id

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, index: usize) -> Option<&dyn Layout>

Access a child as a dyn Layout

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn find_child_index(&self, id: &Id) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn translation(&self) -> Offset

Get translation of children relative to this widget

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

type Data = Data

Input data type

fn as_node<'a>(&'a mut self, data: &'a Self::Data) -> Node<'a>

Erase type

fn for_child_node( &mut self, data: &Self::Data, index: usize, closure: Box<dyn FnOnce(Node<'_>) + '_> )

Call closure on child with given index, if index < self.num_children().