Class KeyPressEvent

• Defined in File KeyEvent.h

Inheritance Relationships

Base Type

• public TRAP::Events::KeyEvent (Class KeyEvent)

Class Documentation

class KeyPressEvent : public TRAP::Events::KeyEvent

Key pressed event.

Remark

Headless mode: This class is not available in headless mode.

Public Functions

KeyPressEvent(Input::Key key, TRAP::Window &window)

Constructor.

Note

The window must outlive the KeyPressEvent!

Parameters:

• key – Pressed key.

• window – The affected window.

constexpr ~KeyPressEvent() override = default

Destructor.

consteval KeyPressEvent(const KeyPressEvent&) noexcept = delete

Copy constructor.

consteval KeyPressEvent &operator=(const KeyPressEvent&) noexcept = delete

Copy assignment operator.

constexpr KeyPressEvent(KeyPressEvent&&) noexcept = default

Move constructor.

KeyPressEvent &operator=(KeyPressEvent&&) noexcept = default

Move assignment operator.

constexpr TRAP::Window &GetWindow() const noexcept

Retrieve a reference to the affected window.

Returns:

Window reference.

virtual constexpr EventType GetEventType() const noexcept override

Retrieve the EventType of the event.

Returns:

EventType.

virtual constexpr std::string GetName() const override

Retrieve the name of the event.

Returns:

Name.

virtual std::string ToString() const override

Get a string representation of the event.

Returns:

String representation.

Public Static Functions

static constexpr EventType GetStaticType() noexcept

Retrieve the EventType of the event.

Returns:

EventType.