cocos2d-x  3.5
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
EventListenerMouse Class Reference

Mouse event listener. More...

#include <CCEventListenerMouse.h>

Inheritance diagram for EventListenerMouse:
EventListener Ref

Public Member Functions

virtual EventListenerMouseclone () override
 Overrides. More...
 
virtual bool checkAvailable () override
 Checks whether the listener is available. More...
 
bool init ()
- Public Member Functions inherited from EventListener
bool init (Type t, const ListenerID &listenerID, const std::function< void(Event *)> &callback)
 Initializes event with type and callback function. More...
 
virtual ~EventListener ()
 Destructor. More...
 
void setEnabled (bool 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...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Static Public Member Functions

static EventListenerMousecreate ()
 Create a mouse event listener. More...
 

Public Attributes

std::function< void(Event *event)> onMouseDown
std::function< void(Event *event)> onMouseUp
std::function< void(Event *event)> onMouseMove
std::function< void(Event *event)> onMouseScroll
CC_CONSTRUCTOR_ACCESS __pad0__: EventListenerMouse()
- Public Attributes inherited from EventListener
CC_CONSTRUCTOR_ACCESS __pad0__: EventListener()

Static Public Attributes

static const std::string 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, GAME_CONTROLLER,
  CUSTOM
}
 Type Event type. More...
 
typedef std::string ListenerID
- Protected Member Functions inherited from EventListener
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...
 
void setRegistered (bool 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...
 
const ListenerIDgetListenerID () 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...
 
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...
 
NodegetAssociatedNode () 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...
 
ListenerID _listenerID
 Event listener type. More...
 
bool _isRegistered
 Event listener ID. More...
 
int _fixedPriority
 Whether the listener has been added to dispatcher. More...
 
Node_node
bool _paused
bool _isEnabled
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Detailed Description

Mouse event listener.

Member Function Documentation

virtual bool checkAvailable ( )
overridevirtual

Checks whether the listener is available.

Returns
True if the listener is available.

Implements EventListener.

virtual EventListenerMouse* clone ( )
overridevirtual

Overrides.

Implements EventListener.

static EventListenerMouse* create ( )
static

Create a mouse event listener.

Returns
An autoreleased EventListenerMouse object.
bool init ( )

Member Data Documentation

const std::string LISTENER_ID
static
std::function<void(Event*
event)> onMouseDown
std::function<void(Event*
event)> onMouseMove
std::function<void(Event*
event)> onMouseScroll
std::function<void(Event*
event)> onMouseUp

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