Magnum::Platform::AbstractXApplication::InputEvent class

Base for input events.

Reference

Derived classes

class KeyEvent: Key event.
class MouseEvent: Mouse event.
class MouseMoveEvent: Mouse move event.

Public types

enum class Modifier: unsigned int { Shift = ShiftMask, Ctrl = ControlMask, Alt = Mod1Mask, AltGr = Mod5Mask, CapsLock = LockMask, NumLock = Mod2Mask }: Modifier.
enum class Button: unsigned int { Left = Button1Mask, Middle = Button2Mask, Right = Button3Mask }: Mouse button.
using Modifiers = Containers::EnumSet<Modifier>: Set of modifiers.
using Buttons = Containers::EnumSet<Button>: Set of mouse buttons.

Constructors, destructors, conversion operators

InputEvent(const InputEvent&) deleted: Copying is not allowed.
InputEvent(InputEvent&&) deleted: Moving is not allowed.

Public functions

auto operator=(const InputEvent&) -> InputEvent& deleted: Copying is not allowed.
auto operator=(InputEvent&&) -> InputEvent& deleted: Moving is not allowed.
void setAccepted(bool accepted = true): Set event as accepted.
auto isAccepted() const -> bool constexpr: Whether the event is accepted.
auto modifiers() const -> Modifiers constexpr: Modifiers.
auto buttons() const -> Buttons constexpr: Mouse buttons.

Enum documentation

enum class Magnum::Platform::AbstractXApplication::InputEvent::Modifier: unsigned int

Modifier.

Enumerators
Shift	Shift
Ctrl	Ctrl
Alt	Alt
AltGr	AltGr
CapsLock	Caps lock
NumLock	Num lock

enum class Magnum::Platform::AbstractXApplication::InputEvent::Button: unsigned int

Mouse button.

Enumerators
Left	Left button
Middle	Middle button
Right	Right button

Typedef documentation

typedef Containers::EnumSet<Modifier> Magnum::Platform::AbstractXApplication::InputEvent::Modifiers

Set of modifiers.

typedef Containers::EnumSet<Button> Magnum::Platform::AbstractXApplication::InputEvent::Buttons

Set of mouse buttons.

Function documentation

void Magnum::Platform::AbstractXApplication::InputEvent::setAccepted(bool accepted = true)

Set event as accepted.

If the event is ignored (i.e., not set as accepted), it might be propagated elsewhere, for example to another screen when using ScreenedApplication. By default is each event ignored and thus propagated.