input_event.h Source File - ClanLib SDK
Description: input_event.h Source File

input_event.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 The ClanLib Team
4**
5** This software is provided 'as-is', without any express or implied
6** warranty. In no event will the authors be held liable for any damages
7** arising from the use of this software.
8**
9** Permission is granted to anyone to use this software for any purpose,
10** including commercial applications, and to alter it and redistribute it
11** freely, subject to the following restrictions:
12**
13** 1. The origin of this software must not be misrepresented; you must not
14** claim that you wrote the original software. If you use this software
15** in a product, an acknowledgment in the product documentation would be
16** appreciated but is not required.
17** 2. Altered source versions must be plainly marked as such, and must not be
18** misrepresented as being the original software.
19** 3. This notice may not be removed or altered from any source distribution.
20**
21** Note: Some of the libraries ClanLib may link to may have additional
22** requirements or restrictions.
23**
24** File Author(s):
25**
26** Magnus Norddahl
27** Harry Storbacka
28*/
29
30#pragma once
31
32#include "input_device.h"
33#include "keys.h"
34#include "../../Core/Math/point.h"
35
36namespace clan
37{
40
42 class InputEvent
43 {
44 public:
46 enum Type
47 {
48 no_key = 0,
49 pressed = 1,
50 released = 2,
51 doubleclick = 3,
52 pointer_moved = 4,
53 axis_moved = 5,
54 proximity_change = 6
55 };
56
58 InputEvent();
59 ~InputEvent();
60
62 InputCode id;
63
65 int id_offset;
66
73 std::string str;
74
76 Type type;
77
79 InputDevice device;
80
82 Pointf mouse_pos;
83
85 Point mouse_device_pos;
86
88 double axis_pos;
89
93 int repeat_count;
94
96 bool alt;
97 bool shift;
98 bool ctrl;
99 };
100
102}
clan::InputDevice
InputDevice.
Definition input_device.h:47
clan::InputEvent
Input event class.
Definition input_event.h:43
clan::InputEvent::~InputEvent
~InputEvent()
clan::InputEvent::device
InputDevice device
Device that event originates from.
Definition input_event.h:79
clan::InputEvent::alt
bool alt
State of modifier keys.
Definition input_event.h:96
clan::InputEvent::id
InputCode id
The exact input.
Definition input_event.h:62
clan::InputEvent::mouse_pos
Pointf mouse_pos
Mouse position at event time.
Definition input_event.h:82
clan::InputEvent::id_offset
int id_offset
Contains the value (0 to x) for certains InputCode types that have a variable output identifier (for ...
Definition input_event.h:65
clan::InputEvent::repeat_count
int repeat_count
The repeat count for this event. Contains the number of times the keystroke has auto-repeated as a re...
Definition input_event.h:93
clan::InputEvent::mouse_device_pos
Point mouse_device_pos
Mouse actual position at event time.
Definition input_event.h:85
clan::InputEvent::axis_pos
double axis_pos
Axis position.
Definition input_event.h:88
clan::InputEvent::shift
bool shift
Definition input_event.h:97
clan::InputEvent::InputEvent
InputEvent()
Constructs a 'NoKey' key.
clan::InputEvent::str
std::string str
Character sequence generated by event. A key press can generate one, none or multiple characters....
Definition input_event.h:73
clan::InputEvent::ctrl
bool ctrl
Definition input_event.h:98
clan::InputEvent::type
Type type
Event type.
Definition input_event.h:76
clan::InputEvent::Type
Type
Event types.
Definition input_event.h:47
clan::InputEvent::proximity_change
@ proximity_change
Definition input_event.h:54
clan::InputEvent::axis_moved
@ axis_moved
Definition input_event.h:53
clan::InputEvent::released
@ released
Definition input_event.h:50
clan::InputEvent::pointer_moved
@ pointer_moved
Definition input_event.h:52
clan::InputEvent::doubleclick
@ doubleclick
Definition input_event.h:51
clan::InputEvent::pressed
@ pressed
Definition input_event.h:49
clan::InputEvent::no_key
@ no_key
Definition input_event.h:48
clan::Point
2D (x,y) point structure - Integer
Definition point.h:62
clan::Pointf
2D (x,y) point structure - Float
Definition point.h:72
clan::InputCode
InputCode
Definition input_code.h:47
clan
Definition clanapp.h:36