Struct egui::containers::Window

pub struct Window<'open> {
    pub title_label: Label,
    pub area: Area,
    pub frame: Option<Frame>,
    pub resize: Resize,
    pub scroll: Option<ScrollArea>,
    pub collapsible: bool,
    // some fields omitted
}

Builder for a floating window which can be dragged, closed, collapsed, resized and scrolled (off by default).

You can customize:

• title
• default, minimum, maximum and/or fixed size
• if the window has a scroll area (off by default)
• if the window can be collapsed (minimized) to just the title bar (yes, by default)
• if there should be a close button (none by default)

Fields

title_label: Label

area: Area

frame: Option<Frame>

resize: Resize

scroll: Option<ScrollArea>

collapsible: bool

Implementations

impl<'open> Window<'open>

pub fn new(title: impl Into<String>) -> Self

pub fn open(self, open: &'open mut bool) -> Self

Call this to add a close-button to the window title bar.

• If *open == false, the window will not be visible.
• If *open == true, the window will have a close button.
• If the close button is pressed, *open will be set to false.

pub fn mutate(self, mutate: impl Fn(&mut Self)) -> Self

Usage: Window::new(...).mutate(|w| w.resize = w.resize.auto_expand_width(true)) Not sure this is a good interface for this.

pub fn resize(self, mutate: impl Fn(Resize) -> Resize) -> Self

Usage: Window::new(...).resize(|r| r.auto_expand_width(true)) Not sure this is a good interface for this.

pub fn frame(self, frame: Frame) -> Self

Usage: Window::new(...).frame(|f| f.fill(Some(BLUE))) Not sure this is a good interface for this.

pub fn min_width(self, min_width: f32) -> Self

Set minimum width of the window.

pub fn min_height(self, min_height: f32) -> Self

Set minimum height of the window.

pub fn default_pos(self, default_pos: impl Into<Pos2>) -> Self

Set initial position of the window.

pub fn default_size(self, default_size: impl Into<Vec2>) -> Self

Set initial size of the window.

pub fn default_width(self, default_width: f32) -> Self

Set initial width of the window.

pub fn default_height(self, default_height: f32) -> Self

Set initial height of the window.

pub fn default_rect(self, rect: Rect) -> Self

Set initial position and size of the window.

pub fn fixed_pos(self, pos: impl Into<Pos2>) -> Self

Sets the window position and prevents it from being dragged around.

pub fn fixed_size(self, size: impl Into<Vec2>) -> Self

Sets the window size and prevents it from being resized by dragging its edges.

pub fn fixed_rect(self, rect: Rect) -> Self

Sets the window pos and size and prevents it from being moved and resized by dragging its edges.

pub fn resizable(self, resizable: bool) -> Self

Can the user resize the window by dragging its edges? Note that even if you set this to false the window may still auto-resize.

pub fn collapsible(self, collapsible: bool) -> Self

Can the window be collapsed by clicking on its title?

pub fn auto_sized(self) -> Self

Not resizable, just takes the size of its contents. Also disabled scrolling. Text will not wrap, but will instead make your window width expand.

pub fn scroll(self, scroll: bool) -> Self

Enable/disable scrolling. false by default.

impl<'open> Window<'open>

pub fn show(
    self,
    ctx: &Arc<Context>,
    add_contents: impl FnOnce(&mut Ui)
) -> Option<Response>