Struct WindowBuilder

pub struct WindowBuilder {

    pub widget_builder: WidgetBuilder,
    pub content: Handle<UiNode>,
    pub title: Option<WindowTitle>,
    pub can_close: bool,
    pub can_minimize: bool,
    pub can_maximize: bool,
    pub open: bool,
    pub close_button: Option<Handle<UiNode>>,
    pub minimize_button: Option<Handle<UiNode>>,
    pub maximize_button: Option<Handle<UiNode>>,
    pub modal: bool,
    pub can_resize: bool,
    pub safe_border_size: Option<Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>>,
    pub close_by_esc: bool,
    pub remove_on_close: bool,
}

Window builder creates Window instances and adds them to the user interface.

Fields

widget_builder: WidgetBuilder

Base widget builder.

content: Handle<UiNode>

Content of the window.

title: Option<WindowTitle>

Optional title of the window.

can_close: bool

Whether the window can be closed or not.

can_minimize: bool

Whether the window can be minimized or not.

can_maximize: bool

Whether the window can be maximized or not.

open: bool

Whether the window should be created open or not.

close_button: Option<Handle<UiNode>>

Optional custom closing button, if not specified, then a default button will be created.

minimize_button: Option<Handle<UiNode>>

Optional custom minimization button, if not specified, then a default button will be created.

maximize_button: Option<Handle<UiNode>>

Optional custom maximization button, if not specified, then a default button will be created.

modal: bool

Whether the window should be created as modal or not. Warning: Any dependant builders must take this into account!

can_resize: bool

Whether the window should be resizable or not.

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.

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.

Implementations

impl WindowBuilder

pub fn new(widget_builder: WidgetBuilder) -> WindowBuilder

Creates new window builder.

pub fn with_content(self, content: Handle<UiNode>) -> WindowBuilder

Sets a desired window content.

pub fn with_title(self, title: WindowTitle) -> WindowBuilder

Sets a desired window title.

pub fn with_minimize_button(self, button: Handle<UiNode>) -> WindowBuilder

Sets a desired minimization button.

pub fn with_maximize_button(self, button: Handle<UiNode>) -> WindowBuilder

Sets a desired maximization button.

pub fn with_close_button(self, button: Handle<UiNode>) -> WindowBuilder

Sets a desired closing button.

pub fn can_close(self, can_close: bool) -> WindowBuilder

Sets whether the window can be closed or not.

pub fn can_minimize(self, can_minimize: bool) -> WindowBuilder

Sets whether the window can be minimized or not.

pub fn can_maximize(self, can_minimize: bool) -> WindowBuilder

Sets whether the window can be maximized or not.

pub fn open(self, open: bool) -> WindowBuilder

Sets whether the window should be open or not.

pub fn modal(self, modal: bool) -> WindowBuilder

Sets whether the window should be modal or not.

pub fn can_resize(self, can_resize: bool) -> WindowBuilder

Sets whether the window can be resized or not.

pub fn with_safe_border_size( self, size: Option<Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>>, ) -> WindowBuilder

Sets a desired safe border size.

pub fn with_close_by_esc(self, close: bool) -> WindowBuilder

Defines, whether the window can be closed using Esc key or not. Works only if can_close is also true.

pub fn with_remove_on_close(self, close: bool) -> WindowBuilder

Defines, whether the window should be deleted after closing or not. Default is false.

pub fn build_window(self, ctx: &mut BuildContext<'_>) -> Window

Finishes window building and returns its instance.

pub fn build(self, ctx: &mut BuildContext<'_>) -> Handle<UiNode>

Finishes window building and returns its handle.