Struct egui::containers::window::Window
source · pub struct Window<'open> {
title: WidgetText,
open: Option<&'open mut bool>,
area: Area,
frame: Option<Frame>,
resize: Resize,
scroll: ScrollArea,
collapsible: bool,
default_open: bool,
with_title_bar: bool,
fade_out: bool,
}
Expand description
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, collapsed/expanded
- 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)
egui::Window::new("My Window").show(ctx, |ui| {
ui.label("Hello World!");
});
The previous rectangle used by this window can be obtained through crate::Memory::area_rect()
.
Note that this is NOT a native OS window.
To create a new native OS window, use crate::Context::show_viewport_deferred
.
Fields§
§title: WidgetText
§open: Option<&'open mut bool>
§area: Area
§frame: Option<Frame>
§resize: Resize
§scroll: ScrollArea
§collapsible: bool
§default_open: bool
§with_title_bar: bool
§fade_out: bool
Implementations§
source§impl<'open> Window<'open>
impl<'open> Window<'open>
sourcepub fn new(title: impl Into<WidgetText>) -> Self
pub fn new(title: impl Into<WidgetText>) -> Self
The window title is used as a unique Id
and must be unique, and should not change.
This is true even if you disable the title bar with .title_bar(false)
.
If you need a changing title, you must call window.id(…)
with a fixed id.
sourcepub fn id(self, id: Id) -> Self
pub fn id(self, id: Id) -> Self
Assign a unique id to the Window. Required if the title changes, or is shared with another window.
sourcepub fn open(self, open: &'open mut bool) -> 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 tofalse
.
sourcepub fn enabled(self, enabled: bool) -> Self
pub fn enabled(self, enabled: bool) -> Self
If false
the window will be grayed out and non-interactive.
sourcepub fn interactable(self, interactable: bool) -> Self
pub fn interactable(self, interactable: bool) -> Self
If false, clicks goes straight through to what is behind us.
Can be used for semi-invisible areas that the user should be able to click through.
Default: true
.
sourcepub fn order(self, order: Order) -> Self
pub fn order(self, order: Order) -> Self
order(Order::Foreground)
for a Window that should always be on top
sourcepub fn fade_in(self, fade_in: bool) -> Self
pub fn fade_in(self, fade_in: bool) -> Self
If true
, quickly fade in the Window
when it first appears.
Default: true
.
sourcepub fn fade_out(self, fade_out: bool) -> Self
pub fn fade_out(self, fade_out: bool) -> Self
If true
, quickly fade out the Window
when it closes.
This only works if you use Self::open
to close the window.
Default: true
.
sourcepub fn mutate(self, mutate: impl Fn(&mut Self)) -> Self
pub fn mutate(self, mutate: impl Fn(&mut Self)) -> Self
Usage: Window::new(…).mutate(|w| w.resize = w.resize.auto_expand_width(true))
sourcepub fn resize(self, mutate: impl Fn(Resize) -> Resize) -> Self
pub fn resize(self, mutate: impl Fn(Resize) -> Resize) -> Self
Usage: Window::new(…).resize(|r| r.auto_expand_width(true))
sourcepub fn min_height(self, min_height: f32) -> Self
pub fn min_height(self, min_height: f32) -> Self
Set minimum height of the window.
sourcepub fn min_size(self, min_size: impl Into<Vec2>) -> Self
pub fn min_size(self, min_size: impl Into<Vec2>) -> Self
Set minimum size of the window, equivalent to calling both min_width
and min_height
.
sourcepub fn max_height(self, max_height: f32) -> Self
pub fn max_height(self, max_height: f32) -> Self
Set maximum height of the window.
sourcepub fn max_size(self, max_size: impl Into<Vec2>) -> Self
pub fn max_size(self, max_size: impl Into<Vec2>) -> Self
Set maximum size of the window, equivalent to calling both max_width
and max_height
.
sourcepub fn current_pos(self, current_pos: impl Into<Pos2>) -> Self
pub fn current_pos(self, current_pos: impl Into<Pos2>) -> Self
Set current position of the window. If the window is movable it is up to you to keep track of where it moved to!
sourcepub fn default_pos(self, default_pos: impl Into<Pos2>) -> Self
pub fn default_pos(self, default_pos: impl Into<Pos2>) -> Self
Set initial position of the window.
sourcepub fn fixed_pos(self, pos: impl Into<Pos2>) -> Self
pub fn fixed_pos(self, pos: impl Into<Pos2>) -> Self
Sets the window position and prevents it from being dragged around.
sourcepub fn constrain(self, constrain: bool) -> Self
pub fn constrain(self, constrain: bool) -> Self
Constrains this window to Context::screen_rect
.
To change the area to constrain to, use Self::constrain_to
.
Default: true
.
sourcepub fn constrain_to(self, constrain_rect: Rect) -> Self
pub fn constrain_to(self, constrain_rect: Rect) -> Self
Constrain the movement of the window to the given rectangle.
For instance: .constrain_to(ctx.screen_rect())
.
sourcepub fn pivot(self, pivot: Align2) -> Self
pub fn pivot(self, pivot: Align2) -> Self
Where the “root” of the window is.
For instance, if you set this to Align2::RIGHT_TOP
then Self::fixed_pos
will set the position of the right-top
corner of the window.
Default: Align2::LEFT_TOP
.
sourcepub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Self
pub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Self
Set anchor and distance.
An anchor of Align2::RIGHT_TOP
means “put the right-top corner of the window
in the right-top corner of the screen”.
The offset is added to the position, so e.g. an offset of [-5.0, 5.0]
would move the window left and down from the given anchor.
Anchoring also makes the window immovable.
It is an error to set both an anchor and a position.
sourcepub fn default_open(self, default_open: bool) -> Self
pub fn default_open(self, default_open: bool) -> Self
Set initial collapsed state of the window
sourcepub fn default_size(self, default_size: impl Into<Vec2>) -> Self
pub fn default_size(self, default_size: impl Into<Vec2>) -> Self
Set initial size of the window.
sourcepub fn default_width(self, default_width: f32) -> Self
pub fn default_width(self, default_width: f32) -> Self
Set initial width of the window.
sourcepub fn default_height(self, default_height: f32) -> Self
pub fn default_height(self, default_height: f32) -> Self
Set initial height of the window.
sourcepub fn fixed_size(self, size: impl Into<Vec2>) -> Self
pub fn fixed_size(self, size: impl Into<Vec2>) -> Self
Sets the window size and prevents it from being resized by dragging its edges.
sourcepub fn default_rect(self, rect: Rect) -> Self
pub fn default_rect(self, rect: Rect) -> Self
Set initial position and size of the window.
sourcepub fn fixed_rect(self, rect: Rect) -> Self
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.
sourcepub fn resizable(self, resizable: impl Into<Vec2b>) -> Self
pub fn resizable(self, resizable: impl Into<Vec2b>) -> 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.
You can set the window to only be resizable in one direction by using
e.g. [true, false]
as the argument,
making the window only resizable in the x-direction.
Default is true
.
sourcepub fn collapsible(self, collapsible: bool) -> Self
pub fn collapsible(self, collapsible: bool) -> Self
Can the window be collapsed by clicking on its title?
sourcepub fn title_bar(self, title_bar: bool) -> Self
pub fn title_bar(self, title_bar: bool) -> Self
Show title bar on top of the window?
If false
, the window will not be collapsible nor have a close-button.
sourcepub fn auto_sized(self) -> Self
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.
sourcepub fn scroll(self, scroll: impl Into<Vec2b>) -> Self
pub fn scroll(self, scroll: impl Into<Vec2b>) -> Self
Enable/disable horizontal/vertical scrolling. false
by default.
You can pass in false
, true
, [false, true]
etc.
sourcepub fn scroll2(self, scroll: impl Into<Vec2b>) -> Self
👎Deprecated: Renamed to scroll
pub fn scroll2(self, scroll: impl Into<Vec2b>) -> Self
scroll
Enable/disable horizontal/vertical scrolling. false
by default.
sourcepub fn hscroll(self, hscroll: bool) -> Self
pub fn hscroll(self, hscroll: bool) -> Self
Enable/disable horizontal scrolling. false
by default.
sourcepub fn vscroll(self, vscroll: bool) -> Self
pub fn vscroll(self, vscroll: bool) -> Self
Enable/disable vertical scrolling. false
by default.
sourcepub fn drag_to_scroll(self, drag_to_scroll: bool) -> Self
pub fn drag_to_scroll(self, drag_to_scroll: bool) -> Self
Enable/disable scrolling on the window by dragging with the pointer. true
by default.
See ScrollArea::drag_to_scroll
for more.
source§impl<'open> Window<'open>
impl<'open> Window<'open>
sourcepub fn show<R>(
self,
ctx: &Context,
add_contents: impl FnOnce(&mut Ui) -> R,
) -> Option<InnerResponse<Option<R>>>
pub fn show<R>( self, ctx: &Context, add_contents: impl FnOnce(&mut Ui) -> R, ) -> Option<InnerResponse<Option<R>>>
Returns None
if the window is not open (if Window::open
was called with &mut false
).
Returns Some(InnerResponse { inner: None })
if the window is collapsed.