Struct MOUSE

pub struct MOUSE;

Mouse service.

Mouse Capture

Mouse capture is integrated with touch capture in the POINTER_CAPTURE service.

Provider

This service is provided by the MouseManager extension.

Implementations

impl MOUSE

pub fn buttons(&self) -> ReadOnlyArcVar<Vec<MouseButton>>

Returns a read-only variable that tracks the buttons that are currently pressed.

pub fn multi_click_config( &self, ) -> ArcCowVar<MultiClickConfig, ArcVar<MultiClickConfig>>

Variable that defines the click-count increment time and area, a.k.a. the double-click config.

Repeated clicks with an interval less then this time and within the distance of the first click increment the click count.

The value is the same as sys_multi_click_config, if set the variable disconnects from system config.

pub fn sys_multi_click_config(&self) -> ReadOnlyArcVar<MultiClickConfig>

Variable that tracks the system click-count increment time and area, a.k.a. the double-click config.

Value Source

The value comes from the operating system settings, the variable updates with a new value if the system setting is changed and on view-process (re)init.

In headless apps the default is MultiClickConfig::default and does not change.

pub fn repeat_config(&self) -> BoxedVar<ButtonRepeatConfig>

Variable that gets and sets the config for ClickMode::repeat clicks.

Note that this variable is linked with KEYBOARD.repeat_config until it is set, so if it is never set it will update with the keyboard value.

pub fn position(&self) -> ReadOnlyArcVar<Option<MousePosition>>

Variable that gets current hovered window and cursor point over that window.

pub fn hovered(&self) -> ReadOnlyArcVar<Option<InteractionPath>>

Variable that gets the current hovered window and widgets.