EventListenerKeyboard Class Reference

#include <CCEventListenerKeyboard.h>

Inheritance diagram for EventListenerKeyboard:

Public Member Functions
virtual EventListenerKeyboard *	clone () override
	Overrides. More...
local	clone ()
	Overrides. More...
virtual bool	checkAvailable () override
	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...
Public Member Functions inherited from EventListener
virtual	~EventListener ()
	Destructor. More...
void	setEnabled (bool enabled)
	Enables or disables the listener. More...
local	setEnabled ( local enabled)
	Enables or disables the listener. More...
bool	isEnabled () const
	Checks whether the listener is enabled. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases 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 EventListenerKeyboard *	create ()
var	create ()
local	create ()

Public Attributes
std::function< void(EventKeyboard::KeyCode, Event *)>	onKeyPressed
std::function< void(EventKeyboard::KeyCode, Event *)>	onKeyReleased

Static Public Attributes
static const std::string	LISTENER_ID
var	LISTENER_ID
local	LISTENER_ID

Additional Inherited Members
Public Types inherited from EventListener
enum	Type {   UNKNOWN, TOUCH_ONE_BY_ONE, TOUCH_ALL_AT_ONCE, KEYBOARD,   MOUSE, ACCELERATION, FOCUS, CUSTOM }
typedef std::string	ListenerID
Protected Member Functions inherited from EventListener
	EventListener ()
	Constructor. More...
	EventListener ()
	Constructor. More...
	EventListener ()
	Constructor. More...
bool	init (Type t, const ListenerID &listenerID, const std::function< void(Event *)> &callback)
	Initializes event with type and callback function. More...
var	init ( var t, var listenerID, var 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)
	Sets paused state for the listener The paused state is only used for scene graph priority listeners. More...
bool	isPaused () const
	Checks whether the listener is paused. More...
var	isPaused ()
	Checks whether the listener is paused. More...
local	isPaused ()
	Checks whether the listener is paused. More...
void	setRegistered (bool registered)
	Marks the listener was registered by EventDispatcher. More...
var	setRegistered ( var registered)
	Marks the listener was registered by EventDispatcher. More...
local	setRegistered ( local registered)
	Marks the listener was registered by EventDispatcher. More...
bool	isRegistered () const
	Checks whether the listener was registered by EventDispatcher. More...
Type	getType () const
	Gets the type of this listener. More...
local	getType ()
	Gets the type of this listener. More...
const ListenerID &	getListenerID () const
	Gets the listener ID of this listener When event is being dispatched, listener ID is used as key for searching listeners according to event type. More...
local	getListenerID ()
	Gets the listener ID of this listener When event is being dispatched, listener ID is used as key for searching listeners according to event type. More...
void	setFixedPriority (int fixedPriority)
	Sets the fixed priority for this listener. More...
int	getFixedPriority () const
	Gets the fixed priority of this listener. More...
void	setAssociatedNode (Node *node)
	Sets the node associated with this listener. More...
Node *	getAssociatedNode () const
	Gets the node associated with this listener. More...
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
Protected Attributes inherited from EventListener
std::function< void(Event *)>	_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...
var	_fixedPriority
	Whether the listener has been added to dispatcher. More...
local	_fixedPriority
	Whether the listener has been added to dispatcher. More...
Node *	_node
var	_node
local	_node
bool	_paused
var	_paused
local	_paused
bool	_isEnabled
var	_isEnabled
local	_isEnabled
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Member Function Documentation

virtual bool checkAvailable ( )

overridevirtual

Checks whether the listener is available.

Implements EventListener.

var checkAvailable ( )

overridevirtual

Checks whether the listener is available.

Implements EventListener.

local checkAvailable ( )

overridevirtual

Checks whether the listener is available.

Implements EventListener.

virtual EventListenerKeyboard* clone ( )

overridevirtual

Overrides.

Implements EventListener.

var clone ( )

overridevirtual

Overrides.

Implements EventListener.

local clone ( )

overridevirtual

Overrides.

Implements EventListener.

static EventListenerKeyboard* create ( )

static

var create ( )

static

local create ( )

static

Member Data Documentation

const std::string LISTENER_ID

static

var LISTENER_ID

static

local LISTENER_ID

static

std::function<void(EventKeyboard::KeyCode, Event*)> onKeyPressed

var onKeyPressed

local onKeyPressed

std::function<void(EventKeyboard::KeyCode, Event*)> onKeyReleased

var onKeyReleased

local onKeyReleased

---

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

• /Users/guanghui/cocos2d-x/cocos/base/CCEventListenerKeyboard.h