event_target.h File Reference

#include <dom/core/document.h>
#include <dom/events/event.h>
#include <dom/events/mutation_event.h>
#include <dom/events/event_target.h>
#include <dom/events/event_listener.h>
#include "events/dispatch.h"
#include "utils/list.h"

Go to the source code of this file.

Classes
struct	listener_entry
struct	dom_event_target_internal
struct	dom_event_target_entry

Typedefs
typedef struct dom_event_target_internal	dom_event_target_internal
typedef struct dom_event_target_entry	dom_event_target_entry

Functions
dom_exception	_dom_event_target_internal_initialise (dom_event_target_internal *eti)
void	_dom_event_target_internal_finalise (dom_event_target_internal *eti)
dom_exception	_dom_event_target_add_event_listener (dom_event_target_internal *eti, dom_string *type, struct dom_event_listener *listener, bool capture)
dom_exception	_dom_event_target_remove_event_listener (dom_event_target_internal *eti, dom_string *type, struct dom_event_listener *listener, bool capture)
dom_exception	_dom_event_target_add_event_listener_ns (dom_event_target_internal *eti, dom_string *namespace, dom_string *type, struct dom_event_listener *listener, bool capture)
dom_exception	_dom_event_target_remove_event_listener_ns (dom_event_target_internal *eti, dom_string *namespace, dom_string *type, struct dom_event_listener *listener, bool capture)
dom_exception	_dom_event_target_dispatch (dom_event_target *et, dom_event_target_internal *eti, struct dom_event *evt, dom_event_flow_phase phase, bool *success)

Typedef Documentation

dom_event_target_entry

typedef struct dom_event_target_entry dom_event_target_entry

dom_event_target_internal

typedef struct dom_event_target_internal dom_event_target_internal

Function Documentation

_dom_event_target_add_event_listener()

dom_exception _dom_event_target_add_event_listener	(	dom_event_target_internal *	eti,
		dom_string *	type,
		struct dom_event_listener *	listener,
		bool	capture
	)

Add an EventListener to the EventTarget

Parameters

et	The EventTarget object
type	The event type which this event listener listens for
listener	The event listener object
capture	Whether add this listener in the capturing phase

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

_dom_event_target_add_event_listener_ns()

dom_exception _dom_event_target_add_event_listener_ns	(	dom_event_target_internal *	eti,
		dom_string *	namespace,
		dom_string *	type,
		struct dom_event_listener *	listener,
		bool	capture
	)

Add an EventListener

Parameters

et	The EventTarget object
namespace	The namespace of this listener
type	The event type which this event listener listens for
listener	The event listener object
capture	Whether add this listener in the capturing phase

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

We don't support this API now, so it always return DOM_NOT_SUPPORTED_ERR.

_dom_event_target_dispatch()

dom_exception _dom_event_target_dispatch	(	dom_event_target *	et,
		dom_event_target_internal *	eti,
		struct dom_event *	evt,
		dom_event_flow_phase	phase,
		bool *	success
	)

Dispatch an event on certain EventTarget

Parameters

et	The EventTarget object
eti	Internal EventTarget object
evt	The event object
success	Indicates whether any of the listeners which handled the event called Event.preventDefault(). If Event.preventDefault() was called the returned value is false, else it is true.

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

_dom_event_target_internal_finalise()

void _dom_event_target_internal_finalise

(

dom_event_target_internal *

eti

)

_dom_event_target_internal_initialise()

dom_exception _dom_event_target_internal_initialise

(

dom_event_target_internal *

eti

)

Constructor and destructor: Since this object is not intended to be allocated alone, it should be embedded into the Node object, there is no constructor and destructor for it.

_dom_event_target_remove_event_listener()

dom_exception _dom_event_target_remove_event_listener	(	dom_event_target_internal *	eti,
		dom_string *	type,
		struct dom_event_listener *	listener,
		bool	capture
	)

Remove an EventListener from the EventTarget

(LibDOM extension: If type is NULL, remove all listener registrations regardless of type and cature)

Parameters

et	The EventTarget object
type	The event type this listener is registered for
listener	The listener object
capture	Whether the listener is registered at the capturing phase

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

_dom_event_target_remove_event_listener_ns()

dom_exception _dom_event_target_remove_event_listener_ns	(	dom_event_target_internal *	eti,
		dom_string *	namespace,
		dom_string *	type,
		struct dom_event_listener *	listener,
		bool	capture
	)

Remove an EventListener

Parameters

et	The EventTarget object
namespace	The namespace of this listener
type	The event type which this event listener listens for
listener	The event listener object
capture	Whether add this listener in the capturing phase

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

We don't support this API now, so it always return DOM_NOT_SUPPORTED_ERR.