dispatch.h File Reference

#include <dom/core/document.h>
#include <dom/events/event.h>
#include <dom/events/mutation_event.h>

Go to the source code of this file.

Macros
#define	_dom_dispatch_node_change_event(doc, et, related, change, success)
#define	_dom_dispatch_node_change_document_event(doc, et, change, success)
#define	_dom_dispatch_characterdata_modified_event(doc, et, prev, new, success)
#define	_dom_dispatch_attr_modified_event(doc, et, prev, new, related, attr_name, change, success)
#define	_dom_dispatch_subtree_modified_event(doc, et, success)

Functions
dom_exception	__dom_dispatch_node_change_event (dom_document *doc, dom_event_target *et, dom_event_target *related, dom_mutation_type change, bool *success)
dom_exception	__dom_dispatch_node_change_document_event (dom_document *doc, dom_event_target *et, dom_mutation_type change, bool *success)
dom_exception	__dom_dispatch_characterdata_modified_event (dom_document *doc, dom_event_target *et, dom_string *prev, dom_string *new, bool *success)
dom_exception	__dom_dispatch_attr_modified_event (dom_document *doc, dom_event_target *et, dom_string *prev, dom_string *new, dom_event_target *related, dom_string *attr_name, dom_mutation_type change, bool *success)
dom_exception	__dom_dispatch_subtree_modified_event (dom_document *doc, dom_event_target *et, bool *success)
dom_exception	_dom_dispatch_generic_event (dom_document *doc, dom_event_target *et, dom_string *event_name, bool bubble, bool cancelable, bool *success)

Macro Definition Documentation

_dom_dispatch_attr_modified_event

#define _dom_dispatch_attr_modified_event	(		doc,
			et,
			prev,
			new,
			related,
			attr_name,
			change,
			success
	)

Value:

        __dom_dispatch_attr_modified_event((dom_document *) (doc), \
                        (dom_event_target *) (et), \
                        (dom_string *) (prev), \
                        (dom_string *) (new), \
                        (dom_event_target *) (related), \
                        (dom_string *) (attr_name), \
                        (dom_mutation_type) (change), \
                        (bool *) (success))

_dom_dispatch_characterdata_modified_event

#define _dom_dispatch_characterdata_modified_event	(		doc,
			et,
			prev,
			new,
			success
	)

Value:

        __dom_dispatch_characterdata_modified_event((dom_document *) (doc), \
                        (dom_event_target *) (et), \
                        (dom_string *) (prev), \
                        (dom_string *) (new), \
                        (bool *) (success))

_dom_dispatch_node_change_document_event

#define _dom_dispatch_node_change_document_event	(		doc,
			et,
			change,
			success
	)

Value:

        __dom_dispatch_node_change_document_event((dom_document *) (doc), \
                        (dom_event_target *) (et), \
                        (dom_mutation_type) (change), \
                        (bool *) (success))

_dom_dispatch_node_change_event

#define _dom_dispatch_node_change_event	(		doc,
			et,
			related,
			change,
			success
	)

Value:

        __dom_dispatch_node_change_event((dom_document *) (doc), \
                        (dom_event_target *) (et), \
                        (dom_event_target *) (related), \
                        (dom_mutation_type) (change), \
                        (bool *) (success))

_dom_dispatch_subtree_modified_event

#define _dom_dispatch_subtree_modified_event	(		doc,
			et,
			success
	)

Value:

        __dom_dispatch_subtree_modified_event((dom_document *) (doc), \
                        (dom_event_target *) (et), \
                        (bool *) (success))

Function Documentation

__dom_dispatch_attr_modified_event()

dom_exception __dom_dispatch_attr_modified_event	(	dom_document *	doc,
		dom_event_target *	et,
		dom_string *	prev,
		dom_string *	new,
		dom_event_target *	related,
		dom_string *	attr_name,
		dom_mutation_type	change,
		bool *	success
	)

Dispatch a DOMAttrModified event

Parameters

doc	The Document object
et	The EventTarget
prev	The previous value before change
new	The new value after change
related	The related EventTarget
attr_name	The Attribute name
change	How this attribute change
success	Whether this event's default handler get called

Returns

DOM_NO_ERR on success, appropirate dom_exception on failure.

__dom_dispatch_characterdata_modified_event()

dom_exception __dom_dispatch_characterdata_modified_event	(	dom_document *	doc,
		dom_event_target *	et,
		dom_string *	prev,
		dom_string *	new,
		bool *	success
	)

Dispatch a DOMCharacterDataModified event

Parameters

et	The EventTarget object
prev	The preValue of the DOMCharacterData
new	The newValue of the DOMCharacterData
success	Whether this event's default handler get called

Returns

DOM_NO_ERR on success, appropirate dom_exception on failure.

TODO: The character_data object may be a part of a Attr node, if so, another DOMAttrModified event should be dispatched, too. But for now, we did not support any XML feature, so just leave it as this.

__dom_dispatch_node_change_document_event()

dom_exception __dom_dispatch_node_change_document_event	(	dom_document *	doc,
		dom_event_target *	et,
		dom_mutation_type	change,
		bool *	success
	)

Dispatch a DOMNodeInsertedIntoDocument/DOMNodeRemovedFromDocument event

Parameters

doc	The document object
et	The EventTarget object
type	"DOMNodeInserted" or "DOMNodeRemoved"
success	Whether this event's default action get called

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

__dom_dispatch_node_change_event()

dom_exception __dom_dispatch_node_change_event	(	dom_document *	doc,
		dom_event_target *	et,
		dom_event_target *	related,
		dom_mutation_type	change,
		bool *	success
	)

Dispatch a DOMNodeInserted/DOMNodeRemoved event

Parameters

doc	The document object
et	The EventTarget object
type	"DOMNodeInserted" or "DOMNodeRemoved"
related	The parent of the removed/inserted node
success	Whether this event's default action get called

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

__dom_dispatch_subtree_modified_event()

dom_exception __dom_dispatch_subtree_modified_event	(	dom_document *	doc,
		dom_event_target *	et,
		bool *	success
	)

Dispatch a DOMSubtreeModified event

Parameters

doc	The Document
et	The EventTarget object
success	Whether this event's default handler get called

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

_dom_dispatch_generic_event()

dom_exception _dom_dispatch_generic_event	(	dom_document *	doc,
		dom_event_target *	et,
		dom_string *	event_name,
		bool	bubble,
		bool	cancelable,
		bool *	success
	)

Dispatch a generic event

Parameters

doc	The Document
et	The EventTarget object
name	The name of the event
len	The length of the name string
bubble	Whether this event bubbles
cancelable	Whether this event can be cancelable
success	Whether this event's default handler get called

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.