Input injection interface to be inplemented by classes that take raw inputs.
More...
#include <InjectedInputReceiver.h>
Input injection interface to be inplemented by classes that take raw inputs.
◆ injectChar()
Function that injects a typed character event into the receiver.
- Parameters
-
code_point | Unicode or ASCII (depends on used String class) code point of the character that was typed. |
- Returns
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
Implemented in CEGUI::GUIContext.
◆ injectCopyRequest()
virtual bool CEGUI::InjectedInputReceiver::injectCopyRequest |
( |
| ) |
|
|
pure virtual |
Tells the receiver to perform a clipboard copy operation.
- Returns
- true if the copy was successful
- false if the copy was denied
Implemented in CEGUI::GUIContext.
◆ injectCutRequest()
virtual bool CEGUI::InjectedInputReceiver::injectCutRequest |
( |
| ) |
|
|
pure virtual |
Tells the system to perform a clipboard cut operation.
- Returns
- true if the cut was successful
- false if the cut was denied
Implemented in CEGUI::GUIContext.
◆ injectKeyDown()
virtual bool CEGUI::InjectedInputReceiver::injectKeyDown |
( |
Key::Scan |
scan_code | ) |
|
|
pure virtual |
Function that injects a key down event into the receiver.
- Parameters
-
key_code | uint value indicating which key was pressed. |
- Returns
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
Implemented in CEGUI::GUIContext.
◆ injectKeyUp()
virtual bool CEGUI::InjectedInputReceiver::injectKeyUp |
( |
Key::Scan |
scan_code | ) |
|
|
pure virtual |
Function that injects a key up event into the receiver.
- Parameters
-
key_code | Key::Scan value indicating which key was released. |
- Returns
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
Implemented in CEGUI::GUIContext.
◆ injectMouseButtonClick()
virtual bool CEGUI::InjectedInputReceiver::injectMouseButtonClick |
( |
const MouseButton |
button | ) |
|
|
pure virtual |
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.
- Parameters
-
button | One of the MouseButton enumerated values. |
- Returns
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
Implemented in CEGUI::GUIContext.
◆ injectMouseButtonDoubleClick()
virtual bool CEGUI::InjectedInputReceiver::injectMouseButtonDoubleClick |
( |
const MouseButton |
button | ) |
|
|
pure virtual |
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.
- Parameters
-
button | One of the MouseButton enumerated values. |
- Returns
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
Implemented in CEGUI::GUIContext.
◆ injectMouseButtonDown()
virtual bool CEGUI::InjectedInputReceiver::injectMouseButtonDown |
( |
MouseButton |
button | ) |
|
|
pure virtual |
Function that injects a mouse button down event into the receiver.
- Parameters
-
button | One of the MouseButton values indicating which button was pressed. |
- Returns
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
Implemented in CEGUI::GUIContext.
◆ injectMouseButtonTripleClick()
virtual bool CEGUI::InjectedInputReceiver::injectMouseButtonTripleClick |
( |
const MouseButton |
button | ) |
|
|
pure virtual |
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.
- Parameters
-
button | One of the MouseButton enumerated values. |
- Returns
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
Implemented in CEGUI::GUIContext.
◆ injectMouseButtonUp()
virtual bool CEGUI::InjectedInputReceiver::injectMouseButtonUp |
( |
MouseButton |
button | ) |
|
|
pure virtual |
Function that injects a mouse button up event into the receiver.
- Parameters
-
button | One of the MouseButton values indicating which button was released. |
- Returns
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
Implemented in CEGUI::GUIContext.
◆ injectMouseLeaves()
virtual bool CEGUI::InjectedInputReceiver::injectMouseLeaves |
( |
| ) |
|
|
pure virtual |
Function that notifies that the mouse has left the host area that the receiver receives input for.
- Returns
- true if the event was handled.
- false if the event was not handled.
Implemented in CEGUI::GUIContext.
◆ injectMouseMove()
virtual bool CEGUI::InjectedInputReceiver::injectMouseMove |
( |
float |
delta_x, |
|
|
float |
delta_y |
|
) |
| |
|
pure virtual |
Function that injects a mouse movement event into the receiver.
- Parameters
-
delta_x | amount the mouse moved on the x axis. |
delta_y | amount the mouse moved on the y axis. |
- Returns
- true if the input was processed by the input receiver.
- false if the input was not processed by the input receiver.
Implemented in CEGUI::GUIContext.
◆ injectMousePosition()
virtual bool CEGUI::InjectedInputReceiver::injectMousePosition |
( |
float |
x_pos, |
|
|
float |
y_pos |
|
) |
| |
|
pure virtual |
Function that injects a new position for the mouse cursor.
- Parameters
-
x_pos | New absolute pixel position of the mouse cursor on the x axis. |
y_pos | New absolute pixel position of the mouse cursoe in the y axis. |
- Returns
- true if the generated mouse move event was handled.
- false if the generated mouse move event was not handled.
Implemented in CEGUI::GUIContext.
◆ injectMouseWheelChange()
virtual bool CEGUI::InjectedInputReceiver::injectMouseWheelChange |
( |
float |
delta | ) |
|
|
pure virtual |
Function that injects a mouse-wheel / scroll-wheel event into the receiver.
- Parameters
-
delta | float value representing the amount the wheel moved. |
- Returns
- true if the input was processed by the receiver.
- false if the input was not processed by the receiver.
Implemented in CEGUI::GUIContext.
◆ injectPasteRequest()
virtual bool CEGUI::InjectedInputReceiver::injectPasteRequest |
( |
| ) |
|
|
pure virtual |
Tells the system to perform a clipboard paste operation.
- Returns
- true if the paste was successful
- false if the paste was denied
Implemented in CEGUI::GUIContext.
◆ injectTimePulse()
virtual bool CEGUI::InjectedInputReceiver::injectTimePulse |
( |
float |
timeElapsed | ) |
|
|
pure virtual |
Function to inject time pulses into the receiver.
- Parameters
-
timeElapsed | float value indicating the amount of time passed, in seconds, since the last time this method was called. |
- Returns
- Currently, this method always returns true.
Implemented in CEGUI::GUIContext.