cocos2d-x  3.4
 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:
Ref EventAcceleration EventController EventCustom EventFocus EventKeyboard EventMouse EventTouch EventAssetsManagerEx PhysicsContact

Public Types

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

Public Member Functions

virtual ~Event ()
 Destructor. More...
 
var ~Event ()
 Destructor. More...
 
local ~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...
 
NodegetCurrentTarget ()
 Gets current target of the event. More...
 
var getCurrentTarget ()
 Gets current target of the event. More...
 
local getCurrentTarget ()
 Gets current target of the event. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: Event(Type type)
var __pad0__: Event(Type type)
local __pad0__: Event(Type type)

Protected Member Functions

void setCurrentTarget (Node *target)
 Sets current target. More...
 
var setCurrentTarget ( var target)
 Sets current target. More...
 
local setCurrentTarget ( local target)
 Sets current target. More...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. 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 Ref
unsigned int _referenceCount
 count of references More...
 
var _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Friends

class EventDispatcher

Detailed Description

Base class of all kinds of events.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

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

var __pad0__
local __pad0__
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: