Struct cushy::context::EventContext

pub struct EventContext<'context> {
    pub widget: WidgetContext<'context>,
    pub kludgine: &'context mut Kludgine,
}

A context to an event function.

This type is a combination of a reference to the rendering library, [Kludgine], and a WidgetContext.

Fields

widget: WidgetContext<'context>

The context for the widget receiving the event.

kludgine: &'context mut Kludgine

The rendering library’s state.

This is useful for accessing the current scale or information needed to measure and layout text.

Implementations

impl<'context> EventContext<'context>

pub fn for_other<'child, Widget>( &'child mut self, widget: &Widget, ) -> <Widget::Managed as MapManagedWidget<EventContext<'child>>>::Result

where Widget: ManageWidget, Widget::Managed: MapManagedWidget<EventContext<'child>>,

Returns a new EventContext with widget being referenced in the contained WidgetContext.

This function is used when one widget contains other widgets, and the parent widget needs to invoke events on a child widget. This is done by creating an EventContext pointing to the child and calling the appropriate function to invoke the event.

pub fn hit_test(&mut self, location: Point<Px>) -> bool

Invokes Widget::hit_test() on this context’s widget and returns the result.

pub fn mouse_down( &mut self, location: Point<Px>, device_id: DeviceId, button: MouseButton, ) -> EventHandling

Invokes Widget::mouse_down() on this context’s widget and returns the result.

pub fn mouse_drag( &mut self, location: Point<Px>, device_id: DeviceId, button: MouseButton, )

Invokes Widget::hit_test() on this context’s widget and returns the result.

pub fn mouse_up( &mut self, location: Option<Point<Px>>, device_id: DeviceId, button: MouseButton, )

Invokes Widget::mouse_up() on this context’s widget and returns the result.

pub fn keyboard_input( &mut self, device_id: DeviceId, input: KeyEvent, is_synthetic: bool, ) -> EventHandling

Invokes Widget::keyboard_input() on this context’s widget and returns the result.

pub fn ime(&mut self, ime: Ime) -> EventHandling

Invokes Widget::ime() on this context’s widget and returns the result.

pub fn mouse_wheel( &mut self, device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase, ) -> EventHandling

Invokes Widget::mouse_wheel() on this context’s widget and returns the result.

pub fn advance_focus(&mut self)

Advances the focus to the next widget after this widget in the configured focus order.

To focus in the reverse order, use EventContext::return_focus().

pub fn return_focus(&mut self)

Returns the focus to the previous widget before this widget in the configured fous order.

To focus in the forward order, use EventContext::advance_focus().

pub fn root_behavior(&mut self) -> Option<(RootBehavior, WidgetInstance)>

Invokes Widget::root_behavior() on this context’s widget and returns the result.

Methods from Deref<Target = WidgetContext<'context>>

pub fn borrowed(&mut self) -> WidgetContext<'_>

Returns a new instance that borrows from self.

pub fn for_other<'child, Widget>( &'child mut self, widget: &Widget, ) -> <Widget::Managed as MapManagedWidget<WidgetContext<'child>>>::Result

where Widget: ManageWidget, Widget::Managed: MapManagedWidget<WidgetContext<'child>>,

Returns a new context representing widget.

pub fn is_child_of(&self, possible_parent: &WidgetInstance) -> bool

Returns true if possible_parent is in this widget’s parent list.

pub fn enabled(&self) -> bool

Returns true if this widget is enabled.

pub fn redraw_when_changed(&self, value: &impl Trackable)

Ensures that this widget will be redrawn when value has been updated.

pub fn invalidate_when_changed(&self, value: &impl Trackable)

Ensures that this widget will be redrawn when value has been updated.

pub fn last_layout(&self) -> Option<Rect<Px>>

Returns the last layout of this widget.

pub fn focus(&mut self)

Sets the currently focused widget to this widget.

Widget events relating to focus changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn blur(&mut self) -> bool

Clears focus from this widget, if it is the focused widget.

Returns true if this function resulted in the focus being changed.

Widget events relating to focus changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn focus_is_advancing(&mut self) -> bool

Returns true if the last focus event was an advancing motion, not a returning motion.

This value is meaningless outside of focus-related events.

pub fn activate(&mut self) -> bool

Activates this widget, if it is not already active.

Returns true if this function resulted in the currently active widget being changed.

Widget events relating to activation changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn deactivate(&mut self) -> bool

Deactivates this widget, if it is the currently active widget.

Returns true if this function resulted in the active widget being changed.

Widget events relating to activation changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn active(&self) -> bool

Returns true if this widget is currently the active widget.

pub fn hovered(&self) -> bool

Returns true if this widget is currently hovered, even if the cursor is over a child widget.

pub fn primary_hover(&self) -> bool

Returns true if this widget that is directly beneath the cursor.

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

Returns true if this widget is currently focused for user input.

pub fn is_default(&self) -> bool

Returns true if this widget is the target to activate when the user triggers a default action.

See MakeWidget::into_default() for more information.

pub fn is_escape(&self) -> bool

Returns true if this widget is the target to activate when the user triggers an escape action.

See MakeWidget::into_escape() for more information.

pub fn widget(&self) -> &MountedWidget

Returns the widget this context is for.

pub fn attach_styles(&self, styles: impl IntoValue<Styles>)

Attaches styles to the widget hierarchy for this widget.

Style queries for children will return any values matching this collection.

pub fn attach_theme(&self, theme: Value<ThemePair>)

Attaches theme to the widget hierarchy for this widget.

All children nodes will access this theme in their contexts.

pub fn attach_theme_mode(&mut self, theme_mode: Value<ThemeMode>)

Attaches theme_mode to the widget hierarchy for this widget.

All children nodes will use this theme mode.

pub fn get<Component: ComponentDefinition>( &self, query: &Component, ) -> Component::ComponentType

Queries the widget hierarchy for a single style component.

This function traverses up the widget hierarchy looking for the component being requested. If a matching component is found, it will be returned. Otherwise, the default value will be returned.

pub fn try_get<Component: ComponentDefinition>( &self, query: &Component, ) -> Option<Component::ComponentType>

Queries the widget hierarchy for a single style component.

This function traverses up the widget hierarchy looking for the component being requested. If a matching component is found, it will be returned.

pub fn window(&self) -> &dyn PlatformWindow

Returns the window containing this widget.

pub fn window_mut(&mut self) -> &mut dyn PlatformWindow

Returns an exclusive reference to the window containing this widget.

pub fn theme_pair(&self) -> &ThemePair

Returns the theme pair for the window.

pub fn theme(&self) -> &Theme

Returns the current theme in either light or dark mode.

pub fn theme_mode(&self) -> ThemeMode

Returns the currently active theme mode.

pub fn inverse_theme(&self) -> &Theme

Returns the opposite theme of Self::theme().

pub fn cache_key(&self) -> WidgetCacheKey

Returns a key that can be checked to see if a widget should invalidate caches it stores.

pub fn loaded_font_faces(&self, font: &LoadedFont) -> &[LoadedFontFace]

Returns a list of faces that were loaded from font, or an empty slice if no faces were loaded.

Trait Implementations

impl AsEventContext for EventContext<'_>

fn as_event_context(&mut self) -> EventContext<'_>

Returns this context as an EventContext.

fn push_child(&mut self, child: WidgetInstance) -> MountedWidget

Pushes a new child widget into the widget hierarchy beneathq the context’s widget.

fn remove_child(&mut self, child: &MountedWidget)

Removes a widget from the hierarchy.

impl<'context> Deref for EventContext<'context>

type Target = WidgetContext<'context>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'context> DerefMut for EventContext<'context>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for EventContext<'_>

fn drop(&mut self)

Executes the destructor for this type.