NRE::Event::KeyEvent Class Reference

Manage a key event. More...

#include <NRE_KeyEvent.hpp>

Public Member Functions

 KeyEvent ()=delete
 
 KeyEvent (KeyCode c)
 
 KeyEvent (KeyEvent const &e)=default
 
 KeyEvent (KeyEvent &&e)=default
 
 ~KeyEvent ()=default
 
KeyCode getCode () const
 
bool isCode (KeyCode c) const
 
KeyEventoperator= (KeyEvent const &e)=default
 
KeyEventoperator= (KeyEvent &&e)=default
 

Detailed Description

Manage a key event.

Constructor & Destructor Documentation

NRE::Event::KeyEvent::KeyEvent ( )
delete

Default constructor

NRE::Event::KeyEvent::KeyEvent ( KeyCode  c)

Construct the event from the key code

Parameters
cthe key code
NRE::Event::KeyEvent::KeyEvent ( KeyEvent const &  e)
default

Copy e into this

Parameters
ethe key event to copy
NRE::Event::KeyEvent::KeyEvent ( KeyEvent &&  e)
default

Move e into this

Parameters
ethe key event to move
NRE::Event::KeyEvent::~KeyEvent ( )
default

KeyEvent Deconstructor

Member Function Documentation

KeyCode NRE::Event::KeyEvent::getCode ( ) const
inline
Returns
the key's code
bool NRE::Event::KeyEvent::isCode ( KeyCode  c) const
inline

Compare the event code to the given one

Parameters
ca key code
Returns
the test's result
KeyEvent& NRE::Event::KeyEvent::operator= ( KeyEvent const &  e)
default

Copy e into this

Parameters
ethe object to copy into this
Returns
the reference of himself
KeyEvent& NRE::Event::KeyEvent::operator= ( KeyEvent &&  e)
default

Copy e into this

Parameters
ethe object to copy into this
Returns
the reference of himself

The documentation for this class was generated from the following file:
  • /mnt/c/Users/abell/Documents/GitHub/NRE-System/src/System/Event/Event/Key/NRE_KeyEvent.hpp