EventListenerCustom Class Reference

Usage: auto dispatcher = Director::getInstance()->getEventDispatcher(); Adds a listener: More...

#include <CCEventListenerCustom.h>

Inheritance diagram for EventListenerCustom:

Public Member Functions
virtual bool	checkAvailable () override
	Overrides. More...
virtual EventListenerCustom *	clone () override
	Clones the listener, its subclasses have to override this method. More...
Public Member Functions inherited from EventListener
virtual	~EventListener ()
	Destructor. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Release the ownership immediately. More...
Ref *	autorelease ()
	Release the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()

Static Public Member Functions
static EventListenerCustom *	create (const std::string &eventName, const std::function< void(EventCustom *)> &callback)
	Creates an event listener with type and callback. More...
local	create ( local eventName, local callback)
	Creates an event listener with type and callback. More...

Protected Member Functions
	EventListenerCustom ()
	Constructor. More...
bool	init (const ListenerID &listenerId, const std::function< void(EventCustom *)> &callback)
	Initializes event with type and callback function. More...
Protected Member Functions inherited from EventListener
	EventListener ()
	Constructor. More...
bool	init (Type t, const ListenerID &listenerID, const std::function< void(Event *)> &callback)
	Initializes event with type and callback function. More...
void	setPaused (bool paused)
bool	isPaused () const
void	setRegistered (bool registered)
bool	isRegistered () const
Type	getType () const
const ListenerID &	getListenerID () const
var	getListenerID ()
local	getListenerID ()
void	setFixedPriority (int fixedPriority)
var	setFixedPriority ( var fixedPriority)
local	setFixedPriority ( local fixedPriority)
int	getFixedPriority () const
void	setSceneGraphPriority (Node *node)
Node *	getSceneGraphPriority () const
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes
std::function< void(EventCustom *)>	_onCustomEvent
var	_onCustomEvent
local	_onCustomEvent
Protected Attributes inherited from EventListener
std::function< void(Event *)>	_onEvent
var	_onEvent
local	_onEvent
Type	_type
	Event callback function. More...
var	_type
	Event callback function. More...
local	_type
	Event callback function. More...
ListenerID	_listenerID
	Event listener type. More...
var	_listenerID
	Event listener type. More...
local	_listenerID
	Event listener type. More...
bool	_isRegistered
	Event listener ID. More...
var	_isRegistered
	Event listener ID. More...
local	_isRegistered
	Event listener ID. More...
int	_fixedPriority
	Whether the listener has been added to dispatcher. More...
Node *	_node
bool	_paused
var	_paused
local	_paused
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Friends
class	LuaEventListenerCustom

Additional Inherited Members
Public Types inherited from EventListener
enum	Type {   UNKNOWN, TOUCH_ONE_BY_ONE, TOUCH_ALL_AT_ONCE, KEYBOARD,   MOUSE, ACCELERATION, CUSTOM }
typedef std::string	ListenerID

Detailed Description

Usage: auto dispatcher = Director::getInstance()->getEventDispatcher(); Adds a listener:

auto callback = [](EventCustom* event){ do_some_thing(); }; auto listener = EventListenerCustom::create(callback); dispatcher->addEventListenerWithSceneGraphPriority(listener, one_node);

Dispatchs a custom event:

EventCustom event("your_event_type"); dispatcher->dispatchEvent(&event);

Removes a listener

dispatcher->removeEventListener(listener);

Constructor & Destructor Documentation

EventListenerCustom ( )

protected

Constructor.

var EventListenerCustom ( )

protected

Constructor.

local EventListenerCustom ( )

protected

Constructor.

Member Function Documentation

virtual bool checkAvailable ( )

overridevirtual

Overrides.

Implements EventListener.

var checkAvailable ( )

overridevirtual

Overrides.

Implements EventListener.

local checkAvailable ( )

overridevirtual

Overrides.

Implements EventListener.

virtual EventListenerCustom* clone ( )

overridevirtual

Clones the listener, its subclasses have to override this method.

Implements EventListener.

var clone ( )

overridevirtual

Clones the listener, its subclasses have to override this method.

Implements EventListener.

local clone ( )

overridevirtual

Clones the listener, its subclasses have to override this method.

Implements EventListener.

static EventListenerCustom* create ( const std::string &  eventName, const std::function< void(EventCustom *)> &  callback  )

static

Creates an event listener with type and callback.

Parameters

eventType	The type of the event.
callback	The callback function when the specified event was emitted.

var create ( var  eventName, var  callback  )

static

Creates an event listener with type and callback.

Parameters

eventType	The type of the event.
callback	The callback function when the specified event was emitted.

local create ( local  eventName, local  callback  )

static

Creates an event listener with type and callback.

Parameters

eventType	The type of the event.
callback	The callback function when the specified event was emitted.

bool init ( const ListenerID &  listenerId, const std::function< void(EventCustom *)> &  callback  )

protected

Initializes event with type and callback function.

var init ( var  listenerId, var  callback  )

protected

Initializes event with type and callback function.

local init ( local  listenerId, local  callback  )

protected

Initializes event with type and callback function.

Friends And Related Function Documentation

friend class LuaEventListenerCustom

friend

var LuaEventListenerCustom

friend

local LuaEventListenerCustom

friend

Member Data Documentation

std::function<void(EventCustom*)> _onCustomEvent

protected

var _onCustomEvent

protected

local _onCustomEvent

protected

---

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

• /Users/cocos2d/MyWork/cocos2d-x-develop/cocos/2d/CCEventListenerCustom.h