Struct egui::memory::Focus

pub(crate) struct Focus {
    focused_widget: Option<FocusWidget>,
    id_previous_frame: Option<Id>,
    id_next_frame: Option<Id>,
    give_to_next: bool,
    last_interested: Option<Id>,
    focus_direction: FocusDirection,
    focus_widgets_cache: IdMap<Rect>,
}

Keeps tracks of what widget has keyboard focus

Fields

focused_widget: Option<FocusWidget>

The widget with keyboard focus (i.e. a text input field).

id_previous_frame: Option<Id>

What had keyboard focus previous frame?

id_next_frame: Option<Id>

Give focus to this widget next frame

give_to_next: bool

If set, the next widget that is interested in focus will automatically get it. Probably because the user pressed Tab.

last_interested: Option<Id>

The last widget interested in focus.

focus_direction: FocusDirection

Set when looking for widget with navigational keys like arrows, tab, shift+tab

focus_widgets_cache: IdMap<Rect>

A cache of widget ids that are interested in focus with their corresponding rectangles.

Implementations

impl Focus

pub fn focused(&self) -> Option<Id>

Which widget currently has keyboard focus?

fn begin_frame(&mut self, new_input: &RawInput)

pub(crate) fn end_frame(&mut self, used_ids: &IdMap<Rect>)

pub(crate) fn had_focus_last_frame(&self, id: Id) -> bool

fn interested_in_focus(&mut self, id: Id)

fn reset_focus(&mut self)

fn find_widget_in_direction(&mut self, new_rects: &IdMap<Rect>) -> Option<Id>

Trait Implementations

impl Clone for Focus

fn clone(&self) -> Focus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Focus

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

Formats the value using the given formatter.

impl Default for Focus

fn default() -> Focus

Returns the “default value” for a type.