Struct FocusRequest

pub struct FocusRequest {
    pub target: FocusTarget,
    pub highlight: bool,
    pub force_window_focus: bool,
    pub window_indicator: Option<FocusIndicator>,
}

Focus change request.

See FOCUS for details.

Fields

target: FocusTarget

Where to move the focus.

highlight: bool

If the widget should visually indicate that it has keyboard focus.

force_window_focus: bool

If the window should be focused even if another app has focus. By default the window is only focused if the app has keyboard focus in any of the open windows, if this is enabled a WINDOWS.focus request is always made, potentially stealing keyboard focus from another app and disrupting the user.

window_indicator: Option<FocusIndicator>

Focus indicator to set on the target window if the app does not have keyboard focus and force_window_focus is disabled.

The focus_indicator of the window is set and the request is processed after the window receives focus, or it is canceled if another focus request is made.

Implementations

impl FocusRequest

pub fn new(target: FocusTarget, highlight: bool) -> Self

New request from target and highlight.

pub fn direct(widget_id: WidgetId, highlight: bool) -> Self

New FocusTarget::Direct request.

pub fn direct_or_exit( widget_id: WidgetId, navigation_origin: bool, highlight: bool, ) -> Self

New FocusTarget::DirectOrExit request.

pub fn direct_or_enter( widget_id: WidgetId, navigation_origin: bool, highlight: bool, ) -> Self

New FocusTarget::DirectOrEnter request.

pub fn direct_or_related( widget_id: WidgetId, navigation_origin: bool, highlight: bool, ) -> Self

New FocusTarget::DirectOrRelated request.

pub fn enter(highlight: bool) -> Self

New FocusTarget::Enter request.

pub fn exit(highlight: bool) -> Self

New FocusTarget::Exit request.

pub fn next(highlight: bool) -> Self

New FocusTarget::Next request.

pub fn prev(highlight: bool) -> Self

New FocusTarget::Prev request.

pub fn up(highlight: bool) -> Self

New FocusTarget::Up request.

pub fn right(highlight: bool) -> Self

New FocusTarget::Right request.

pub fn down(highlight: bool) -> Self

New FocusTarget::Down request.

pub fn left(highlight: bool) -> Self

New FocusTarget::Left request.

pub fn alt(highlight: bool) -> Self

New FocusTarget::Alt request.

pub fn with_force_window_focus(self) -> Self

Sets FocusRequest::force_window_focus to true.

pub fn with_indicator(self, indicator: FocusIndicator) -> Self

Sets the FocusRequest::window_indicator.

Trait Implementations

impl Clone for FocusRequest

fn clone(&self) -> FocusRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FocusRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FocusRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FocusRequest

fn eq(&self, other: &FocusRequest) -> 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 Serialize for FocusRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FocusRequest

impl Eq for FocusRequest

impl StructuralPartialEq for FocusRequest