Crazy Eddie's GUI System 0.8.7
Loading...
Searching...
No Matches
InjectedInputReceiver.h
1/***********************************************************************
2 created: Thu Feb 16 2012
3 author: Paul D Turner <paul@cegui.org.uk>
4*************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 ***************************************************************************/
27#ifndef _CEGUIInjectedInputReceiver_h_
28#define _CEGUIInjectedInputReceiver_h_
29
30#include "CEGUI/InputEvent.h"
31
32namespace CEGUI
33{
34
36class CEGUIEXPORT InjectedInputReceiver
37{
38public:
39 virtual ~InjectedInputReceiver() {}
40
55 virtual bool injectMouseMove(float delta_x, float delta_y) = 0;
56
66 virtual bool injectMouseLeaves() = 0;
67
79 virtual bool injectMouseButtonDown(MouseButton button) = 0;
80
92 virtual bool injectMouseButtonUp(MouseButton button) = 0;
93
105 virtual bool injectKeyDown(Key::Scan scan_code) = 0;
106
118 virtual bool injectKeyUp(Key::Scan scan_code) = 0;
119
131 virtual bool injectChar(String::value_type code_point) = 0;
132
144 virtual bool injectMouseWheelChange(float delta) = 0;
145
160 virtual bool injectMousePosition(float x_pos, float y_pos) = 0;
161
172 virtual bool injectTimePulse(float timeElapsed) = 0;
173
198 virtual bool injectMouseButtonClick(const MouseButton button) = 0;
199
224 virtual bool injectMouseButtonDoubleClick(const MouseButton button) = 0;
225
250 virtual bool injectMouseButtonTripleClick(const MouseButton button) = 0;
251
260 virtual bool injectCopyRequest() = 0;
261
270 virtual bool injectCutRequest() = 0;
271
280 virtual bool injectPasteRequest() = 0;
281};
282
283}
284
285#endif
286
Input injection interface to be inplemented by classes that take raw inputs.
Definition InjectedInputReceiver.h:37
virtual bool injectMouseMove(float delta_x, float delta_y)=0
Function that injects a mouse movement event into the receiver.
virtual bool injectMouseButtonDown(MouseButton button)=0
Function that injects a mouse button down event into the receiver.
virtual bool injectCopyRequest()=0
Tells the receiver to perform a clipboard copy operation.
virtual bool injectMousePosition(float x_pos, float y_pos)=0
Function that injects a new position for the mouse cursor.
virtual bool injectMouseButtonTripleClick(const MouseButton button)=0
Function to directly inject a mouse button triple-click event.
virtual bool injectMouseButtonClick(const MouseButton button)=0
Function to directly inject a mouse button click event.
virtual bool injectMouseButtonUp(MouseButton button)=0
Function that injects a mouse button up event into the receiver.
virtual bool injectChar(String::value_type code_point)=0
Function that injects a typed character event into the receiver.
virtual bool injectMouseLeaves()=0
Function that notifies that the mouse has left the host area that the receiver receives input for.
virtual bool injectMouseButtonDoubleClick(const MouseButton button)=0
Function to directly inject a mouse button double-click event.
virtual bool injectTimePulse(float timeElapsed)=0
Function to inject time pulses into the receiver.
virtual bool injectMouseWheelChange(float delta)=0
Function that injects a mouse-wheel / scroll-wheel event into the receiver.
virtual bool injectKeyUp(Key::Scan scan_code)=0
Function that injects a key up event into the receiver.
virtual bool injectCutRequest()=0
Tells the system to perform a clipboard cut operation.
virtual bool injectPasteRequest()=0
Tells the system to perform a clipboard paste operation.
virtual bool injectKeyDown(Key::Scan scan_code)=0
Function that injects a key down event into the receiver.
utf32 value_type
Basic 'code point' type used for String (utf32)
Definition String.h:69
Main namespace for Crazy Eddie's GUI Library.
Definition arch_overview.dox:1
MouseButton
Enumeration of mouse buttons.
Definition InputEvent.h:210