Struct jumpy::prelude::egui::containers::Window
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()
.
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§
§impl<'open> Window<'open>
impl<'open> Window<'open>
pub fn new(title: impl Into<WidgetText>) -> Window<'open>
pub fn new(title: impl Into<WidgetText>) -> Window<'open>
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.
pub fn id(self, id: Id) -> Window<'open>
pub fn id(self, id: Id) -> Window<'open>
Assign a unique id to the Window. Required if the title changes, or is shared with another window.
pub fn open(self, open: &'open mut bool) -> Window<'open>
pub fn open(self, open: &'open mut bool) -> Window<'open>
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
.
pub fn enabled(self, enabled: bool) -> Window<'open>
pub fn enabled(self, enabled: bool) -> Window<'open>
If false
the window will be grayed out and non-interactive.
pub fn interactable(self, interactable: bool) -> Window<'open>
pub fn interactable(self, interactable: bool) -> Window<'open>
If false
the window will be non-interactive.
pub fn mutate(self, mutate: impl Fn(&mut Window<'open>)) -> Window<'open>
pub fn mutate(self, mutate: impl Fn(&mut Window<'open>)) -> Window<'open>
Usage: Window::new(…).mutate(|w| w.resize = w.resize.auto_expand_width(true))
pub fn resize(self, mutate: impl Fn(Resize) -> Resize) -> Window<'open>
pub fn resize(self, mutate: impl Fn(Resize) -> Resize) -> Window<'open>
Usage: Window::new(…).resize(|r| r.auto_expand_width(true))
pub fn min_height(self, min_height: f32) -> Window<'open>
pub fn min_height(self, min_height: f32) -> Window<'open>
Set minimum height of the window.
pub fn current_pos(self, current_pos: impl Into<Pos2>) -> Window<'open>
pub fn current_pos(self, current_pos: impl Into<Pos2>) -> Window<'open>
Set current position of the window. If the window is movable it is up to you to keep track of where it moved to!
pub fn default_pos(self, default_pos: impl Into<Pos2>) -> Window<'open>
pub fn default_pos(self, default_pos: impl Into<Pos2>) -> Window<'open>
Set initial position of the window.
pub fn fixed_pos(self, pos: impl Into<Pos2>) -> Window<'open>
pub fn fixed_pos(self, pos: impl Into<Pos2>) -> Window<'open>
Sets the window position and prevents it from being dragged around.
pub fn constrain(self, constrain: bool) -> Window<'open>
pub fn constrain(self, constrain: bool) -> Window<'open>
Constrains this window to the screen bounds.
To change the area to constrain to, use Self::constraint_to
.
Default: true
.
pub fn constraint_to(self, constrain_rect: Rect) -> Window<'open>
pub fn constraint_to(self, constrain_rect: Rect) -> Window<'open>
Constraint the movement of the window to the given rectangle.
For instance: .constrain_to(ctx.screen_rect())
.
pub fn drag_bounds(self, constrain_rect: Rect) -> Window<'open>
constrain_to
insteadpub fn pivot(self, pivot: Align2) -> Window<'open>
pub fn pivot(self, pivot: Align2) -> Window<'open>
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
.
pub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Window<'open>
pub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Window<'open>
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.
pub fn default_open(self, default_open: bool) -> Window<'open>
pub fn default_open(self, default_open: bool) -> Window<'open>
Set initial collapsed state of the window
pub fn default_size(self, default_size: impl Into<Vec2>) -> Window<'open>
pub fn default_size(self, default_size: impl Into<Vec2>) -> Window<'open>
Set initial size of the window.
pub fn default_width(self, default_width: f32) -> Window<'open>
pub fn default_width(self, default_width: f32) -> Window<'open>
Set initial width of the window.
pub fn default_height(self, default_height: f32) -> Window<'open>
pub fn default_height(self, default_height: f32) -> Window<'open>
Set initial height of the window.
pub fn fixed_size(self, size: impl Into<Vec2>) -> Window<'open>
pub fn fixed_size(self, size: impl Into<Vec2>) -> Window<'open>
Sets the window size and prevents it from being resized by dragging its edges.
pub fn default_rect(self, rect: Rect) -> Window<'open>
pub fn default_rect(self, rect: Rect) -> Window<'open>
Set initial position and size of the window.
pub fn fixed_rect(self, rect: Rect) -> Window<'open>
pub fn fixed_rect(self, rect: Rect) -> Window<'open>
Sets the window pos and size and prevents it from being moved and resized by dragging its edges.
pub fn resizable(self, resizable: bool) -> Window<'open>
pub fn resizable(self, resizable: bool) -> Window<'open>
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
.
pub fn collapsible(self, collapsible: bool) -> Window<'open>
pub fn collapsible(self, collapsible: bool) -> Window<'open>
Can the window be collapsed by clicking on its title?
pub fn title_bar(self, title_bar: bool) -> Window<'open>
pub fn title_bar(self, title_bar: bool) -> Window<'open>
Show title bar on top of the window?
If false
, the window will not be collapsible nor have a close-button.
pub fn auto_sized(self) -> Window<'open>
pub fn auto_sized(self) -> Window<'open>
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 scroll2(self, scroll: [bool; 2]) -> Window<'open>
pub fn scroll2(self, scroll: [bool; 2]) -> Window<'open>
Enable/disable horizontal/vertical scrolling. false
by default.
pub fn hscroll(self, hscroll: bool) -> Window<'open>
pub fn hscroll(self, hscroll: bool) -> Window<'open>
Enable/disable horizontal scrolling. false
by default.
pub fn vscroll(self, vscroll: bool) -> Window<'open>
pub fn vscroll(self, vscroll: bool) -> Window<'open>
Enable/disable vertical scrolling. false
by default.
pub fn drag_to_scroll(self, drag_to_scroll: bool) -> Window<'open>
pub fn drag_to_scroll(self, drag_to_scroll: bool) -> Window<'open>
Enable/disable scrolling on the window by dragging with the pointer. true
by default.
See ScrollArea::drag_to_scroll
for more.
§impl<'open> Window<'open>
impl<'open> Window<'open>
pub 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.
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§
§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
[ShaderType
] for self
. When used in [AsBindGroup
]
derives, it is safe to assume that all images in self
exist.§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.