/usr/include/cegui-0.8.4/CEGUI/InjectedInputReceiver.h is in libcegui-mk2-dev 0.8.4+dfsg-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | /***********************************************************************
created: Thu Feb 16 2012
author: Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIInjectedInputReceiver_h_
#define _CEGUIInjectedInputReceiver_h_
#include "CEGUI/InputEvent.h"
namespace CEGUI
{
//! Input injection interface to be inplemented by classes that take raw inputs
class CEGUIEXPORT InjectedInputReceiver
{
public:
virtual ~InjectedInputReceiver() {}
/*!
\brief
Function that injects a mouse movement event into the receiver.
\param delta_x
amount the mouse moved on the x axis.
\param delta_y
amount the mouse moved on the y axis.
\return
- true if the input was processed by the input receiver.
- false if the input was not processed by the input receiver.
*/
virtual bool injectMouseMove(float delta_x, float delta_y) = 0;
/*!
\brief
Function that notifies that the mouse has left the host area that the
receiver receives input for.
\return
- true if the event was handled.
- false if the event was not handled.
*/
virtual bool injectMouseLeaves() = 0;
/*!
\brief
Function that injects a mouse button down event into the receiver.
\param button
One of the MouseButton values indicating which button was pressed.
\return
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
*/
virtual bool injectMouseButtonDown(MouseButton button) = 0;
/*!
\brief
Function that injects a mouse button up event into the receiver.
\param button
One of the MouseButton values indicating which button was released.
\return
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
*/
virtual bool injectMouseButtonUp(MouseButton button) = 0;
/*!
\brief
Function that injects a key down event into the receiver.
\param key_code
uint value indicating which key was pressed.
\return
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
*/
virtual bool injectKeyDown(Key::Scan scan_code) = 0;
/*!
\brief
Function that injects a key up event into the receiver.
\param key_code
Key::Scan value indicating which key was released.
\return
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
*/
virtual bool injectKeyUp(Key::Scan scan_code) = 0;
/*!
\brief
Function that injects a typed character event into the receiver.
\param code_point
Unicode or ASCII (depends on used String class) code point of the character that was typed.
\return
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
*/
virtual bool injectChar(String::value_type code_point) = 0;
/*!
\brief
Function that injects a mouse-wheel / scroll-wheel event into the receiver.
\param delta
float value representing the amount the wheel moved.
\return
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
*/
virtual bool injectMouseWheelChange(float delta) = 0;
/*!
\brief
Function that injects a new position for the mouse cursor.
\param x_pos
New absolute pixel position of the mouse cursor on the x axis.
\param y_pos
New absolute pixel position of the mouse cursoe in the y axis.
\return
- true if the generated mouse move event was handled.
- false if the generated mouse move event was not handled.
*/
virtual bool injectMousePosition(float x_pos, float y_pos) = 0;
/*!
\brief
Function to inject time pulses into the receiver.
\param timeElapsed
float value indicating the amount of time passed, in seconds, since the last time this method was called.
\return
Currently, this method always returns true.
*/
virtual bool injectTimePulse(float timeElapsed) = 0;
/*!
\brief
Function to directly inject a mouse button click event.
Here 'click' means a mouse button down event followed by a mouse
button up event.
\note
Under normal, default settings, this event is automatically generated by
the system from the regular up and down events you inject. You may use
this function directly, though you'll probably want to disable the
automatic click event generation first by using the
setMouseClickEventGenerationEnabled function - this setting controls the
auto-generation of events and also determines the default 'handled'
state of the injected click events according to the rules used for
mouse up/down events.
\param button
One of the MouseButton enumerated values.
\return
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
*/
virtual bool injectMouseButtonClick(const MouseButton button) = 0;
/*!
\brief
Function to directly inject a mouse button double-click event.
Here 'double-click' means a single mouse button had the sequence down,
up, down within a predefined period of time.
\note
Under normal, default settings, this event is automatically generated by
the system from the regular up and down events you inject. You may use
this function directly, though you'll probably want to disable the
automatic click event generation first by using the
setMouseClickEventGenerationEnabled function - this setting controls the
auto-generation of events and also determines the default 'handled'
state of the injected click events according to the rules used for
mouse up/down events.
\param button
One of the MouseButton enumerated values.
\return
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
*/
virtual bool injectMouseButtonDoubleClick(const MouseButton button) = 0;
/*!
\brief
Function to directly inject a mouse button triple-click event.
Here 'triple-click' means a single mouse button had the sequence down,
up, down, up, down within a predefined period of time.
\note
Under normal, default settings, this event is automatically generated by
the system from the regular up and down events you inject. You may use
this function directly, though you'll probably want to disable the
automatic click event generation first by using the
setMouseClickEventGenerationEnabled function - this setting controls the
auto-generation of events and also determines the default 'handled'
state of the injected click events according to the rules used for
mouse up/down events.
\param button
One of the MouseButton enumerated values.
\return
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
*/
virtual bool injectMouseButtonTripleClick(const MouseButton button) = 0;
/*!
\brief
Tells the receiver to perform a clipboard copy operation.
\return
- true if the copy was successful
- false if the copy was denied
*/
virtual bool injectCopyRequest() = 0;
/*!
\brief
Tells the system to perform a clipboard cut operation.
\return
- true if the cut was successful
- false if the cut was denied
*/
virtual bool injectCutRequest() = 0;
/*!
\brief
Tells the system to perform a clipboard paste operation.
\return
- true if the paste was successful
- false if the paste was denied
*/
virtual bool injectPasteRequest() = 0;
};
}
#endif
|