libdom
Loading...
Searching...
No Matches
Macros | Typedefs | Enumerations | Functions
event.h File Reference
#include <stdbool.h>
#include <dom/core/exceptions.h>
#include <dom/core/string.h>
#include <dom/events/event_target.h>

Go to the source code of this file.

Macros

#define dom_event_ref(n)   _dom_event_ref((dom_event *) (n))
 
#define dom_event_unref(n)   _dom_event_unref((dom_event *) (n))
 
#define dom_event_create(n)   _dom_event_create((dom_event **) (n))
 
#define dom_event_get_type(e, t)
 
#define dom_event_get_target(e, t)
 
#define dom_event_get_current_target(e, c)
 
#define dom_event_get_event_phase(e, p)
 
#define dom_event_get_bubbles(e, b)
 
#define dom_event_get_cancelable(e, c)
 
#define dom_event_get_timestamp(e, t)
 
#define dom_event_stop_propagation(e)
 
#define dom_event_prevent_default(e)
 
#define dom_event_init(e, t, b, c)
 
#define dom_event_get_namespace(e, n)
 
#define dom_event_is_custom(e, c)
 
#define dom_event_stop_immediate_propagation(e)    _dom_event_stop_immediate_propagation((dom_event *) (e))
 
#define dom_event_is_default_prevented(e, p)    _dom_event_is_default_prevented((dom_event *) (e), (bool *) (p))
 
#define dom_event_init_ns(e, n, t, b, c)
 
#define dom_event_in_dispatch(e, r)
 
#define dom_event_is_initialised(e, r)
 
#define dom_event_get_is_trusted(e, r)
 
#define dom_event_set_is_trusted(e, t)
 

Typedefs

typedef struct dom_event dom_event
 

Enumerations

enum  dom_event_flow_phase { DOM_CAPTURING_PHASE = 1 , DOM_AT_TARGET = 2 , DOM_BUBBLING_PHASE = 3 }
 

Functions

void _dom_event_ref (dom_event *evt)
 
void _dom_event_unref (dom_event *evt)
 
dom_exception _dom_event_create (dom_event **evt)
 
dom_exception _dom_event_get_type (dom_event *evt, dom_string **type)
 
dom_exception _dom_event_get_target (dom_event *evt, dom_event_target **target)
 
dom_exception _dom_event_get_current_target (dom_event *evt, dom_event_target **current)
 
dom_exception _dom_event_get_event_phase (dom_event *evt, dom_event_flow_phase *phase)
 
dom_exception _dom_event_get_bubbles (dom_event *evt, bool *bubbles)
 
dom_exception _dom_event_get_cancelable (dom_event *evt, bool *cancelable)
 
dom_exception _dom_event_get_timestamp (dom_event *evt, unsigned int *timestamp)
 
dom_exception _dom_event_stop_propagation (dom_event *evt)
 
dom_exception _dom_event_prevent_default (dom_event *evt)
 
dom_exception _dom_event_init (dom_event *evt, dom_string *type, bool bubble, bool cancelable)
 
dom_exception _dom_event_get_namespace (dom_event *evt, dom_string **namespace)
 
dom_exception _dom_event_is_custom (dom_event *evt, bool *custom)
 
dom_exception _dom_event_stop_immediate_propagation (dom_event *evt)
 
dom_exception _dom_event_is_default_prevented (dom_event *evt, bool *prevented)
 
dom_exception _dom_event_init_ns (dom_event *evt, dom_string *namespace, dom_string *type, bool bubble, bool cancelable)
 
dom_exception _dom_event_in_dispatch (dom_event *evt, bool *result)
 
dom_exception _dom_event_is_initialised (dom_event *evt, bool *result)
 
dom_exception _dom_event_get_is_trusted (dom_event *evt, bool *result)
 
dom_exception _dom_event_set_is_trusted (dom_event *evt, bool trusted)
 

Macro Definition Documentation

◆ dom_event_create

#define dom_event_create ( n)    _dom_event_create((dom_event **) (n))

◆ dom_event_get_bubbles

#define dom_event_get_bubbles ( e,
b )
Value:
(bool *) (b))
dom_exception _dom_event_get_bubbles(dom_event *evt, bool *bubbles)
Definition event.c:185
Definition event.h:27

◆ dom_event_get_cancelable

#define dom_event_get_cancelable ( e,
c )
Value:
(dom_event *) (e), (bool *) (c))
dom_exception _dom_event_get_cancelable(dom_event *evt, bool *cancelable)
Definition event.c:198

◆ dom_event_get_current_target

#define dom_event_get_current_target ( e,
c )
Value:
(dom_event *) (e), (dom_event_target **) (c))
dom_exception _dom_event_get_current_target(dom_event *evt, dom_event_target **current)
Definition event.c:155
Definition event_target.h:20

◆ dom_event_get_event_phase

#define dom_event_get_event_phase ( e,
p )
Value:
(dom_event *) (e), (dom_event_flow_phase *) (p))
dom_event_flow_phase
Definition event.h:16
dom_exception _dom_event_get_event_phase(dom_event *evt, dom_event_flow_phase *phase)
Definition event.c:171

◆ dom_event_get_is_trusted

#define dom_event_get_is_trusted ( e,
r )
Value:
(dom_event *) (e), (bool *) (r))
dom_exception _dom_event_get_is_trusted(dom_event *evt, bool *result)
Definition event.c:379

◆ dom_event_get_namespace

#define dom_event_get_namespace ( e,
n )
Value:
(dom_event *) (e), (dom_string **) (n))
dom_exception _dom_event_get_namespace(dom_event *evt, dom_string **namespace)
Definition event.c:271
Definition string.h:19

◆ dom_event_get_target

#define dom_event_get_target ( e,
t )
Value:
(dom_event_target **) (t))
dom_exception _dom_event_get_target(dom_event *evt, dom_event_target **target)
Definition event.c:140

◆ dom_event_get_timestamp

#define dom_event_get_timestamp ( e,
t )
Value:
(dom_event *) (e), (unsigned int *) (t))
dom_exception _dom_event_get_timestamp(dom_event *evt, unsigned int *timestamp)
Definition event.c:211

◆ dom_event_get_type

#define dom_event_get_type ( e,
t )
Value:
(dom_string **) (t))
dom_exception _dom_event_get_type(dom_event *evt, dom_string **type)
Definition event.c:126

◆ dom_event_in_dispatch

#define dom_event_in_dispatch ( e,
r )
Value:
(dom_event *) (e), (bool *) (r))
dom_exception _dom_event_in_dispatch(dom_event *evt, bool *result)
Definition event.c:351

◆ dom_event_init

#define dom_event_init ( e,
t,
b,
c )
Value:
(dom_string *) (t), (bool) (b), (bool) (c))
dom_exception _dom_event_init(dom_event *evt, dom_string *type, bool bubble, bool cancelable)
Definition event.c:251

◆ dom_event_init_ns

#define dom_event_init_ns ( e,
n,
t,
b,
c )
Value:
(dom_event *) (e), (dom_string *) (n), \
(dom_string *) (t), (bool) (b), (bool) (c))
dom_exception _dom_event_init_ns(dom_event *evt, dom_string *namespace, dom_string *type, bool bubble, bool cancelable)
Definition event.c:330

◆ dom_event_is_custom

#define dom_event_is_custom ( e,
c )
Value:
(bool *) (c))
dom_exception _dom_event_is_custom(dom_event *evt, bool *custom)
Definition event.c:286

◆ dom_event_is_default_prevented

#define dom_event_is_default_prevented ( e,
p )    _dom_event_is_default_prevented((dom_event *) (e), (bool *) (p))

◆ dom_event_is_initialised

#define dom_event_is_initialised ( e,
r )
Value:
(dom_event *) (e), (bool *) (r))
dom_exception _dom_event_is_initialised(dom_event *evt, bool *result)
Definition event.c:365

◆ dom_event_prevent_default

#define dom_event_prevent_default ( e)
Value:
(dom_event *) (e))
dom_exception _dom_event_prevent_default(dom_event *evt)
Definition event.c:236

◆ dom_event_ref

#define dom_event_ref ( n)    _dom_event_ref((dom_event *) (n))

◆ dom_event_set_is_trusted

#define dom_event_set_is_trusted ( e,
t )
Value:
(dom_event *) (e), (bool) (t))
dom_exception _dom_event_set_is_trusted(dom_event *evt, bool trusted)
Definition event.c:393

◆ dom_event_stop_immediate_propagation

#define dom_event_stop_immediate_propagation ( e)     _dom_event_stop_immediate_propagation((dom_event *) (e))

◆ dom_event_stop_propagation

#define dom_event_stop_propagation ( e)
Value:
(dom_event *) (e))
dom_exception _dom_event_stop_propagation(dom_event *evt)
Definition event.c:223

◆ dom_event_unref

#define dom_event_unref ( n)    _dom_event_unref((dom_event *) (n))

Typedef Documentation

◆ dom_event

typedef struct dom_event dom_event

Enumeration Type Documentation

◆ dom_event_flow_phase

Enumerator
DOM_CAPTURING_PHASE 
DOM_AT_TARGET 
DOM_BUBBLING_PHASE 

Function Documentation

◆ _dom_event_create()

dom_exception _dom_event_create ( dom_event ** evt)

◆ _dom_event_get_bubbles()

dom_exception _dom_event_get_bubbles ( dom_event * evt,
bool * bubbles )

Get whether this event can bubble

Parameters
evtThe Event object
bubblesThe returned value
Returns
DOM_NO_ERR.

◆ _dom_event_get_cancelable()

dom_exception _dom_event_get_cancelable ( dom_event * evt,
bool * cancelable )

Get whether this event can be cancelable

Parameters
evtThe Event object
cancelableThe returned value
Returns
DOM_NO_ERR.

◆ _dom_event_get_current_target()

dom_exception _dom_event_get_current_target ( dom_event * evt,
dom_event_target ** current )

Get the current target of this event

Parameters
evtThe event object
currentThe current event target node
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_get_event_phase()

dom_exception _dom_event_get_event_phase ( dom_event * evt,
dom_event_flow_phase * phase )

Get the current phase of this event

Parameters
evtThe Event object
phaseThe returned value
Returns
DOM_NO_ERR.

◆ _dom_event_get_is_trusted()

dom_exception _dom_event_get_is_trusted ( dom_event * evt,
bool * result )

Return whether or not the event is currently trusted.

Parameters
evtThe event object
resultPointer to result object
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_get_namespace()

dom_exception _dom_event_get_namespace ( dom_event * evt,
dom_string ** namespace )

Get the namespace of this event

Parameters
evtThe event object
namespaceThe returned namespace of this event
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_get_target()

dom_exception _dom_event_get_target ( dom_event * evt,
dom_event_target ** target )

Get the target node of this event

Parameters
evtThe event object
targetThe target node
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_get_timestamp()

dom_exception _dom_event_get_timestamp ( dom_event * evt,
unsigned int * timestamp )

Get the event's generation timestamp

Parameters
evtThe Event object
timestampThe returned value
Returns
DOM_NO_ERR.

◆ _dom_event_get_type()

dom_exception _dom_event_get_type ( dom_event * evt,
dom_string ** type )

Get the event type

Parameters
evtThe event object \parnm type The returned event type
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_in_dispatch()

dom_exception _dom_event_in_dispatch ( dom_event * evt,
bool * result )

Return whether or not the event is in dispatch currently.

Parameters
evtThe event object
resultPointer to result object
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_init()

dom_exception _dom_event_init ( dom_event * evt,
dom_string * type,
bool bubble,
bool cancelable )

Initialise the event object

Parameters
evtThe event object
typeThe type of this event
bubbleWhether this event can bubble
cancelableWhether this event is cancelable
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_init_ns()

dom_exception _dom_event_init_ns ( dom_event * evt,
dom_string * namespace,
dom_string * type,
bool bubble,
bool cancelable )

Initialise the event with namespace

Parameters
evtThe event object
namespaceThe namespace of this event
typeThe event type
bubbleWhether this event has a bubble phase
cancelableWhether this event is cancelable
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_is_custom()

dom_exception _dom_event_is_custom ( dom_event * evt,
bool * custom )

Whether this is a custom event

Parameters
evtThe event object
customThe returned value
Returns
DOM_NO_ERR.

◆ _dom_event_is_default_prevented()

dom_exception _dom_event_is_default_prevented ( dom_event * evt,
bool * prevented )

Whether the default action is prevented

Parameters
evtThe event object
preventedThe returned value
Returns
DOM_NO_ERR.

◆ _dom_event_is_initialised()

dom_exception _dom_event_is_initialised ( dom_event * evt,
bool * result )

Return whether or not the event is currently initialised.

Parameters
evtThe event object
resultPointer to result object
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_prevent_default()

dom_exception _dom_event_prevent_default ( dom_event * evt)

Prevent the default action of this event

Parameters
evtThe Event object
Returns
DOM_NO_ERR.

◆ _dom_event_ref()

void _dom_event_ref ( dom_event * evt)

Claim a reference on this event object

Parameters
evtThe Event object

◆ _dom_event_set_is_trusted()

dom_exception _dom_event_set_is_trusted ( dom_event * evt,
bool trusted )

Set whether or not the event is currently trusted.

Parameters
evtThe event object
trustedWhether or not the event is to be trusted
Returns
DOM_NO_ERR on success, appropriate dom_exception on failure.

◆ _dom_event_stop_immediate_propagation()

dom_exception _dom_event_stop_immediate_propagation ( dom_event * evt)

Stop the event propagation immediately

Parameters
evtThe event object
Returns
DOM_NO_ERR.

◆ _dom_event_stop_propagation()

dom_exception _dom_event_stop_propagation ( dom_event * evt)

Stop propagation of the event

Parameters
evtThe Event object
Returns
DOM_NO_ERR.

◆ _dom_event_unref()

void _dom_event_unref ( dom_event * evt)

Release a reference on this event object

Parameters
evtThe Event object