Class KeyLayoutEvent

• Defined in File KeyEvent.h

Inheritance Relationships

Base Type

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

Class Documentation

class KeyLayoutEvent : public TRAP::Events::Event

Key layout changed.

Remark

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

Public Functions

explicit constexpr KeyLayoutEvent(std::string layout) noexcept

Constructor.

Parameters:

layout – New keyboard layout.

constexpr ~KeyLayoutEvent() override = default

Destructor.

consteval KeyLayoutEvent(const KeyLayoutEvent&) noexcept = delete

Copy constructor.

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

Copy assignment operator.

constexpr KeyLayoutEvent(KeyLayoutEvent&&) noexcept = default

Move constructor.

constexpr KeyLayoutEvent &operator=(KeyLayoutEvent&&) noexcept = default

Move assignment operator.

constexpr std::string GetLayout() const noexcept

Retrieve the human-readable name of the new keyboard layout.

Returns:

Name of new keyboard layout.

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 constexpr EventCategory GetCategoryFlags() const noexcept override

Retrieve the category flags of the event.

Returns:

Combination of one or more EventCategory’s.

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.