CoreComponents 4.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
MouseEvent Class Referencefinal

Mouse event. More...

#include <cc/MouseEvent>

Inheritance diagram for MouseEvent:

Public Member Functions

 MouseEvent (PointerAction action, double time, MouseButton button, int clickCount, const Point &pos, const Step &step)
 Create a new mouse event.
MouseButton button () const
 Mouse button flags
int clickCount () const
 Click repetition count.
Public Member Functions inherited from PointerEvent
PointerAction action () const
 Type of input action.
double time () const
 Time the event occured.
Point pos () const
 Position of the pointer.
Step step () const
 Distance the pointer has been moved.
String toString () const
 Convert into a human-reable form.
Public Member Functions inherited from Object
 Object ()=default
 Create a null object.
 operator bool () const
 Check if this is a non-null object.
bool isNull () const
 Check if this is a null object.
int useCount () const
 Reference count.
template<class T>
bool is () const
 Check if this object is of type T.
template<class T>
as () const
 Cast this object to type T.
bool isWeak () const
 Check if the underlying object reference is weak.
bool operator== (const Object &other) const
 Equality operator.
std::strong_ordering operator<=> (const Object &other) const
 Ordering operator.

Additional Inherited Members

Public Types inherited from Object
using NullAccess = cc::NullAccess
 Error thrown when trying to access a null object.
using VirginityTestFailed = cc::VirginityTestFailed
 Error thrown when trying to initialize an object with a non-virgin state.
Protected Member Functions inherited from PointerEvent
 PointerEvent ()=default
 Create a null pointer event.
 PointerEvent (State *newState)
State & me ()
const State & me () const
Protected Member Functions inherited from Object
template<class T>
weak () const
template<class T>
void initOnce ()
 Create the object state when called the first time.
template<class T>
void initOncePerThread ()
 Create a distinct object state for each thread when called the first time in that thread.
 Object (State *newState)
 Initialize object with newState.
 Object (State *state, Alias)
 Object (State *state, Weak)
Objectoperator= (std::nullptr_t)
Static Protected Member Functions inherited from Object
template<class T>
static T alias (const State *state)
 Create an alias object for the given state.
template<class T>
static T weak (const State *state)
Protected Attributes inherited from Object
Handle< Stateme
 Internal object state

Detailed Description

Mouse event.

Constructor & Destructor Documentation

◆ MouseEvent()

MouseEvent ( PointerAction action,
double time,
MouseButton button,
int clickCount,
const Point & pos,
const Step & step )

Create a new mouse event.

Parameters
actionType of input action.
Parameters
timeTime the event occured.
Parameters
buttonMouse button flags
Parameters
clickCountClick repetition count.
Parameters
posPosition of the pointer.
Parameters
stepDistance the pointer has been moved.

Member Function Documentation

◆ button()

MouseButton button ( ) const

Mouse button flags

◆ clickCount()

int clickCount ( ) const

Click repetition count.