Struct zng_app::window::WINDOW

impl WINDOW

Window test helpers.

§Panics

Most of the test methods panic if not called inside with_test_context.

pub fn with_test_context<R>( &self, update_mode: WidgetUpdateMode, f: impl FnOnce() -> R ) -> R

Calls f inside a new headless window and root widget.

pub fn test_window_size(&self) -> PxSize

Get the test window size.

This size is used by the test_* methods that need a window size.

pub fn set_test_window_size(&self, size: PxSize)

Set test window size.

pub fn test_init(&self, content: &mut impl UiNode) -> ContextUpdates

Call inside with_test_context to init the content as a child of the test window root.

pub fn test_deinit(&self, content: &mut impl UiNode) -> ContextUpdates

Call inside with_test_context to deinit the content as a child of the test window root.

pub fn test_info(&self, content: &mut impl UiNode) -> ContextUpdates

Call inside with_test_context to rebuild info the content as a child of the test window root.

pub fn test_event( &self, content: &mut impl UiNode, update: &mut EventUpdate ) -> ContextUpdates

Call inside with_test_context to delivery an event to the content as a child of the test window root.

pub fn test_update( &self, content: &mut impl UiNode, updates: Option<&mut WidgetUpdates> ) -> ContextUpdates

Call inside with_test_context to update the content as a child of the test window root.

The updates can be set to a custom delivery list, otherwise window root and content widget are flagged for update.

pub fn test_layout( &self, content: &mut impl UiNode, constraints: Option<PxConstraints2d> ) -> (PxSize, ContextUpdates)

Call inside with_test_context to layout the content as a child of the test window root.

pub fn test_layout_inline( &self, content: &mut impl UiNode, measure_constraints: (PxConstraints2d, InlineConstraintsMeasure), layout_constraints: (PxConstraints2d, InlineConstraintsLayout) ) -> ((PxSize, PxSize), ContextUpdates)

Call inside with_test_context to layout the content as a child of the test window root.

Returns the measure and layout size, and the requested updates.

pub fn test_render( &self, content: &mut impl UiNode ) -> (BuiltFrame, ContextUpdates)

Call inside with_test_context to render the content as a child of the test window root.

pub fn test_render_update( &self, content: &mut impl UiNode ) -> (BuiltFrameUpdate, ContextUpdates)

Call inside with_test_context to render_update the content as a child of the test window root.

impl WINDOW

pub fn is_in_window(&self) -> bool

Returns true if called inside a window.

pub fn try_id(&self) -> Option<WindowId>

Gets the window ID, if called inside a window.

pub fn id(&self) -> WindowId

Gets the window ID.

pub fn mode(&self) -> WindowMode

Gets the window mode.

pub fn info(&self) -> WidgetInfoTree

Gets the window info tree.

Panics if called before the window future yields the window.

pub fn with_state<R>(&self, f: impl FnOnce(StateMapRef<'_, WINDOW>) -> R) -> R

Calls f with a read lock on the current window state map.

pub fn with_state_mut<R>( &self, f: impl FnOnce(StateMapMut<'_, WINDOW>) -> R ) -> R

Calls f with a write lock on the current window state map.

pub fn get_state<T: StateValue + Clone>( &self, id: impl Into<StateId<T>> ) -> Option<T>

Get the window state id, if it is set.

pub fn req_state<T: StateValue + Clone>(&self, id: impl Into<StateId<T>>) -> T

Require the window state id.

Panics if the id is not set.

pub fn set_state<T: StateValue>( &self, id: impl Into<StateId<T>>, value: impl Into<T> ) -> Option<T>

Set the window state id to value.

Returns the previous set value.

pub fn flag_state(&self, id: impl Into<StateId<()>>) -> bool

Sets the window state id without value.

Returns if the state id was already flagged.

pub fn init_state<T: StateValue>( &self, id: impl Into<StateId<T>>, init: impl FnOnce() -> T )

Calls init and sets id if the id is not already set in the widget.

pub fn init_state_default<T: StateValue + Default>( &self, id: impl Into<StateId<T>> )

Sets the id to the default value if it is not already set.

pub fn contains_state<T: StateValue>(&self, id: impl Into<StateId<T>>) -> bool

Returns true if the id is set or flagged in the window.

pub fn with_context<R>(&self, ctx: &mut WindowCtx, f: impl FnOnce() -> R) -> R

Calls f while the window is set to ctx.

pub fn with_no_context<R>(&self, f: impl FnOnce() -> R) -> R

Calls f while no window is available in the context.

Auto Trait Implementations§

impl UnwindSafe for WINDOW

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more