Struct ReturnFocusChangedArgs 

pub struct ReturnFocusChangedArgs {
    pub timestamp: DInstant,
    pub scope: Option<InteractionPath>,
    pub prev_return: Option<InteractionPath>,
    pub new_return: Option<InteractionPath>,
    pub propagation: EventPropagationHandle,
}

RETURN_FOCUS_CHANGED_EVENT arguments.

Fields

timestamp: DInstant

Instant the event happened.

scope: Option<InteractionPath>

The scope that returns the focus when focused directly.

Is None if the previous focus was the return focus of a scope that was removed.

prev_return: Option<InteractionPath>

Previous return focus of the widget.

new_return: Option<InteractionPath>

New return focus of the widget.

propagation: EventPropagationHandle

Propagation handle associated with this event instance.

Cloned arguments share the same handle, some arguments may also share the handle of another event if they share the same cause.

Implementations

impl ReturnFocusChangedArgs

pub fn new( timestamp: impl Into<DInstant>, propagation: EventPropagationHandle, scope: impl Into<Option<InteractionPath>>, prev_return: impl Into<Option<InteractionPath>>, new_return: impl Into<Option<InteractionPath>>, ) -> ReturnFocusChangedArgs

New args from values that convert into the argument types.

pub fn now( scope: impl Into<Option<InteractionPath>>, prev_return: impl Into<Option<InteractionPath>>, new_return: impl Into<Option<InteractionPath>>, ) -> ReturnFocusChangedArgs

Arguments for event that happened now (INSTANT.now).

impl ReturnFocusChangedArgs

pub fn is_widget_move(&self) -> bool

If the return focus is the same widget but the widget path changed and the widget is still in the same focus scope.

pub fn is_alt_return(&self) -> bool

If scope is an ALT scope and prev_return or new_return if the widget outside the scope that will be focused back when the user escapes the ALT scope.

pub fn lost_return_focus(&self, widget_id: WidgetId) -> bool

if the widget was in the prev_return and is not in the new_return.

pub fn got_return_focus(&self, widget_id: WidgetId) -> bool

if the widget was not in the prev_return and is in the new_return.

pub fn was_return_focus(&self, widget_id: WidgetId) -> bool

if the widget was the prev_return and is the new_return.

pub fn is_return_focus(&self, widget_id: WidgetId) -> bool

if the widget was not the prev_return and is the new_return.

pub fn is_return_focus_enter(&self, widget_id: WidgetId) -> bool

If widget_id is the new return focus or a parent of the new return and was not a parent of the previous return.

pub fn is_return_focus_leave(&self, widget_id: WidgetId) -> bool

If widget_id is the previous return focus or a parent of the previous return and is not a parent of the new return.

Trait Implementations

impl AnyEventArgs for ReturnFocusChangedArgs

fn is_in_target(&self, id: WidgetId) -> bool

If is in prev_return, new_return or scope.

fn timestamp(&self) -> DInstant

Instant this event update happened.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

fn clone_boxed(&self) -> Box<dyn AnyEventArgs>

Clone the args to a new box.

impl Clone for ReturnFocusChangedArgs

fn clone(&self) -> ReturnFocusChangedArgs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReturnFocusChangedArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for ReturnFocusChangedArgs

fn eq(&self, other: &ReturnFocusChangedArgs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl EventArgs for ReturnFocusChangedArgs

impl StructuralPartialEq for ReturnFocusChangedArgs