Common::Event Struct Reference

#include <events.h>

Inheritance diagram for Common::Event:

Public Attributes
EventType	type
bool	kbdRepeat
KeyState	kbd
Point	mouse
CustomEventType	customType
Common::Path	path
Common::Point	relMouse
JoystickState	joystick

Detailed Description

Data structure for an event. A pointer to an instance of Event can be passed to pollEvent.

Member Data Documentation

type

EventType Common::Event::type

The type of the event.

kbdRepeat

bool Common::Event::kbdRepeat

True if this is a key-down repeat event.

Only valid for EVENT_KEYDOWN events.

kbd

KeyState Common::Event::kbd

Keyboard data; only valid for keyboard events (EVENT_KEYDOWN and EVENT_KEYUP). For all other event types, content is undefined.

mouse

Point Common::Event::mouse

The mouse coordinates, in virtual screen coordinates. Only valid for mouse events. 'Virtual screen coordinates' refers to the coordinate system of the screen area as defined by the most recent call to initSize().

customType

CustomEventType Common::Event::customType

Refers to an event generated by ArtificialEventSource.

path

Common::Path Common::Event::path

The path of the file or directory dragged to the ScummVM window.

relMouse

Common::Point Common::Event::relMouse

Mouse movement since the last mouse movement event.

joystick

JoystickState Common::Event::joystick

Joystick data; only valid for joystick events (EVENT_JOYAXIS_MOTION, EVENT_JOYBUTTON_DOWN and EVENT_JOYBUTTON_UP).

---

The documentation for this struct was generated from the following file:

• common/events.h