Loading...
Searching...
No Matches
CustomEvent
#include <Ultralight/dom/Event.h>
Overview
An event with a string payload (CustomEvent).
Get one with Event::AsCustom(). Dispatch one from native code with Element::dispatchCustomEvent().
Inheritance diagram for CustomEvent:
Public Member Functions | |
| CustomEvent (ULDOMEvent borrowed) | |
| Wrap an event handle from the C API (Event::AsCustom() is the usual way to get one). | |
| Public Member Functions inherited from Event | |
| Event (ULDOMEvent borrowed) | |
| Wrap an event handle from the C API. | |
| Event (const Event &)=delete | |
| Event & | operator= (const Event &)=delete |
| std::string | type () const |
| Get the event's type (type). | |
| unsigned | eventPhase () const |
| Get the current dispatch phase (eventPhase). | |
| bool | bubbles () const |
| Whether or not the event bubbles up the tree (bubbles). | |
| bool | cancelable () const |
| Whether or not preventDefault() can cancel the event (cancelable). | |
| bool | isTrusted () const |
| Whether or not the event came from user input or the library (isTrusted). | |
| double | timeStamp () const |
| Get the time the event was created (timeStamp). | |
| bool | defaultPrevented () const |
| Whether or not the event was canceled (defaultPrevented). | |
| void | preventDefault () const |
| Cancel the event's default action (preventDefault). | |
| void | stopPropagation () const |
| Stop the event from reaching other targets (stopPropagation). | |
| void | stopImmediatePropagation () const |
| Stop the event from reaching any other listener (stopImmediatePropagation). | |
| Element | target () const |
| Get the element the event was dispatched to (target). | |
| Node | targetNode () const |
| Get the node the event was dispatched to (target). | |
| Element | currentTarget () const |
| Get the element whose listener is running (currentTarget). | |
| MouseEvent | AsMouse () const |
| View this event as a MouseEvent. | |
| WheelEvent | AsWheel () const |
| View this event as a WheelEvent. | |
| KeyboardEvent | AsKeyboard () const |
| View this event as a KeyboardEvent. | |
| FocusEvent | AsFocus () const |
| View this event as a FocusEvent. | |
| InputEvent | AsInput () const |
| View this event as an InputEvent. | |
| SubmitEvent | AsSubmit () const |
| View this event as a SubmitEvent. | |
| CustomEvent | AsCustom () const |
| View this event as a CustomEvent. | |
| ULDOMEvent | raw () const |
| Get the C handle, for passing to the <Ultralight/CAPI/CAPI_DOMEvent.h> functions. | |
Constructor & Destructor Documentation
◆ CustomEvent()
|
inlineexplicit |
Wrap an event handle from the C API (Event::AsCustom() is the usual way to get one).
- Parameters
-
borrowed The event handle passed to a C listener callback.
The documentation for this class was generated from the following file:
- Ultralight/dom/Event.h