Struct Sense

pub struct Sense {
    pub click: bool,
    pub drag: bool,
    pub focusable: bool,
}

What sort of interaction is a widget sensitive to?

Fields

click: bool

Buttons, sliders, windows, …

drag: bool

Sliders, windows, scroll bars, scroll areas, …

focusable: bool

This widget wants focus.

Anything interactive + labels that can be focused for the benefit of screen readers.

Implementations

impl Sense

pub fn hover() -> Self

Senses no clicks or drags. Only senses mouse hover.

pub fn focusable_noninteractive() -> Self

Senses no clicks or drags, but can be focused with the keyboard. Used for labels that can be focused for the benefit of screen readers.

pub fn click() -> Self

Sense clicks and hover, but not drags.

pub fn drag() -> Self

Sense drags and hover, but not clicks.

pub fn click_and_drag() -> Self

Sense both clicks, drags and hover (e.g. a slider or window).

Note that this will introduce a latency when dragging, because when the user starts a press egui can’t know if this is the start of a click or a drag, and it won’t know until the cursor has either moved a certain distance, or the user has released the mouse button.

See crate::PointerState::is_decidedly_dragging for details.

pub fn union(self, other: Self) -> Self

The logical “or” of two Senses.

pub fn interactive(&self) -> bool

Returns true if we sense either clicks or drags.

Trait Implementations

impl BitOr for Sense

type Output = Sense

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitOrAssign for Sense

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for Sense

fn clone(&self) -> Sense

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sense

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

Formats the value using the given formatter.

impl PartialEq for Sense

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

impl Eq for Sense

impl StructuralPartialEq for Sense