Enum HitboxBehavior 

pub enum HitboxBehavior {
    Normal,
    BlockMouse,
    BlockMouseExceptScroll,
}

How the hitbox affects mouse behavior.

Variants

Normal

Normal hitbox mouse behavior, doesn’t affect mouse handling for other hitboxes.

BlockMouse

All hitboxes behind this hitbox will be ignored and so will have hitbox.is_hovered() == false and hitbox.should_handle_scroll() == false. Typically for elements this causes skipping of all mouse events, hover styles, and tooltips. This flag is set by InteractiveElement::occlude.

For mouse handlers that check those hitboxes, this behaves the same as registering a bubble-phase handler for every mouse event type:

window.on_mouse_event(move |_: &EveryMouseEventTypeHere, phase, window, cx| {
    if phase == DispatchPhase::Capture && hitbox.is_hovered(window) {
        cx.stop_propagation();
    }
})

This has effects beyond event handling - any use of hitbox checking, such as hover styles and tooltips. These other behaviors are the main point of this mechanism. An alternative might be to not affect mouse event handling - but this would allow inconsistent UI where clicks and moves interact with elements that are not considered to be hovered.

BlockMouseExceptScroll

All hitboxes behind this hitbox will have hitbox.is_hovered() == false, even when hitbox.should_handle_scroll() == true. Typically for elements this causes all mouse interaction except scroll events to be ignored - see the documentation of Hitbox::is_hovered for details. This flag is set by InteractiveElement::block_mouse_except_scroll.

For mouse handlers that check those hitboxes, this behaves the same as registering a bubble-phase handler for every mouse event type except ScrollWheelEvent:

window.on_mouse_event(move |_: &EveryMouseEventTypeExceptScroll, phase, window, cx| {
    if phase == DispatchPhase::Bubble && hitbox.should_handle_scroll(window) {
        cx.stop_propagation();
    }
})

See the documentation of Hitbox::is_hovered for details of why ScrollWheelEvent is handled differently than other mouse events. If also blocking these scroll events is desired, then a cx.stop_propagation() handler like the one above can be used.

This has effects beyond event handling - this affects any use of is_hovered, such as hover styles and tooltips. These other behaviors are the main point of this mechanism. An alternative might be to not affect mouse event handling - but this would allow inconsistent UI where clicks and moves interact with elements that are not considered to be hovered.

Trait Implementations

impl Clone for HitboxBehavior

fn clone(&self) -> HitboxBehavior

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HitboxBehavior

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

Formats the value using the given formatter.

impl Default for HitboxBehavior

fn default() -> HitboxBehavior

Returns the “default value” for a type.

impl PartialEq for HitboxBehavior

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

impl Eq for HitboxBehavior

impl StructuralPartialEq for HitboxBehavior