Struct Window 

pub struct Window<Data>
where
    Data: AppData,
{ /* private fields */ }

The window widget

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

Messages

kas::messages::SetWindowTitle may be used to set the title.

kas::messages::SetWindowIcon may be used to set the icon.

Implementations

impl<Data> Window<Data>

where Data: AppData,

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

Construct a window with a W: Widget and a title

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

Construct a window from a boxed ui widget and a title

pub fn boxed(self) -> BoxedWindow<Data>

Convert into a BoxedWindow

pub fn title(&self) -> &str

Get the window’s title

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

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) -> Window<Data>

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, ) -> Window<Data>

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) -> Window<Data>

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) -> Window<Data>

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.

pub fn escapable(self) -> Window<Data>

Enable closure via Escape key

pub fn with_alt_bypass(self) -> Window<Data>

Enable Alt bypass

Access keys usually require that Alt be held. This method allows access keys to be activated without holding Alt.

pub fn without_nav_focus(self) -> Window<Data>

Disable navigation focus

Usually, widgets may be focussed and this focus may be navigated using the Tab key. This method prevents widgets from gaining focus.

pub fn set_modal_with_parent(&mut self, parent: WindowId)

Set the window as being modal with the given parent

If set, this window is considered modal: it is owned by parent, is not listed on the taskbar, and prevents interaction with parent until it has been closed.

Implementation status: partially implement on Windows only. This feature uses WindowAttributesExtWindows’s with_owner_window and with_skip_taskbar methods where available. Winit currently provides no equivalents for other platforms.

Trait Implementations

impl<Data> Debug for Window<Data>

where Data: AppData,

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

Formats the value using the given formatter.

impl<Data> Events for Window<Data>

where Data: AppData,

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

Configure self

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

Handle an Event

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

Handler for messages from children/descendants

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

Handler for scrolling

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse cursor icon to use on mouse over

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 handle_mouse_over(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

impl<Data> Layout for Window<Data>

where Data: AppData,

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, hints: AlignHints)

Set size and position

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

Draw a widget and its children

fn rect(&self) -> Rect

Get the widget’s region

fn try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

impl<Data> Tile for Window<Data>

where Data: AppData,

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

fn probe(&self, coord: Coord) -> Id

Probe a coordinate for a widget’s Id

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

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

Access a child as a dyn Tile, if available

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

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

Navigation in spatial order

fn id(&self) -> Id

Get the widget’s identifier

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

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

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

fn translation(&self, index: usize) -> Offset

Get translation of child index relative to this widget

impl<Data> Widget for Window<Data>

where Data: AppData,

type Data = Data

Input data type

fn as_node<'__a>( &'__a mut self, data: &'__a <Window<Data> as Widget>::Data, ) -> Node<'__a>

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n <Window<Data> as Widget>::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available