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:

                _dom_event_get_bubbles((dom_event *) (e), \
                (bool *) (b))

dom_event_get_cancelable

#define dom_event_get_cancelable	(		e,
			c
	)

Value:

                _dom_event_get_cancelable(\
                (dom_event *) (e), (bool *) (c))

dom_event_get_current_target

#define dom_event_get_current_target	(		e,
			c
	)

Value:

                _dom_event_get_current_target(\
                (dom_event *) (e), (dom_event_target **) (c))

dom_event_get_event_phase

#define dom_event_get_event_phase	(		e,
			p
	)

Value:

                _dom_event_get_event_phase(     \
                (dom_event *) (e), (dom_event_flow_phase *) (p))

dom_event_get_is_trusted

#define dom_event_get_is_trusted	(		e,
			r
	)

Value:

                _dom_event_get_is_trusted(      \
                (dom_event *) (e), (bool *) (r))

dom_event_get_namespace

#define dom_event_get_namespace	(		e,
			n
	)

Value:

                _dom_event_get_namespace(\
                (dom_event *) (e), (dom_string **) (n))

dom_event_get_target

#define dom_event_get_target	(		e,
			t
	)

Value:

                _dom_event_get_target((dom_event *) (e), \
                (dom_event_target **) (t))

dom_event_get_timestamp

#define dom_event_get_timestamp	(		e,
			t
	)

Value:

                _dom_event_get_timestamp(\
                (dom_event *) (e), (unsigned int *) (t))

dom_event_get_type

#define dom_event_get_type	(		e,
			t
	)

Value:

                _dom_event_get_type((dom_event *) (e), \
                (dom_string **) (t))

dom_event_in_dispatch

#define dom_event_in_dispatch	(		e,
			r
	)

Value:

                _dom_event_in_dispatch( \
                (dom_event *) (e), (bool *) (r))

dom_event_init

#define dom_event_init	(		e,
			t,
			b,
			c
	)

Value:

                _dom_event_init((dom_event *) (e), \
                (dom_string *) (t), (bool) (b), (bool) (c))

dom_event_init_ns

#define dom_event_init_ns	(		e,
			n,
			t,
			b,
			c
	)

Value:

                _dom_event_init_ns( \
                (dom_event *) (e), (dom_string *) (n), \
                (dom_string *) (t), (bool) (b), (bool) (c))

dom_event_is_custom

#define dom_event_is_custom	(		e,
			c
	)

Value:

                _dom_event_is_custom((dom_event *) (e), \
                (bool *) (c))

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_is_initialised(      \
                (dom_event *) (e), (bool *) (r))

dom_event_prevent_default

#define dom_event_prevent_default

(

e

)

Value:

                _dom_event_prevent_default(\
                (dom_event *) (e))

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_set_is_trusted(      \
                (dom_event *) (e), (bool) (t))

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_stop_propagation(\
                (dom_event *) (e))

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

enum 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

evt	The Event object
bubbles	The 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

evt	The Event object
cancelable	The 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

evt	The event object
current	The 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

evt	The Event object
phase	The 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

evt	The event object
result	Pointer 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

evt	The event object
namespace	The 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

evt	The event object
target	The 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

evt	The Event object
timestamp	The 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

evt	The 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

evt	The event object
result	Pointer 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

evt	The event object
type	The type of this event
bubble	Whether this event can bubble
cancelable	Whether 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

evt	The event object
namespace	The namespace of this event
type	The event type
bubble	Whether this event has a bubble phase
cancelable	Whether 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

evt	The event object
custom	The 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

evt	The event object
prevented	The 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

evt	The event object
result	Pointer 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

evt	The Event object

Returns

DOM_NO_ERR.

_dom_event_ref()

void _dom_event_ref

(

dom_event *

evt

)

Claim a reference on this event object

Parameters

evt	The 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

evt	The event object
trusted	Whether 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

evt	The 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

evt	The Event object

Returns

DOM_NO_ERR.

_dom_event_unref()

void _dom_event_unref

(

dom_event *

evt

)

Release a reference on this event object

Parameters

evt	The Event object