pub struct Window<Data>where
Data: 'static,{ /* private fields */ }
Expand description
The window widget
This widget is the root of any UI tree used as a window. It manages window decorations.
To change window properties at run-time, send a WindowCommand
from a
child widget.
Implementations§
source§impl<Data> Window<Data>where
Data: 'static,
impl<Data> Window<Data>where
Data: 'static,
sourcepub fn new(
ui: impl Widget<Data = Data> + 'static,
title: impl ToString
) -> Window<Data>
pub fn new( ui: impl Widget<Data = Data> + 'static, title: impl ToString ) -> Window<Data>
Construct a window with a W: Widget
and a title
sourcepub fn new_boxed(
ui: Box<dyn Widget<Data = Data>>,
title: impl ToString
) -> Window<Data>
pub fn new_boxed( ui: Box<dyn Widget<Data = Data>>, title: impl ToString ) -> Window<Data>
Construct a window from a boxed ui
widget and a title
sourcepub fn with_icon(self, icon: impl Into<Option<Icon>>) -> Window<Data>
pub fn with_icon(self, icon: impl Into<Option<Icon>>) -> Window<Data>
Set the window’s icon (inline)
Default: None
sourcepub fn decorations(&self) -> Decorations
pub fn decorations(&self) -> Decorations
Get the preference for window decorations
sourcepub fn with_decorations(self, decorations: Decorations) -> Window<Data>
pub fn with_decorations(self, decorations: Decorations) -> Window<Data>
Set the preference for window decorations
“Windowing” platforms (i.e. not mobile or web) usually include a title-bar, icons and potentially side borders. These are known as decorations.
This controls the preferred type of decorations. The resulting behaviour is platform-dependent.
Default: Decorations::Server
.
sourcepub fn restrictions(&self) -> (bool, bool)
pub fn restrictions(&self) -> (bool, bool)
Get window resizing restrictions: (restrict_min, restrict_max)
sourcepub fn with_restrictions(
self,
restrict_min: bool,
restrict_max: bool
) -> Window<Data>
pub fn with_restrictions( self, restrict_min: bool, restrict_max: bool ) -> Window<Data>
Whether to limit the maximum size of a window
All widgets’ size rules allow calculation of two sizes: the minimum size and the ideal size. Windows are initially sized to the ideal size.
If restrict_min
, the window may not be sized below the minimum size.
Default value: true
.
If restrict_max
, the window may not be sized above the ideal size.
Default value: false
.
sourcepub fn drag_anywhere(&self) -> bool
pub fn drag_anywhere(&self) -> bool
Get “drag anywhere” state
sourcepub fn with_drag_anywhere(self, drag_anywhere: bool) -> Window<Data>
pub fn with_drag_anywhere(self, drag_anywhere: bool) -> Window<Data>
Whether to allow dragging the window from the background
If true, then any unhandled click+drag in the window may be used to
drag the window on supported platforms. Default value: true
.
sourcepub fn transparent(&self) -> bool
pub fn transparent(&self) -> bool
Get whether this window should use transparent rendering
sourcepub fn with_transparent(self, transparent: bool) -> Window<Data>
pub fn with_transparent(self, transparent: bool) -> Window<Data>
Whether the window supports transparency
If true, painting with alpha < 1.0
makes the background visible.
Additionally, window draw targets are cleared to transparent. This does
not stop theme elements from drawing a solid background.
Note: results may vary by platform. Current output does not use pre-multiplied alpha which some platforms expect, thus pixels with partial transparency may have incorrect appearance.
Default: false
.
Trait Implementations§
source§impl<Data> Events for Window<Data>where
Data: 'static,
impl<Data> Events for Window<Data>where
Data: 'static,
source§fn handle_event(
&mut self,
cx: &mut EventCx<'_>,
_: &<Window<Data> as Widget>::Data,
event: Event
) -> IsUsed
fn handle_event( &mut self, cx: &mut EventCx<'_>, _: &<Window<Data> as Widget>::Data, event: Event ) -> IsUsed
source§fn handle_messages(
&mut self,
cx: &mut EventCx<'_>,
_: &<Window<Data> as Widget>::Data
)
fn handle_messages( &mut self, cx: &mut EventCx<'_>, _: &<Window<Data> as Widget>::Data )
source§fn handle_scroll(&mut self, cx: &mut EventCx<'_>, data: &Data, _: Scroll)
fn handle_scroll(&mut self, cx: &mut EventCx<'_>, data: &Data, _: Scroll)
source§fn steal_event(
&mut self,
_: &mut EventCx<'_>,
_: &<Window<Data> as Widget>::Data,
_: &Id,
_: &Event
) -> IsUsed
fn steal_event( &mut self, _: &mut EventCx<'_>, _: &<Window<Data> as Widget>::Data, _: &Id, _: &Event ) -> IsUsed
source§fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
source§fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
source§fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)
source§impl<Data> Layout for Window<Data>where
Data: 'static,
impl<Data> Layout for Window<Data>where
Data: 'static,
source§fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules
fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules
source§fn widget_name(&self) -> &'static str
fn widget_name(&self) -> &'static str
source§fn num_children(&self) -> usize
fn num_children(&self) -> usize
source§fn get_child(&self, index: usize) -> Option<&dyn Layout>
fn get_child(&self, index: usize) -> Option<&dyn Layout>
dyn Layout
Read moresource§fn find_child_index(&self, id: &Id) -> Option<usize>
fn find_child_index(&self, id: &Id) -> Option<usize>
id
, if any Read moresource§fn translation(&self) -> Offset
fn translation(&self) -> Offset
Auto Trait Implementations§
impl<Data> !RefUnwindSafe for Window<Data>
impl<Data> !Send for Window<Data>
impl<Data> !Sync for Window<Data>
impl<Data> Unpin for Window<Data>
impl<Data> !UnwindSafe for Window<Data>
Blanket Implementations§
source§impl<W> AdaptWidget for Wwhere
W: Widget,
impl<W> AdaptWidget for Wwhere
W: Widget,
source§fn on_configure<F>(self, f: F) -> AdaptEvents<Self>
fn on_configure<F>(self, f: F) -> AdaptEvents<Self>
Events::configure
Read moresource§fn on_update<F>(self, f: F) -> AdaptEvents<Self>
fn on_update<F>(self, f: F) -> AdaptEvents<Self>
Events::update
Read moresource§fn on_message<M, H>(self, handler: H) -> AdaptEvents<Self>
fn on_message<M, H>(self, handler: H) -> AdaptEvents<Self>
M
Read moresource§fn on_messages<H>(self, handler: H) -> AdaptEvents<Self>
fn on_messages<H>(self, handler: H) -> AdaptEvents<Self>
source§fn with_min_size_px(self, w: i32, h: i32) -> Reserve<Self>
fn with_min_size_px(self, w: i32, h: i32) -> Reserve<Self>
source§fn with_min_size_em(self, w: f32, h: f32) -> Reserve<Self>
fn with_min_size_em(self, w: f32, h: f32) -> Reserve<Self>
source§fn with_label<D, T>(self, direction: D, label: T) -> WithLabel<Self, D>
fn with_label<D, T>(self, direction: D, label: T) -> WithLabel<Self, D>
source§impl<W> AdaptWidgetAny for W
impl<W> AdaptWidgetAny for W
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<S, T> CastApprox<T> for Swhere
T: ConvApprox<S>,
impl<S, T> CastApprox<T> for Swhere
T: ConvApprox<S>,
§fn try_cast_approx(self) -> Result<T, Error>
fn try_cast_approx(self) -> Result<T, Error>
§fn cast_approx(self) -> T
fn cast_approx(self) -> T
§impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,
impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,
§fn cast_trunc(self) -> T
fn cast_trunc(self) -> T
§fn cast_nearest(self) -> T
fn cast_nearest(self) -> T
§fn cast_floor(self) -> T
fn cast_floor(self) -> T
§fn try_cast_trunc(self) -> Result<T, Error>
fn try_cast_trunc(self) -> Result<T, Error>
§fn try_cast_nearest(self) -> Result<T, Error>
fn try_cast_nearest(self) -> Result<T, Error>
§fn try_cast_floor(self) -> Result<T, Error>
fn try_cast_floor(self) -> Result<T, Error>
§fn try_cast_ceil(self) -> Result<T, Error>
fn try_cast_ceil(self) -> Result<T, Error>
§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> 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<W> LayoutExt for W
impl<W> LayoutExt for W
source§fn identify(&self) -> IdentifyWidget<'_>
fn identify(&self) -> IdentifyWidget<'_>
source§fn is_strict_ancestor_of(&self, id: &Id) -> bool
fn is_strict_ancestor_of(&self, id: &Id) -> bool
id
is not self and is a descendant Read more