1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
use webcore::value::Reference; use webcore::try_from::TryInto; use webcore::reference_type::ReferenceType; use webapi::event_target::EventTarget; use webapi::window::Window; /// The `IEvent` interface represents any event which takes place in the DOM; some /// are user-generated (such as mouse or keyboard events), while others are /// generated by APIs (such as events that indicate an animation has finished /// running, a video has been paused, and so forth). There are many types of event, /// some of which use other interfaces based on the main `IEvent` interface. `IEvent` /// itself contains the properties and methods which are common to all events. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event) // https://dom.spec.whatwg.org/#event pub trait IEvent: ReferenceType { /// Indicates whether this event bubbles upward through the DOM. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event) // https://dom.spec.whatwg.org/#ref-for-dom-event-bubbles%E2%91%A0 #[inline] fn bubbles( &self ) -> bool { js!( return @{self.as_ref()}.bubbles; ).try_into().unwrap() } /// A historical alias to `Event.stopPropagation()`. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/cancelBubble) // https://dom.spec.whatwg.org/#ref-for-dom-event-cancelbubble #[inline] fn cancel_bubble( &self ) -> bool { js!( return @{self.as_ref()}.cancelBubble; ).try_into().unwrap() } /// A historical alias to `Event.stopPropagation()`. /// Setting this to `true` before returning from an event handler will stop propagation /// of the event. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/cancelBubble) // https://dom.spec.whatwg.org/#ref-for-dom-event-cancelbubble #[inline] fn set_cancel_bubble( &self, value: bool ) { js! { @(no_return) @{self.as_ref()}.cancelBubble = @{value}; } } /// Indicates whether the event is cancelable. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/cancelable) // https://dom.spec.whatwg.org/#ref-for-dom-event-cancelable #[inline] fn cancelable( &self ) -> bool { js!( return @{self.as_ref()}.cancelable; ).try_into().unwrap() } /// A reference to the currently registered target of this event. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/currentTarget) // https://dom.spec.whatwg.org/#ref-for-dom-event-currenttarget%E2%91%A0 #[inline] fn current_target( &self ) -> Option< EventTarget > { js!( return @{self.as_ref()}.currentTarget; ).try_into().ok() } /// Indicates whether `preventDefault` has been called on this event. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/defaultPrevented) // https://dom.spec.whatwg.org/#ref-for-dom-event-defaultprevented #[inline] fn default_prevented( &self ) -> bool { js!( return @{self.as_ref()}.defaultPrevented; ).try_into().unwrap() } /// Indicates which phase of event flow is currently being evaluated. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/eventPhase) // https://dom.spec.whatwg.org/#ref-for-dom-event-eventphase%E2%91%A1 fn event_phase( &self ) -> EventPhase { match js!( return @{self.as_ref()}.eventPhase; ).try_into().unwrap() { 0 => EventPhase::None, 1 => EventPhase::Capturing, 2 => EventPhase::AtTarget, 3 => EventPhase::Bubbling, _ => unreachable!("Unexpected EventPhase type"), } } /// Prevents any further listeners from being called for this event. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/stopImmediatePropagation) #[inline] fn stop_immediate_propagation( &self ) { js! { @(no_return) @{self.as_ref()}.stopImmediatePropagation(); } } /// Stops the propagation of this event to descendants in the DOM. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/stopPropagation) // https://dom.spec.whatwg.org/#ref-for-dom-event-stopimmediatepropagation #[inline] fn stop_propagation( &self ) { js! { @(no_return) @{self.as_ref()}.stopPropagation(); } } /// Returns a reference to the target to which this event was originally registered. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/target) // https://dom.spec.whatwg.org/#ref-for-dom-event-target%E2%91%A1 #[inline] fn target( &self ) -> Option< EventTarget > { js!( return @{self.as_ref()}.target; ).try_into().ok() } /// Returns the time in milliseconds at which this event was created. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/timeStamp) // https://dom.spec.whatwg.org/#ref-for-dom-event-timestamp #[inline] fn time_stamp( &self ) -> Option< f64 > { js!( return @{self.as_ref()}.timeStamp; ).try_into().ok() } /// Indicates whether the event was generated by a user action. // https://dom.spec.whatwg.org/#ref-for-dom-event-istrusted #[inline] fn is_trusted( &self ) -> bool { js!( return @{self.as_ref()}.isTrusted; ).try_into().unwrap() } /// Returns a string containing the type of event. It is set when /// the event is constructed and is the name commonly used to refer /// to the specific event. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/type) // https://dom.spec.whatwg.org/#ref-for-dom-event-type%E2%91%A1 #[inline] fn event_type( &self ) -> String { js!( return @{self.as_ref()}.type; ).try_into().unwrap() } /// Cancels the event if it is cancelable, without /// stopping further propagation of the event. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault) // https://dom.spec.whatwg.org/#ref-for-dom-event-preventdefault%E2%91%A0 #[inline] fn prevent_default( &self ) { js! { @(no_return) @{self.as_ref()}.preventDefault(); } } } /// Indicates the phase of event flow during event proessing. // https://dom.spec.whatwg.org/#dom-event-eventphase #[derive(Clone, Copy, Debug, Eq, PartialEq)] pub enum EventPhase { /// No event is currently being processed. None, /// The event is being propagated down through the target's ancestors. Capturing, /// The target is currently processing the event. AtTarget, /// The event is propagating back up through the target's ancestors. Bubbling, } /// A trait representing a concrete event type. pub trait ConcreteEvent: IEvent { /// A string representing the event type. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event/type) const EVENT_TYPE: &'static str; } /// A reference to a JavaScript object which implements the [IEvent](trait.IEvent.html) /// interface. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Event) // https://dom.spec.whatwg.org/#event #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "Event")] pub struct Event( Reference ); impl IEvent for Event {} /// The `IUiEvent` interface represents simple user interface events. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/UIEvent) // https://w3c.github.io/uievents/#uievent pub trait IUiEvent: IEvent { /// Provides the current click count for this event, if applicable. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail) // https://w3c.github.io/uievents/#dom-uievent-detail #[inline] fn detail( &self ) -> i32 { js!( return @{self.as_ref()}.detail; ).try_into().unwrap() } /// Returns the `WindowProxy` that generated the event. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/view) // https://w3c.github.io/uievents/#dom-uievent-view #[inline] fn view( &self ) -> Option< Window > { js!( return @{self.as_ref()}.view; ).try_into().ok() } } /// A reference to a JavaScript object which implements the [IUiEvent](trait.IUiEvent.html) /// interface. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/UIEvent) // https://w3c.github.io/uievents/#uievent #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "UIEvent")] #[reference(subclass_of(Event))] pub struct UiEvent( Reference ); impl IEvent for UiEvent {} impl IUiEvent for UiEvent {} #[cfg(all(test, feature = "web_test"))] mod tests { use super::*; #[test] fn test_event() { let event: Event = js!( return new Event("dummy") ).try_into().unwrap(); assert_eq!( event.event_type(), "dummy" ); assert_eq!( event.bubbles(), false ); assert!( !event.cancel_bubble() ); assert!( !event.cancelable(), false ); assert!( event.current_target().is_none() ); assert!( !event.default_prevented() ); assert_eq!( event.event_phase(), EventPhase::None ); assert!( event.target().is_none() ); assert!( event.time_stamp().is_some() ); assert!( !event.is_trusted() ); event.stop_immediate_propagation(); event.stop_propagation(); } #[test] fn test_ui_event() { use webapi::events::mouse::ClickEvent; let event: UiEvent = js!( return new UIEvent( @{ClickEvent::EVENT_TYPE}, { detail: 1, } ) ).try_into().unwrap(); assert_eq!( event.event_type(), ClickEvent::EVENT_TYPE ); assert_eq!( event.detail(), 1 ); assert!( event.view().is_none() ); } }