Struct EventCx

pub struct EventCx<'a, 'b> { /* private fields */ }

A context for handling events.

Implementations

impl<'a, 'b> EventCx<'a, 'b>

pub fn new( base: &'a mut BaseCx<'b>, view_state: &'a mut ViewState, rebuild: &'a mut bool, ) -> EventCx<'a, 'b>

Create a new event context.

pub fn child(&mut self) -> EventCx<'_, 'b>

Create a child context.

pub fn as_build_cx(&mut self) -> BuildCx<'_, 'b>

Get a build context.

pub fn as_rebuild_cx(&mut self) -> RebuildCx<'_, 'b>

Get a rebuild context.

pub fn as_layout_cx(&mut self) -> LayoutCx<'_, 'b>

Get a layout context.

pub fn size(&self) -> Size

Get the size of the view.

pub fn rect(&self) -> Rect

Get the rect of the view in local space.

pub fn transform(&self) -> Affine

Get the transform of the view.

pub fn local(&self, point: Point) -> Point

Transform a point from global space to local space.

pub fn rebuild(&mut self)

Request a rebuild of the view tree.

pub fn was_hovered(&self) -> bool

Get whether the view was hovered last call.

pub fn was_focused(&self) -> bool

Get whether the view was focused last call.

pub fn was_active(&self) -> bool

Get whether the view was active last call.

pub fn had_hovered(&self) -> bool

Get whether a child view was hovered last call.

pub fn had_focused(&self) -> bool

Get whether a child view was focused last call.

pub fn had_active(&self) -> bool

Get whether a child view was active last call.

pub fn hovered_changed(&self) -> bool

Get whether the view’s hovered state changed.

pub fn focused_changed(&self) -> bool

Get whether the view’s focused state changed.

pub fn active_changed(&self) -> bool

Get whether the view’s active state changed.

pub fn has_hovered_changed(&self) -> bool

Get whether a child view’s hovered state changed.

pub fn has_focused_changed(&self) -> bool

Get whether a child view’s focused state changed.

pub fn has_active_changed(&self) -> bool

Get whether a child view’s active state changed.

impl EventCx<'_, '_>

pub fn window(&self) -> &Window

Get the window.

pub fn window_mut(&mut self) -> &mut Window

Get the window mutably.

pub fn styles(&mut self) -> &mut Styles

Get the styles.

pub fn style<T>(&mut self) -> &T

where T: Style + Any,

Get the style T.

pub fn theme(&mut self) -> &Theme

Get the Theme of the context.

pub fn id(&self) -> ViewId

Get the id of the view.

pub fn is_hovered(&self) -> bool

Get whether the view is hovered.

pub fn is_focused(&self) -> bool

Get whether the view is focused.

pub fn is_active(&self) -> bool

Get whether the view is active.

pub fn is_focusable(&self) -> bool

Get whether the view is focusable.

pub fn has_hovered(&self) -> bool

Get whether a child view is hovered.

pub fn has_focused(&self) -> bool

Get whether a child view is focused.

pub fn has_active(&self) -> bool

Get whether a child view is active.

pub fn contains_property<T>(&self) -> bool

where T: 'static,

Check if the view has the property T.

pub fn insert_property<T>(&mut self, item: T)

where T: 'static,

Insert a property into the view.

pub fn remove_property<T>(&mut self) -> Option<T>

where T: 'static,

Remove a property from the view.

pub fn get_property<T>(&self) -> Option<&T>

where T: 'static,

Get the property T of the view.

pub fn get_property_mut<T>(&mut self) -> Option<&mut T>

where T: 'static,

Get the property T of the view mutably.

pub fn property_or_insert_with<T, F>(&mut self, f: F) -> &mut T

where T: 'static, F: FnOnce() -> T,

Get the property T of the view or insert it with a value.

pub fn property_or<T>(&mut self, item: T) -> &mut T

where T: 'static,

Get the property T of the view or insert it with a value.

pub fn property_or_default<T>(&mut self) -> &mut T

where T: 'static + Default,

Get the property T of the view or insert it with a default value.

impl EventCx<'_, '_>

pub fn propagate(&mut self, child: &mut ViewState)

Propagate the view state of a child view.

pub fn layout(&mut self)

Request a layout of the view tree.

pub fn draw(&mut self)

Request a draw of the view tree.

pub fn animate(&mut self)

Request an animation frame.

pub fn focus(&mut self)

Request focus for the view.

pub fn focus_next(&mut self)

Request the next focusable view to be focused.

pub fn focus_prev(&mut self)

Request the previous focusable view to be focused.

pub fn set_cursor(&mut self, cursor: Option<Cursor>)

Set the cursor of the view.

pub fn set_ime(&mut self, ime: Option<Ime>)

Set the ime of the view.

pub fn set_hovered(&mut self, hovered: bool) -> bool

Set whether the view is hovered.

Returns true if the hovered state changed.

pub fn set_focused(&mut self, focused: bool) -> bool

Set whether the view is focused.

Returns true if the focused state changed.

pub fn set_active(&mut self, active: bool) -> bool

Set whether the view is active.

Returns true if the active state changed.

pub fn set_focusable(&mut self, focusable: bool) -> bool

Set whether the view is focusable.

Returns true if the focusable state changed.

Methods from Deref<Target = BaseCx<'b>>

pub fn fonts(&mut self) -> &mut (dyn Fonts + 'static)

Get the Fonts as a mutable reference.

pub fn measure_paragraph(&mut self, paragraph: &Paragraph, width: f32) -> Size

Measure a paragraph.

pub fn layout_paragraph( &mut self, paragraph: &Paragraph, width: f32, ) -> Vec<TextLayoutLine>

Layout a paragraph.

pub fn clipboard(&mut self) -> &mut Clipboard

Get the Clipboard.

pub fn proxy(&self) -> CommandProxy

Get the CommandProxy.

pub fn cmd<T>(&mut self, command: T)

where T: Any + Send,

Emit a command.

pub fn spawn_async(&mut self, future: impl Future<Output = ()> + Send + 'static)

Spawn a future.

pub fn cmd_async<T>(&self, future: impl Future<Output = T> + Send + 'static)

where T: Any + Send,

Spawn a future sending a command when it completes.

pub fn contexts(&self) -> &Contexts

Get a reference to the Contexts.

pub fn contexts_mut(&mut self) -> &mut Contexts

Get a mutable reference to the Contexts.

pub fn insert_context<T>(&mut self, context: T) -> Option<T>

where T: Any,

Insert a context.

pub fn contains_context<T>(&self) -> bool

where T: Any,

Check if a context is contained.

pub fn remove_context<T>(&mut self) -> Option<T>

where T: Any,

Remove a context.

pub fn get_context<T>(&self) -> Option<&T>

where T: Any,

Get a context.

pub fn get_context_mut<T>(&mut self) -> Option<&mut T>

where T: Any,

Get a mutable context.

pub fn context<T>(&self) -> &T

where T: Any,

Get a context.

Panics

• If the context is not found.

pub fn context_mut<T>(&mut self) -> &mut T

where T: Any,

Get a mutable context.

Panics

• If the context is not found.

pub fn context_or_default<T>(&mut self) -> &mut T

where T: Any + Default,

Get a context or insert a default.

Trait Implementations

impl<'b> Deref for EventCx<'_, 'b>

type Target = BaseCx<'b>

The resulting type after dereferencing.

fn deref(&self) -> &<EventCx<'_, 'b> as Deref>::Target

Dereferences the value.

impl DerefMut for EventCx<'_, '_>

fn deref_mut(&mut self) -> &mut <EventCx<'_, '_> as Deref>::Target

Mutably dereferences the value.