Magnum::Platform::AbstractXApplication::InputEvent class
#include <Magnum/Platform/AbstractXApplication.h>

Base for input events.

Derived classes

class KeyEvent: Key event.
class MouseEvent deprecated in Git master: Mouse event.
class MouseMoveEvent deprecated in Git master: Mouse move event.
class PointerEvent new in Git master: Pointer event.
class PointerMoveEvent new in Git master: Pointer move event.
class ScrollEvent new in Git master: Scroll event.

Public types

enum class Button: unsigned int { Left = Button1Mask, Middle = Button2Mask, Right = Button3Mask } deprecated in Git master: Mouse button.
using Modifier = AbstractXApplication::Modifier deprecated in Git master: Keyboard modifier.
using Modifiers = AbstractXApplication::Modifiers deprecated in Git master: Set of keyboard modifiers.
using Buttons = Containers::EnumSet<Button> deprecated in Git master: 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: Whether the event is accepted.
auto modifiers() const -> AbstractXApplication::Modifiers: Keyboard modifiers.
auto buttons() const -> Buttons deprecated in Git master: Mouse buttons.

Enum documentation

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

Mouse button.

Enumerators
Left	Left button
Middle	Middle button
Right	Right button

Typedef documentation

typedef AbstractXApplication::Modifier Magnum::Platform::AbstractXApplication::InputEvent::Modifier

Keyboard modifier.

typedef AbstractXApplication::Modifiers Magnum::Platform::AbstractXApplication::InputEvent::Modifiers

Set of keyboard 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.

Buttons Magnum::Platform::AbstractXApplication::InputEvent::buttons() const

Mouse buttons.