cocos2d-x  3.0Beta0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Event Class Reference

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

#include <CCEvent.h>

Inheritance diagram for Event:
Object EventAcceleration EventCustom EventKeyboard EventMouse EventTouch

Public Types

enum  Type {
  TOUCH, KEYBOARD, ACCELERATION, MOUSE,
  CUSTOM
}
 

Public Member Functions

virtual ~Event ()
 Destructor. More...
 
Type getType () const
 Gets the event type. More...
 
var getType ()
 Gets the event type. More...
 
local getType ()
 Gets the event type. More...
 
void stopPropagation ()
 Stops propagation for current event. More...
 
var stopPropagation ()
 Stops propagation for current event. More...
 
local stopPropagation ()
 Stops propagation for current event. More...
 
bool isStopped () const
 Checks whether the event has been stopped. More...
 
var isStopped ()
 Checks whether the event has been stopped. More...
 
local isStopped ()
 Checks whether the event has been stopped. More...
 
NodegetCurrentTarget ()
 Gets current target of the event. More...
 
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 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...
 
local retainCount ()
 Returns the object's current reference count. More...
 
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

 Event (Type type)
 Constructor. More...
 
void setCurrentTarget (Node *target)
 Sets current target. More...
 

Protected Attributes

Type _type
 Event type. More...
 
bool _isStopped
 whether the event has been stopped. More...
 
var _isStopped
 whether the event has been stopped. More...
 
local _isStopped
 whether the event has been stopped. More...
 
Node_currentTarget
 Current target. More...
 
var _currentTarget
 Current target. More...
 
local _currentTarget
 Current target. More...
 
- Protected Attributes inherited from Object
unsigned int _reference
 count of references More...
 
var _reference
 count of references More...
 
local _reference
 count of references More...
 
unsigned int _autoReleaseCount
 count of autorelease More...
 
var _autoReleaseCount
 count of autorelease More...
 
local _autoReleaseCount
 count of autorelease 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...
 
var _luaID
 Lua reference id. More...
 
local _luaID
 Lua reference id. More...
 

Detailed Description

Base class of all kinds of events.

Member Enumeration Documentation

enum Type
strong
Enumerator
TOUCH 
KEYBOARD 
ACCELERATION 
MOUSE 
CUSTOM 
var Type
strong
Enumerator
TOUCH 
KEYBOARD 
ACCELERATION 
MOUSE 
CUSTOM 
local Type
strong
Enumerator
TOUCH 
KEYBOARD 
ACCELERATION 
MOUSE 
CUSTOM 

Constructor & Destructor Documentation

Event ( Type  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.
Type 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.

Type _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: