Class MouseEnterEvent

• Defined in File MouseEvent.h

Inheritance Relationships

Base Type

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

Class Documentation

class MouseEnterEvent : public TRAP::Events::Event

Mouse entered.

Remark

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

Public Functions

explicit MouseEnterEvent(TRAP::Window &window)

Constructor.

Note

The window must outlive the MouseEnterEvent!

Parameters:

window – The affected window.

constexpr ~MouseEnterEvent() override = default

Destructor.

consteval MouseEnterEvent(const MouseEnterEvent&) noexcept = delete

Copy constructor.

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

Copy assignment operator.

constexpr MouseEnterEvent(MouseEnterEvent&&) noexcept = default

Move constructor.

MouseEnterEvent &operator=(MouseEnterEvent&&) 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 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.