pub trait ViewWrapper:
Send
+ Sync
+ 'static {
type V: View + ?Sized;
// Required methods
fn with_view<F, R>(&self, f: F) -> Option<R>
where F: FnOnce(&Self::V) -> R;
fn with_view_mut<F, R>(&mut self, f: F) -> Option<R>
where F: FnOnce(&mut Self::V) -> R;
// Provided methods
fn into_inner(self) -> Result<Self::V, Self>
where Self: Sized,
Self::V: Sized { ... }
fn wrap_draw(&self, printer: &Printer<'_, '_>) { ... }
fn wrap_required_size(&mut self, req: Vec2) -> Vec2 { ... }
fn wrap_on_event(&mut self, ch: Event) -> EventResult { ... }
fn wrap_layout(&mut self, size: Vec2) { ... }
fn wrap_take_focus(
&mut self,
source: Direction,
) -> Result<EventResult, CannotFocus> { ... }
fn wrap_call_on_any(&mut self, selector: &Selector<'_>, callback: AnyCb<'_>) { ... }
fn wrap_focus_view(
&mut self,
selector: &Selector<'_>,
) -> Result<EventResult, ViewNotFound> { ... }
fn wrap_needs_relayout(&self) -> bool { ... }
fn wrap_important_area(&self, size: Vec2) -> Rect { ... }
}Expand description
Generic wrapper around a view.
This trait is a shortcut to implement View on a type by forwarding
calls to a wrapped view.
You only need to define with_view and with_view_mut
(the wrap_impl! macro can help you with that), and you will get
the View implementation for free.
You can also override any of the wrap_* methods for more specific
behaviors (the default implementations simply forwards the calls to the
child view).
Required Associated Types§
Required Methods§
Sourcefn with_view<F, R>(&self, f: F) -> Option<R>
fn with_view<F, R>(&self, f: F) -> Option<R>
Runs a function on the inner view, returning the result.
Returns None if the inner view is unavailable. This should only
happen with some views if they are already borrowed by another call.
Sourcefn with_view_mut<F, R>(&mut self, f: F) -> Option<R>
fn with_view_mut<F, R>(&mut self, f: F) -> Option<R>
Runs a function on the inner view, returning the result.
Returns None if the inner view is unavailable. This should only
happen with some views if they are already borrowed by another call.
Provided Methods§
Sourcefn into_inner(self) -> Result<Self::V, Self>
fn into_inner(self) -> Result<Self::V, Self>
Attempts to retrieve the inner view.
Sourcefn wrap_required_size(&mut self, req: Vec2) -> Vec2
fn wrap_required_size(&mut self, req: Vec2) -> Vec2
Wraps the required_size method.
Sourcefn wrap_on_event(&mut self, ch: Event) -> EventResult
fn wrap_on_event(&mut self, ch: Event) -> EventResult
Wraps the on_event method.
Sourcefn wrap_layout(&mut self, size: Vec2)
fn wrap_layout(&mut self, size: Vec2)
Wraps the layout method.
Sourcefn wrap_take_focus(
&mut self,
source: Direction,
) -> Result<EventResult, CannotFocus>
fn wrap_take_focus( &mut self, source: Direction, ) -> Result<EventResult, CannotFocus>
Wraps the take_focus method.
Sourcefn wrap_call_on_any(&mut self, selector: &Selector<'_>, callback: AnyCb<'_>)
fn wrap_call_on_any(&mut self, selector: &Selector<'_>, callback: AnyCb<'_>)
Wraps the find method.
Sourcefn wrap_focus_view(
&mut self,
selector: &Selector<'_>,
) -> Result<EventResult, ViewNotFound>
fn wrap_focus_view( &mut self, selector: &Selector<'_>, ) -> Result<EventResult, ViewNotFound>
Wraps the focus_view method.
Sourcefn wrap_needs_relayout(&self) -> bool
fn wrap_needs_relayout(&self) -> bool
Wraps the needs_relayout method.
Sourcefn wrap_important_area(&self, size: Vec2) -> Rect
fn wrap_important_area(&self, size: Vec2) -> Rect
Wraps the important_area method.
Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.