ui_event.h File Reference

#include <stdbool.h>
#include <dom/core/exceptions.h>
#include <dom/core/string.h>

Include dependency graph for ui_event.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	dom_ui_event_get_view(e, v)
#define	dom_ui_event_get_detail(e, d)
#define	dom_ui_event_init(e, t, b, c, v, d)
#define	dom_ui_event_init_ns(e, n, t, b, c, v, d)

Typedefs
typedef struct dom_ui_event	dom_ui_event

Functions
dom_exception	_dom_ui_event_get_view (dom_ui_event *evt, struct dom_abstract_view **view)
dom_exception	_dom_ui_event_get_detail (dom_ui_event *evt, int32_t *detail)
dom_exception	_dom_ui_event_init (dom_ui_event *evt, dom_string *type, bool bubble, bool cancelable, struct dom_abstract_view *view, int32_t detail)
dom_exception	_dom_ui_event_init_ns (dom_ui_event *evt, dom_string *namespace, dom_string *type, bool bubble, bool cancelable, struct dom_abstract_view *view, int32_t detail)

Macro Definition Documentation

dom_ui_event_get_detail

#define dom_ui_event_get_detail	(		e,
			d
	)

Value:

        _dom_ui_event_get_detail(\
        (dom_ui_event *) (e), (int32_t *) (d))

dom_ui_event_get_view

#define dom_ui_event_get_view	(		e,
			v
	)

Value:

        _dom_ui_event_get_view( \
        (dom_ui_event *) (e), (struct dom_abstract_view **) (v))

dom_ui_event_init

#define dom_ui_event_init	(		e,
			t,
			b,
			c,
			v,
			d
	)

Value:

        _dom_ui_event_init( \
        (dom_ui_event *) (e), (dom_string *) (t), (bool) (b), \
        (bool) (c), (struct dom_abstract_view *) (v), (int32_t) (d))

dom_ui_event_init_ns

#define dom_ui_event_init_ns	(		e,
			n,
			t,
			b,
			c,
			v,
			d
	)

Value:

        _dom_ui_event_init_ns( \
        (dom_ui_event *) (e), (dom_string *) (n), \
        (dom_string *) (t), (bool) (b), (bool) (c), \
        (struct dom_abstract_view *) (v), (int32_t) (d))

Typedef Documentation

dom_ui_event

typedef struct dom_ui_event dom_ui_event

Function Documentation

_dom_ui_event_get_detail()

dom_exception _dom_ui_event_get_detail	(	dom_ui_event *	evt,
		int32_t *	detail
	)

Get the detail param of this event

Parameters

evt	The Event object
detail	The detail object

Returns

DOM_NO_ERR.

_dom_ui_event_get_view()

dom_exception _dom_ui_event_get_view	(	dom_ui_event *	evt,
		struct dom_abstract_view **	view
	)

Get the AbstractView inside this event

Parameters

evt	The Event object
view	The returned AbstractView

Returns

DOM_NO_ERR.

_dom_ui_event_init()

dom_exception _dom_ui_event_init	(	dom_ui_event *	evt,
		dom_string *	type,
		bool	bubble,
		bool	cancelable,
		struct dom_abstract_view *	view,
		int32_t	detail
	)

Initialise the UIEvent

Parameters

evt	The Event object
type	The type of this UIEvent
bubble	Whether this event can bubble
cancelable	Whether this event is cancelable
view	The AbstractView of this UIEvent
detail	The detail object

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.

_dom_ui_event_init_ns()

dom_exception _dom_ui_event_init_ns	(	dom_ui_event *	evt,
		dom_string *	namespace,
		dom_string *	type,
		bool	bubble,
		bool	cancelable,
		struct dom_abstract_view *	view,
		int32_t	detail
	)

Initialise the UIEvent with namespace

Parameters

evt	The Event object
namespace	The namespace of this Event
type	The type of this UIEvent
bubble	Whether this event can bubble
cancelable	Whether this event is cancelable
view	The AbstractView of this UIEvent
detail	The detail object

Returns

DOM_NO_ERR on success, appropriate dom_exception on failure.