dioxus_html/events/
wheel.rs

1use dioxus_core::Event;
2use keyboard_types::Modifiers;
3use std::fmt::Formatter;
4
5use crate::{geometry::*, InteractionLocation, ModifiersInteraction, PointerInteraction};
6use crate::{
7    input_data::{MouseButton, MouseButtonSet},
8    InteractionElementOffset,
9};
10
11use super::HasMouseData;
12
13/// A synthetic event that wraps a web-style
14/// [`WheelEvent`](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent)
15pub type WheelEvent = Event<WheelData>;
16
17/// Data associated with a [WheelEvent]
18pub struct WheelData {
19    inner: Box<dyn HasWheelData>,
20}
21
22impl<E: HasWheelData> From<E> for WheelData {
23    fn from(e: E) -> Self {
24        Self { inner: Box::new(e) }
25    }
26}
27
28impl std::fmt::Debug for WheelData {
29    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
30        f.debug_struct("WheelData")
31            .field("delta", &self.delta())
32            .field("coordinates", &self.coordinates())
33            .field("modifiers", &self.modifiers())
34            .field("held_buttons", &self.held_buttons())
35            .field("trigger_button", &self.trigger_button())
36            .finish()
37    }
38}
39
40impl PartialEq for WheelData {
41    fn eq(&self, other: &Self) -> bool {
42        self.inner.delta() == other.inner.delta()
43    }
44}
45
46impl WheelData {
47    pub fn new(inner: impl HasWheelData + 'static) -> Self {
48        Self {
49            inner: Box::new(inner),
50        }
51    }
52
53    /// The amount of wheel movement
54    #[allow(deprecated)]
55    pub fn delta(&self) -> WheelDelta {
56        self.inner.delta()
57    }
58
59    /// Downcast this event to a concrete event type
60    #[inline(always)]
61    pub fn downcast<T: 'static>(&self) -> Option<&T> {
62        HasWheelData::as_any(&*self.inner).downcast_ref::<T>()
63    }
64}
65
66impl InteractionLocation for WheelData {
67    fn client_coordinates(&self) -> ClientPoint {
68        self.inner.client_coordinates()
69    }
70
71    fn page_coordinates(&self) -> PagePoint {
72        self.inner.page_coordinates()
73    }
74
75    fn screen_coordinates(&self) -> ScreenPoint {
76        self.inner.screen_coordinates()
77    }
78}
79
80impl InteractionElementOffset for WheelData {
81    fn element_coordinates(&self) -> ElementPoint {
82        self.inner.element_coordinates()
83    }
84
85    fn coordinates(&self) -> Coordinates {
86        self.inner.coordinates()
87    }
88}
89
90impl ModifiersInteraction for WheelData {
91    fn modifiers(&self) -> Modifiers {
92        self.inner.modifiers()
93    }
94}
95
96impl PointerInteraction for WheelData {
97    fn held_buttons(&self) -> MouseButtonSet {
98        self.inner.held_buttons()
99    }
100
101    // todo the following is kind of bad; should we just return None when the trigger_button is unreliable (and frankly irrelevant)? i guess we would need the event_type here
102    fn trigger_button(&self) -> Option<MouseButton> {
103        self.inner.trigger_button()
104    }
105}
106
107#[cfg(feature = "serialize")]
108/// A serialized version of WheelData
109#[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq, Clone)]
110pub struct SerializedWheelData {
111    #[serde(flatten)]
112    pub mouse: crate::point_interaction::SerializedPointInteraction,
113
114    pub delta_mode: u32,
115    pub delta_x: f64,
116    pub delta_y: f64,
117    pub delta_z: f64,
118}
119
120#[cfg(feature = "serialize")]
121impl SerializedWheelData {
122    /// Create a new SerializedWheelData
123    pub fn new(wheel: &WheelData) -> Self {
124        let delta_mode = match wheel.delta() {
125            WheelDelta::Pixels(_) => 0,
126            WheelDelta::Lines(_) => 1,
127            WheelDelta::Pages(_) => 2,
128        };
129        let delta_raw = wheel.delta().strip_units();
130        Self {
131            mouse: crate::point_interaction::SerializedPointInteraction::from(wheel),
132            delta_mode,
133            delta_x: delta_raw.x,
134            delta_y: delta_raw.y,
135            delta_z: delta_raw.z,
136        }
137    }
138}
139
140#[cfg(feature = "serialize")]
141impl From<&WheelData> for SerializedWheelData {
142    fn from(data: &WheelData) -> Self {
143        Self::new(data)
144    }
145}
146
147#[cfg(feature = "serialize")]
148impl HasWheelData for SerializedWheelData {
149    fn delta(&self) -> WheelDelta {
150        WheelDelta::from_web_attributes(self.delta_mode, self.delta_x, self.delta_y, self.delta_z)
151    }
152
153    fn as_any(&self) -> &dyn std::any::Any {
154        self
155    }
156}
157
158#[cfg(feature = "serialize")]
159impl HasMouseData for SerializedWheelData {
160    fn as_any(&self) -> &dyn std::any::Any {
161        self
162    }
163}
164
165#[cfg(feature = "serialize")]
166impl InteractionLocation for SerializedWheelData {
167    fn client_coordinates(&self) -> ClientPoint {
168        self.mouse.client_coordinates()
169    }
170
171    fn page_coordinates(&self) -> PagePoint {
172        self.mouse.page_coordinates()
173    }
174
175    fn screen_coordinates(&self) -> ScreenPoint {
176        self.mouse.screen_coordinates()
177    }
178}
179
180#[cfg(feature = "serialize")]
181impl InteractionElementOffset for SerializedWheelData {
182    fn element_coordinates(&self) -> ElementPoint {
183        self.mouse.element_coordinates()
184    }
185
186    fn coordinates(&self) -> Coordinates {
187        self.mouse.coordinates()
188    }
189}
190
191#[cfg(feature = "serialize")]
192impl ModifiersInteraction for SerializedWheelData {
193    fn modifiers(&self) -> Modifiers {
194        self.mouse.modifiers()
195    }
196}
197
198#[cfg(feature = "serialize")]
199impl PointerInteraction for SerializedWheelData {
200    fn held_buttons(&self) -> MouseButtonSet {
201        self.mouse.held_buttons()
202    }
203
204    fn trigger_button(&self) -> Option<MouseButton> {
205        self.mouse.trigger_button()
206    }
207}
208
209#[cfg(feature = "serialize")]
210impl serde::Serialize for WheelData {
211    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
212        SerializedWheelData::from(self).serialize(serializer)
213    }
214}
215
216#[cfg(feature = "serialize")]
217impl<'de> serde::Deserialize<'de> for WheelData {
218    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
219        let data = SerializedWheelData::deserialize(deserializer)?;
220        Ok(Self {
221            inner: Box::new(data),
222        })
223    }
224}
225
226impl_event![
227    WheelData;
228
229    /// Called when the mouse wheel is rotated over an element.
230    onwheel
231];
232
233pub trait HasWheelData: HasMouseData + std::any::Any {
234    /// The amount of wheel movement
235    fn delta(&self) -> WheelDelta;
236
237    /// return self as Any
238    fn as_any(&self) -> &dyn std::any::Any;
239}
dioxus_html/events/wheel.rs

dioxus_html/events/
wheel.rs
