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,
}
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

Implementations§

source§

impl<'open> Window<'open>

source

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.

source

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.

source

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.
source

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

If false the window will be grayed out and non-interactive.

source

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

If false the window will be non-interactive.

source

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

If false the window will be immovable.

source

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

Usage: Window::new(…).mutate(|w| w.resize = w.resize.auto_expand_width(true))

source

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

Usage: Window::new(…).resize(|r| r.auto_expand_width(true))

source

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

Change the background color, margins, etc.

source

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

Set minimum width of the window.

source

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

Set minimum height of the window.

source

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.

source

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

Set maximum width of the window.

source

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

Set maximum height of the window.

source

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.

source

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!

source

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

Set initial position of the window.

source

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

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

source

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

Constrains this window to the screen bounds.

To change the area to constrain to, use Self::constrain_to.

Default: true.

source

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()).

source

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.

source

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.

source

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

Set initial collapsed state of the window

source

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

Set initial size of the window.

source

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

Set initial width of the window.

source

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

Set initial height of the window.

source

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

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

source

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

Set initial position and size of the window.

source

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.

source

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.

Default is true.

source

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

Can the window be collapsed by clicking on its title?

source

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.

source

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.

source

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

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

source

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

Enable/disable horizontal scrolling. false by default.

source

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

Enable/disable vertical scrolling. false by default.

source

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>

source

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.

source

fn show_dyn<'c, R>( self, ctx: &Context, add_contents: Box<dyn FnOnce(&mut Ui) -> R + 'c> ) -> Option<InnerResponse<Option<R>>>

Auto Trait Implementations§

§

impl<'open> Freeze for Window<'open>

§

impl<'open> RefUnwindSafe for Window<'open>

§

impl<'open> Send for Window<'open>

§

impl<'open> Sync for Window<'open>

§

impl<'open> Unpin for Window<'open>

§

impl<'open> !UnwindSafe for Window<'open>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.