EventListener Class Reference

The base class of event listener. More...

#include <CCEventListener.h>

Inheritance diagram for EventListener:

Public Types
enum	Type {   UNKNOWN, TOUCH_ONE_BY_ONE, TOUCH_ALL_AT_ONCE, KEYBOARD,   MOUSE, ACCELERATION, CUSTOM }
typedef std::string	ListenerID

Public Member Functions
virtual	~EventListener ()
	Destructor. More...
virtual bool	checkAvailable ()=0
	Checks whether the listener is available. More...
var	checkAvailable ()
	Checks whether the listener is available. More...
local	checkAvailable ()
	Checks whether the listener is available. More...
virtual EventListener *	clone ()=0
	Clones the listener, its subclasses have to override this method. More...
local	clone ()
	Clones the listener, its subclasses have to override this method. More...
Public Member Functions inherited from Object
	Object ()
	Constructor. More...
virtual	~Object ()
void	release ()
	Release the ownership immediately. More...
void	retain ()
	Retains the ownership. More...
Object *	autorelease ()
	Release the ownership sometime soon automatically. More...
bool	isSingleReference () const
	Returns a boolean value that indicates whether there is only one reference to the object. More...
unsigned int	retainCount () const
	Returns the object's current reference count. More...
unsigned int	getReferenceCount () const
virtual bool	isEqual (const Object *object)
	Returns a boolean value that indicates whether this object and a given object are equal. More...
virtual void	acceptVisitor (DataVisitor &visitor)
virtual void	update (float dt)

Protected Member Functions
	EventListener ()
	Constructor. More...
bool	init (Type t, ListenerID listenerID, std::function< void(Event *)>callback)
	Initializes event with type and callback function. More...
local	init ( local t, local listenerID, local callback)
	Initializes event with type and callback function. More...
void	setPaused (bool paused)
bool	isPaused () const
void	setRegistered (bool registered)
local	setRegistered ( local 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 Attributes
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 Object
unsigned int	_referenceCount
	count of references More...

Friends
class	EventDispatcher

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID More...
int	_luaID
	Lua reference id. More...

Detailed Description

The base class of event listener.

If you need custom listener which with different callback, you need to inherit this class. For instance, you could refer to EventListenerAcceleration, EventListenerKeyboard, EventListenerTouchOneByOne, EventListenerCustom.

Member Typedef Documentation

typedef std::string ListenerID

var ListenerID

local ListenerID

Member Enumeration Documentation

enum Type

strong

Enumerator
UNKNOWN
TOUCH_ONE_BY_ONE
TOUCH_ALL_AT_ONCE
KEYBOARD
MOUSE
ACCELERATION
CUSTOM

var Type

strong

Enumerator
UNKNOWN
TOUCH_ONE_BY_ONE
TOUCH_ALL_AT_ONCE
KEYBOARD
MOUSE
ACCELERATION
CUSTOM

local Type

strong

Enumerator
UNKNOWN
TOUCH_ONE_BY_ONE
TOUCH_ALL_AT_ONCE
KEYBOARD
MOUSE
ACCELERATION
CUSTOM

Constructor & Destructor Documentation

EventListener ( )

protected

Constructor.

var EventListener ( )

protected

Constructor.

local EventListener ( )

protected

Constructor.

virtual ~EventListener ( )

virtual

Destructor.

var ~EventListener ( )

virtual

Destructor.

local ~EventListener ( )

virtual

Destructor.

Member Function Documentation

virtual bool checkAvailable ( )

pure virtual

Checks whether the listener is available.

Implemented in EventListenerTouchAllAtOnce, EventListenerCustom, EventListenerTouchOneByOne, EventListenerKeyboard, EventListenerMouse, and EventListenerAcceleration.

var checkAvailable ( )

pure virtual

Checks whether the listener is available.

Implemented in EventListenerTouchAllAtOnce, EventListenerCustom, EventListenerTouchOneByOne, EventListenerKeyboard, EventListenerMouse, and EventListenerAcceleration.

local checkAvailable ( )

pure virtual

Checks whether the listener is available.

Implemented in EventListenerTouchAllAtOnce, EventListenerCustom, EventListenerTouchOneByOne, EventListenerKeyboard, EventListenerMouse, and EventListenerAcceleration.

virtual EventListener* clone ( )

pure virtual

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

Implemented in EventListenerTouchAllAtOnce, EventListenerCustom, EventListenerTouchOneByOne, EventListenerKeyboard, EventListenerMouse, and EventListenerAcceleration.

var clone ( )

pure virtual

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

Implemented in EventListenerTouchAllAtOnce, EventListenerCustom, EventListenerTouchOneByOne, EventListenerKeyboard, EventListenerMouse, and EventListenerAcceleration.

local clone ( )

pure virtual

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

Implemented in EventListenerTouchAllAtOnce, EventListenerCustom, EventListenerTouchOneByOne, EventListenerKeyboard, EventListenerMouse, and EventListenerAcceleration.

int getFixedPriority ( ) const

inlineprotected

var getFixedPriority ( )

inlineprotected

local getFixedPriority ( )

inlineprotected

const ListenerID& getListenerID ( ) const

inlineprotected

var getListenerID ( )

inlineprotected

local getListenerID ( )

inlineprotected

Node* getSceneGraphPriority ( ) const

inlineprotected

var getSceneGraphPriority ( )

inlineprotected

local getSceneGraphPriority ( )

inlineprotected

Type getType ( ) const

inlineprotected

var getType ( )

inlineprotected

local getType ( )

inlineprotected

bool init ( Type  t, ListenerID  listenerID, std::function< void(Event *)>  callback  )

protected

Initializes event with type and callback function.

var init ( var  t, var  listenerID, var  callback  )

protected

Initializes event with type and callback function.

local init ( local  t, local  listenerID, local  callback  )

protected

Initializes event with type and callback function.

bool isPaused ( ) const

inlineprotected

var isPaused ( )

inlineprotected

local isPaused ( )

inlineprotected

bool isRegistered ( ) const

inlineprotected

var isRegistered ( )

inlineprotected

local isRegistered ( )

inlineprotected

void setFixedPriority ( int  fixedPriority)

inlineprotected

var setFixedPriority ( var  fixedPriority)

inlineprotected

local setFixedPriority ( local  fixedPriority)

inlineprotected

void setPaused ( bool  paused)

inlineprotected

var setPaused ( var  paused)

inlineprotected

local setPaused ( local  paused)

inlineprotected

void setRegistered ( bool  registered)

inlineprotected

var setRegistered ( var  registered)

inlineprotected

local setRegistered ( local  registered)

inlineprotected

void setSceneGraphPriority ( Node *  node)

inlineprotected

var setSceneGraphPriority ( var  node)

inlineprotected

local setSceneGraphPriority ( local  node)

inlineprotected

Friends And Related Function Documentation

friend class EventDispatcher

friend

var EventDispatcher

friend

local EventDispatcher

friend

Member Data Documentation

int _fixedPriority

protected

Whether the listener has been added to dispatcher.

var _fixedPriority

protected

Whether the listener has been added to dispatcher.

local _fixedPriority

protected

Whether the listener has been added to dispatcher.

bool _isRegistered

protected

Event listener ID.

var _isRegistered

protected

Event listener ID.

local _isRegistered

protected

Event listener ID.

ListenerID _listenerID

protected

Event listener type.

var _listenerID

protected

Event listener type.

local _listenerID

protected

Event listener type.

Node* _node

protected

var _node

protected

local _node

protected

std::function<void(Event*)> _onEvent

protected

var _onEvent

protected

local _onEvent

protected

bool _paused

protected

var _paused

protected

local _paused

protected

Type _type

protected

Event callback function.

var _type

protected

Event callback function.

local _type

protected

Event callback function.

---

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

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