Struct Window 

pub struct Window<'a> { /* private fields */ }

Builder for a floating window. Same API as egui::Window.

The only behavior change: Self::title_frame fill is honored even when this window is the top layer. Stock egui replaces that fill from widgets.open.

let frame = egui::Frame::window(&ctx.global_style());
Window::new("Demo")
    .frame(frame)
    .title_frame(frame.stroke(egui::Stroke::NONE))
    .show(ctx, |ui| {
        ui.label("hello");
    });

Implementations

impl<'a> Window<'a>

pub fn new(title: impl IntoAtoms<'a>) -> Self

The window title is used as a unique Id and must be unique, and should not change. See egui::Window::new.

pub fn from_viewport(id: ViewportId, viewport: ViewportBuilder) -> Self

Construct a Window that follows the given viewport.

pub fn id(self, id: Id) -> Self

Assign a unique id. Required if the title changes or is shared.

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

Add a close button. See egui::Window::open.

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

If false the window is grayed out and non-interactive.

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

If false, clicks go through to what is behind us. Default: true.

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

If false the window cannot be moved by dragging.

pub fn drag_area(self, drag_area: WindowDrag) -> Self

Where the user can grab the window to move it.

pub fn order(self, order: Order) -> Self

order(Order::Foreground) for a window that should always be on top.

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

Fade in when the window first appears. Default: true.

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

Fade out when the window closes via Self::open. Default: true.

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

Mutate the builder in place.

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

Mutate the inner Resize.

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

Change the background color, margins, etc. of the window body.

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

Change the background color, margins, etc. of the title bar.

Unlike egui::Window::title_frame, this fill is kept even when the window is the top layer.

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 min_size(self, min_size: impl Into<Vec2>) -> Self

Set minimum outer size of the window.

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

Set maximum width of the window.

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

Set maximum height of the window.

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

Set maximum outer size of the window.

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

Set current position of the window.

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

Set initial position of the window.

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

Sets the window position and prevents it from being dragged.

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

Constrains this window to Context::content_rect. Default: true.

pub fn constrain_to(self, constrain_rect: Rect) -> Self

Constrain movement of the window to the given rectangle.

pub fn pivot(self, pivot: Align2) -> Self

Where the “root” of the window is. Default: Align2::LEFT_TOP.

pub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Self

Set anchor and distance. Also makes the window immovable.

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

Set initial collapsed state of the window.

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

Set initial outer 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 fixed_size(self, size: impl Into<Vec2>) -> Self

Sets the window size and prevents resizing by dragging edges.

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

Set initial position and size of the window.

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

Sets pos and size and prevents moving and resizing by dragging.

pub fn resizable(self, resizable: impl Into<Vec2b>) -> Self

Can the user resize the window by dragging its edges? Default: true.

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

Can the window be collapsed by clicking on its title?

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

Show a title bar? If false, the window is not collapsible and has no close button.

pub fn auto_sized(self) -> Self

Not resizable, just takes the size of its contents. Also disables scrolling.

pub fn scroll(self, scroll: impl Into<Vec2b>) -> Self

Enable/disable horizontal/vertical scrolling. false by default.

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

Enable/disable horizontal scrolling. false by default.

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

Enable/disable vertical scrolling. false by default.

pub fn drag_to_scroll(self, drag_to_scroll: DragScroll) -> Self

Scroll by dragging the contents with the pointer.

pub fn scroll_bar_visibility(self, visibility: ScrollBarVisibility) -> Self

Sets the ScrollBarVisibility of the window.

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

Show the window.

Returns None if the window is not open (if Self::open was called with &mut false). Returns Some(InnerResponse { inner: None }) if the window is collapsed.