ofx::DOM::EventTarget< EventTargetType > Class Template Reference

A class representing an EventTarget. More...

#include <EventTarget.h>

Public Member Functions
	EventTarget ()
	Create an EventTarget.
virtual	~EventTarget ()
	Destroy the EventTarget.
template<class EventType , typename ArgumentsType , class ListenerClass >
void	addEventListener (EventType &event, void(ListenerClass::*listenerMethod)(const void *, ArgumentsType &), bool useCapture=false, int priority=OF_EVENT_ORDER_AFTER_APP)
template<class EventType , typename ArgumentsType , class ListenerClass >
void	addEventListener (EventType &event, void(ListenerClass::*listenerMethod)(ArgumentsType &), bool useCapture=false, int priority=OF_EVENT_ORDER_AFTER_APP)
template<class EventType , typename ArgumentsType , class ListenerClass >
void	addEventListener (EventType &event, bool(ListenerClass::*listenerMethod)(const void *, ArgumentsType &), bool useCapture=false, int priority=OF_EVENT_ORDER_AFTER_APP)
template<class EventType , typename ArgumentsType , class ListenerClass >
void	addEventListener (EventType &event, bool(ListenerClass::*listenerMethod)(ArgumentsType &), bool useCapture=false, int priority=OF_EVENT_ORDER_AFTER_APP)
template<class EventType , typename ArgumentsType , class ListenerClass >
void	removeEventListener (EventType &event, void(ListenerClass::*listenerMethod)(const void *, ArgumentsType &), bool useCapture=false, int priority=OF_EVENT_ORDER_AFTER_APP)
template<class EventType , typename ArgumentsType , class ListenerClass >
void	removeEventListener (EventType &event, void(ListenerClass::*listenerMethod)(ArgumentsType &), bool useCapture=false, int priority=OF_EVENT_ORDER_AFTER_APP)
template<class EventType , typename ArgumentsType , class ListenerClass >
void	removeEventListener (EventType &event, bool(ListenerClass::*listenerMethod)(const void *, ArgumentsType &), bool useCapture=false, int priority=OF_EVENT_ORDER_AFTER_APP)
template<class EventType , typename ArgumentsType , class ListenerClass >
void	removeEventListener (EventType &event, bool(ListenerClass::*listenerMethod)(ArgumentsType &), bool useCapture=false, int priority=OF_EVENT_ORDER_AFTER_APP)
template<class EventType >
bool	dispatchEvent (EventType &event)
	Dispatch the given event. More...
template<class EventArgsType >
bool	handleEvent (EventArgsType &e)
	Handle the given event. More...
bool	hasListenersForEventType (const std::string &type) const
	Determine if the EventTarget has listeners for an event. More...
bool	isEventTypeRegistered (const std::string &type) const
	Determine if the EventTarget is registered to receive the type of events. More...
void	registerEventType (const std::string &type, BaseDOMEvent *event)
	Register a new event type by name. More...
void	unregisterEventType (const std::string &type)
	Unregister a new event type by name. More...
virtual void	onSetup ()
virtual void	onUpdate ()
virtual void	onDraw () const
virtual void	onExit ()

Public Attributes
DOMEvent< PointerUIEventArgs >	pointerOver
DOMEvent< PointerUIEventArgs >	pointerEnter
DOMEvent< PointerUIEventArgs >	pointerDown
DOMEvent< PointerUIEventArgs >	pointerMove
DOMEvent< PointerUIEventArgs >	pointerUp
DOMEvent< PointerUIEventArgs >	pointerCancel
DOMEvent< PointerUIEventArgs >	pointerOut
DOMEvent< PointerUIEventArgs >	pointerLeave
DOMEvent< PointerUIEventArgs >	pointerScroll
DOMEvent< PointerCaptureUIEventArgs >	gotPointerCapture
DOMEvent< PointerCaptureUIEventArgs >	lostPointerCapture
DOMEvent< KeyboardUIEventArgs >	keyDown
DOMEvent< KeyboardUIEventArgs >	keyUp
DOMEvent< FocusEventArgs >	blur
DOMEvent< FocusEventArgs >	focusIn
DOMEvent< FocusEventArgs >	focus
DOMEvent< FocusEventArgs >	focusOut
ofEvent< ElementEventArgs >	addedTo
ofEvent< ElementEventArgs >	removedFrom
ofEvent< ElementOrderEventArgs >	reordered
ofEvent< ElementEventArgs >	siblingAdded
ofEvent< ElementEventArgs >	siblingRemoved
ofEvent< ElementOrderEventArgs >	siblingReordered
ofEvent< ElementEventArgs >	childAdded
ofEvent< ElementEventArgs >	childRemoved
ofEvent< ElementOrderEventArgs >	childReordered
ofEvent< MoveEventArgs >	move
ofEvent< ResizeEventArgs >	resize
ofEvent< AttributeEventArgs >	attributeSet
ofEvent< AttributeEventArgs >	attributeCleared
ofEvent< EnablerEventArgs >	enabled
ofEvent< EnablerEventArgs >	locked
ofEvent< EnablerEventArgs >	hidden

Protected Attributes
std::unordered_map< std::string, BaseDOMEvent * >	_eventRegistry

Detailed Description

template<class EventTargetType>
class ofx::DOM::EventTarget< EventTargetType >

A class representing an EventTarget.

EventTargets know how to handle events. This class is usually inherited using the curiously-recurring template pattern.

Template Parameters

EventTargetType

The type of the Tvent target.

Member Function Documentation

template<class EventTargetType >

template<class EventType >

bool ofx::DOM::EventTarget< EventTargetType >::dispatchEvent

(

EventType &

event

)

Dispatch the given event.

This will return true if the default action for this event should be prevented.

Parameters

event

The Event to dispatch.

Template Parameters

EventType

The Event type to dispatch.

Returns

true iff one of the responders called Event::preventDefault().

template<class EventTargetType >

template<class EventArgsType >

bool ofx::DOM::EventTarget< EventTargetType >::handleEvent

(

EventArgsType &

e

)

Handle the given event.

This will return true if the default action for this event should be prevented.

Template Parameters

EventArgsType

The EventArgs type to dispatch.

Parameters

event

The Event to dispatch.

Returns

true if the EventTarget was registered to handle the event.

template<class EventTargetType >

bool ofx::DOM::EventTarget< EventTargetType >::hasListenersForEventType

(

const std::string &

type

)

const

Determine if the EventTarget has listeners for an event.

Parameters

event

The event name.

Returns

true if it has registered listeners for this event.

template<class EventTargetType >

bool ofx::DOM::EventTarget< EventTargetType >::isEventTypeRegistered

(

const std::string &

type

)

const

Determine if the EventTarget is registered to receive the type of events.

Parameters

type	The event type.

Returns

true if it is registered to receive the type of events.

template<class EventTargetType >

void ofx::DOM::EventTarget< EventTargetType >::registerEventType	(	const std::string &	type,
		BaseDOMEvent *	event
	)

Register a new event type by name.

Parameters

type	The event type.
event	A pointer to the DOMEvent<> that will be called.

template<class EventTargetType >

void ofx::DOM::EventTarget< EventTargetType >::unregisterEventType

(

const std::string &

type

)

Unregister a new event type by name.

Parameters

type	The event type.

---

The documentation for this class was generated from the following file:

• EventTarget.h