Struct Window

Source

pub struct Window {Show 23 fields
    pub widget: Widget,
    pub mouse_click_pos: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
    pub initial_position: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
    pub initial_size: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
    pub is_dragging: bool,
    pub minimized: bool,
    pub can_minimize: bool,
    pub can_maximize: bool,
    pub can_close: bool,
    pub can_resize: bool,
    pub header: Handle<UiNode>,
    pub minimize_button: Handle<UiNode>,
    pub maximize_button: Handle<UiNode>,
    pub close_button: Handle<UiNode>,
    pub drag_delta: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
    pub content: Handle<UiNode>,
    pub grips: RefCell<[Grip; 8]>,
    pub title: Handle<UiNode>,
    pub title_grid: Handle<UiNode>,
    pub safe_border_size: Option<Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>>,
    pub prev_bounds: Option<Rect<f32>>,
    pub close_by_esc: bool,
    pub remove_on_close: bool,
}

Expand description

The Window widget provides a standard window that can contain another widget. Based on setting windows can be configured so users can do any of the following:

Movable by the user. Not configurable.
Have title text on the title bar. Set by the with_title function.
Able to be exited by the user. Set by the can_close function.
Able to be minimized to just the Title bar, and of course maximized again. Set by the can_minimize function.
Able to resize the window. Set by the can_resize function.

As with other UI elements, you create and configure the window using the WindowBuilder.

fn create_window(ui: &mut UserInterface) {
    WindowBuilder::new(
        WidgetBuilder::new()
            .with_desired_position(Vector2::new(300.0, 0.0))
            .with_width(300.0),
    )
    .with_content(
        TextBuilder::new(WidgetBuilder::new())
            .with_text("Example Window content.")
            .build(&mut ui.build_ctx())
    )
    .with_title(WindowTitle::text("Window"))
    .can_close(true)
    .can_minimize(true)
    .open(true)
    .can_resize(false)
    .build(&mut ui.build_ctx());
}

You will likely want to constrain the initial size of the window to something as shown in the example by providing a set width and/or height to the base WidgetBuilder. Otherwise it will expand to fit it’s content.

You may also want to set an initial position with the with_desired_position function called on the base WidgetBuilder which sets the position of the window’s top-left corner. Otherwise all your windows will start with it’s top-left corner at 0,0 and be stacked on top of each other.

Windows can only contain a single direct child widget, set by using the with_content function. Additional calls to with_content replaces the widgets given in previous calls, and the old widgets exist outside the window, so you should delete old widgets before changing a window’s widget. If you want multiple widgets, you need to use one of the layout container widgets like the Grid, Stack Panel, etc then add the additional widgets to that widget as needed.

The Window is a user editable object, but can only be affected by UI Messages they trigger if the message’s corresponding variable has been set to true aka what is set by the can_close, can_minimize, and can_resize functions.

§Initial Open State

By default, the window will be created in the open, or maximized, state. You can manually set this state via the open function providing a true or false as desired.

§Styling the Buttons

The window close and minimise buttons can be configured with the with_close_button and with_minimize_button functions. You will want to pass them a button widget, but can do anything else you like past that.

A Modal in UI design terms indicates a window or box that has forced focus. The user is not able to interact with anything else until the modal is dismissed.

Any window can be set and unset as a modal via the modal function.

Fields§

§widget: Widget

Base widget of the window.

§mouse_click_pos: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

Mouse click position.

§initial_position: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

Initial mouse position.

§initial_size: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

Initial size of the window.

§is_dragging: bool

Whether the window is being dragged or not.

§minimized: bool

Whether the window is minimized or not.

§can_minimize: bool

Whether the window can be minimized or not.

§can_maximize: bool

Whether the window can be maximized or not.

§can_close: bool

Whether the window can be closed or not.

§can_resize: bool

Whether the window can be resized or not.

§header: Handle<UiNode>

Handle of a header widget.

§minimize_button: Handle<UiNode>

Handle of a minimize button.

§maximize_button: Handle<UiNode>

Handle of a maximize button.

§close_button: Handle<UiNode>

Handle of a close button.

§drag_delta: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

A distance per each axis when the dragging starts.

§content: Handle<UiNode>

Handle of a current content.

§grips: RefCell<[Grip; 8]>

Eight grips of the window that are used to resize the window.

§title: Handle<UiNode>

Handle of a title widget of the window.

§title_grid: Handle<UiNode>

Handle of a container widget of the title.

§safe_border_size: Option<Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>>

Optional size of the border around the screen in which the window will be forced to stay.

§prev_bounds: Option<Rect<f32>>

Bounds of the window before maximization, it is used to return the window to previous size when it is either “unmaximized” or dragged.

§close_by_esc: bool

If true, then the window can be closed using Esc key. Default is true. Works only if can_close is also true.

§remove_on_close: bool

If true, then the window will be deleted after closing.

Struct WindowCopy item path

§Initial Open State

§Styling the Buttons

§Modal (AKA Forced Focus)

Fields§

Implementations§

impl Window

pub const WIDGET: &'static str = "widget"

pub const MOUSE_CLICK_POS: &'static str = "mouse_click_pos"

pub const INITIAL_POSITION: &'static str = "initial_position"

pub const INITIAL_SIZE: &'static str = "initial_size"

pub const IS_DRAGGING: &'static str = "is_dragging"

pub const MINIMIZED: &'static str = "minimized"

pub const CAN_MINIMIZE: &'static str = "can_minimize"

pub const CAN_MAXIMIZE: &'static str = "can_maximize"

pub const CAN_CLOSE: &'static str = "can_close"

pub const CAN_RESIZE: &'static str = "can_resize"

pub const HEADER: &'static str = "header"

pub const MINIMIZE_BUTTON: &'static str = "minimize_button"

pub const MAXIMIZE_BUTTON: &'static str = "maximize_button"

pub const CLOSE_BUTTON: &'static str = "close_button"

pub const DRAG_DELTA: &'static str = "drag_delta"

pub const CONTENT: &'static str = "content"

pub const GRIPS: &'static str = "grips"

pub const TITLE: &'static str = "title"

pub const TITLE_GRID: &'static str = "title_grid"

pub const SAFE_BORDER_SIZE: &'static str = "safe_border_size"

pub const PREV_BOUNDS: &'static str = "prev_bounds"

pub const CLOSE_BY_ESC: &'static str = "close_by_esc"

pub const REMOVE_ON_CLOSE: &'static str = "remove_on_close"

impl Window

pub fn has_active_grip(&self) -> bool

Methods from Deref<Target = Widget>§

pub const NAME: &'static str = "name"

pub const DESIRED_LOCAL_POSITION: &'static str = "desired_local_position"

pub const WIDTH: &'static str = "width"

pub const HEIGHT: &'static str = "height"

pub const MIN_SIZE: &'static str = "min_size"

pub const MAX_SIZE: &'static str = "max_size"

pub const BACKGROUND: &'static str = "background"

pub const FOREGROUND: &'static str = "foreground"

pub const ROW: &'static str = "row"

pub const COLUMN: &'static str = "column"

pub const VERTICAL_ALIGNMENT: &'static str = "vertical_alignment"

pub const HORIZONTAL_ALIGNMENT: &'static str = "horizontal_alignment"

pub const MARGIN: &'static str = "margin"

pub const VISIBILITY: &'static str = "visibility"

pub const HIT_TEST_VISIBILITY: &'static str = "hit_test_visibility"

pub const Z_INDEX: &'static str = "z_index"

pub const ALLOW_DRAG: &'static str = "allow_drag"

pub const ALLOW_DROP: &'static str = "allow_drop"

pub const DRAW_ON_TOP: &'static str = "draw_on_top"

pub const ENABLED: &'static str = "enabled"

pub const CURSOR: &'static str = "cursor"

pub const OPACITY: &'static str = "opacity"

pub const TOOLTIP: &'static str = "tooltip"

pub const TOOLTIP_TIME: &'static str = "tooltip_time"

pub const CONTEXT_MENU: &'static str = "context_menu"

pub const CLIP_TO_BOUNDS: &'static str = "clip_to_bounds"

pub const PREVIEW_MESSAGES: &'static str = "preview_messages"

pub const HANDLE_OS_EVENTS: &'static str = "handle_os_events"

pub const TAB_INDEX: &'static str = "tab_index"

pub const TAB_STOP: &'static str = "tab_stop"

pub const NEED_UPDATE: &'static str = "need_update"

pub const IGNORE_LAYOUT_ROUNDING: &'static str = "ignore_layout_rounding"

pub const ACCEPTS_INPUT: &'static str = "accepts_input"

pub const ID: &'static str = "id"

pub const RESOURCE: &'static str = "resource"

pub fn handle(&self) -> Handle<UiNode>

pub fn name(&self) -> &str

pub fn set_name<P>(&mut self, name: P) -> &mut Widgetwhere P: AsRef<str>,

pub fn actual_local_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn actual_initial_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn actual_global_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn set_min_size( &mut self, value: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> &mut Widget

pub fn set_min_width(&mut self, value: f32) -> &mut Widget

pub fn set_min_height(&mut self, value: f32) -> &mut Widget

pub fn min_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn min_width(&self) -> f32

pub fn min_height(&self) -> f32

Struct Window

pub fn set_name<P>(&mut self, name: P) -> &mut Widget
where P: AsRef<str>,

pub fn find_by_criteria_up<Func>( &self, ui: &UserInterface, func: Func, ) -> Handle<UiNode>
where Func: Fn(&UiNode) -> bool,