scl::keyboard_event Class Reference

#include <keyboard_event.h>

Inheritance diagram for scl::keyboard_event:

Public Member Functions
	keyboard_event (bool Pressed, bool PrevPressed, keycode KeyCode)
bool	GetPressed ()
int	GetPrevPressed ()
int	GetClicked ()
keycode	GetKeyCode ()
std::string	ToString () const override
Public Member Functions inherited from scl::event
virtual	~event ()=default
virtual u32	GetType () const =0
virtual const char *	GetName () const =0
virtual std::string	ToString () const

Additional Inherited Members
Public Attributes inherited from scl::event
bool	Handled { false }

Detailed Description

Keyboard action event class.

Definition at line 17 of file keyboard_event.h.

Constructor & Destructor Documentation

keyboard_event()

scl::keyboard_event::keyboard_event ( bool  Pressed, bool  PrevPressed, keycode  KeyCode  )

inline

• Keyboard event default constructor.

Parameters

Pressed	- is key pressed or released flag.
RepeatCount	- is key pressed continiaously flag.
KeyCode	- kode of acting key

Definition at line 35 of file keyboard_event.h.

                                                                        :
            Pressed(Pressed), PrevPressed(PrevPressed), KeyCode(KeyCode),
            Clicked(!PrevPressed && Pressed) {}

Member Function Documentation

GetClicked()

int scl::keyboard_event::GetClicked ( )

inline

Key clicked once flag getter function.

Definition at line 44 of file keyboard_event.h.

{ return Clicked; }

GetKeyCode()

keycode scl::keyboard_event::GetKeyCode ( )

inline

Kode of acting key getter function.

Definition at line 46 of file keyboard_event.h.

{ return KeyCode;  }

GetPressed()

bool scl::keyboard_event::GetPressed ( )

inline

Key pressed or released flag getter function.

Definition at line 40 of file keyboard_event.h.

{ return Pressed; }

GetPrevPressed()

int scl::keyboard_event::GetPrevPressed ( )

inline

Key pressed continiaously flag getter function.

Definition at line 42 of file keyboard_event.h.

{ return PrevPressed; }

ToString()

std::string scl::keyboard_event::ToString ( ) const

inlineoverridevirtual

• Convert event to string (for debug).

Parameters

None.

Returns

string representation of event.

Reimplemented from scl::event.

Definition at line 54 of file keyboard_event.h.

        {
            std::stringstream ss;
            ss << GetName() << ": Pressed? - " << Pressed << ", Prev. Pressed? - " << PrevPressed
               << ", Clicked? - " << Clicked << ", KeyCode - " << (int)KeyCode;
            return ss.str();
        }

---

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

• core/events/keyboard_event.h