Event Class Reference

Base class of all kinds of events. More...

#include <CCEvent.h>

Inheritance diagram for Event:

Public Member Functions
virtual	~Event ()
	Destructor. More...
const std::string &	getType () const
	Gets the event type. More...
void	stopPropagation ()
	Stops propagation for current event. More...
bool	isStopped () const
	Checks whether the event has been stopped. More...
Node *	getCurrentTarget ()
	Gets current target of the event. More...

Protected Member Functions
	Event (const std::string &type)
	Constructor. More...
void	setCurrentTarget (Node *target)
	Sets current target. More...

Protected Attributes
std::string	_type
	Event type. More...
bool	_isStopped
	whether the event has been stopped. More...
Node *	_currentTarget
	Current target. More...
var	_currentTarget
	Current target. More...
local	_currentTarget
	Current target. More...

Friends
class	EventDispatcher

Detailed Description

Base class of all kinds of events.

Constructor & Destructor Documentation

Event ( const std::string &  type)

protected

Constructor.

var Event ( var  type)

protected

Constructor.

local Event ( local  type)

protected

Constructor.

virtual ~Event ( )

virtual

Destructor.

var ~Event ( )

virtual

Destructor.

local ~Event ( )

virtual

Destructor.

Member Function Documentation

Node* getCurrentTarget ( )

inline

Gets current target of the event.

Returns

The target with which the event associates.

Note

It onlys be available when the event listener is associated with node. It returns 0 when the listener is associated with fixed priority.

var getCurrentTarget ( )

inline

Gets current target of the event.

Returns

The target with which the event associates.

Note

It onlys be available when the event listener is associated with node. It returns 0 when the listener is associated with fixed priority.

local getCurrentTarget ( )

inline

Gets current target of the event.

Returns

The target with which the event associates.

Note

It onlys be available when the event listener is associated with node. It returns 0 when the listener is associated with fixed priority.

const std::string& getType ( ) const

inline

Gets the event type.

var getType ( )

inline

Gets the event type.

local getType ( )

inline

Gets the event type.

bool isStopped ( ) const

inline

Checks whether the event has been stopped.

var isStopped ( )

inline

Checks whether the event has been stopped.

local isStopped ( )

inline

Checks whether the event has been stopped.

void setCurrentTarget ( Node *  target)

inlineprotected

Sets current target.

var setCurrentTarget ( var  target)

inlineprotected

Sets current target.

local setCurrentTarget ( local  target)

inlineprotected

Sets current target.

void stopPropagation ( )

inline

Stops propagation for current event.

var stopPropagation ( )

inline

Stops propagation for current event.

local stopPropagation ( )

inline

Stops propagation for current event.

Friends And Related Function Documentation

friend class EventDispatcher

friend

var EventDispatcher

friend

local EventDispatcher

friend

Member Data Documentation

Node* _currentTarget

protected

Current target.

var _currentTarget

protected

Current target.

local _currentTarget

protected

Current target.

bool _isStopped

protected

whether the event has been stopped.

var _isStopped

protected

whether the event has been stopped.

local _isStopped

protected

whether the event has been stopped.

std::string _type

protected

Event type.

var _type

protected

Event type.

local _type

protected

Event type.

---

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

• /Users/cocos2d/MyWork/cocos2d-x-develop/cocos2dx/event_dispatcher/CCEvent.h