#include <GUIInputMedia.h>
|
| enum | AcquisitionType_t { Polling
, Callback
} |
| | how events are collected
|
| |
| enum | Rotation_t { ROTATION_0
, ROTATION_90
, ROTATION_180
, ROTATION_270
} |
| | rotation of input-device
|
| |
|
|
eC_Bool | m_bDebugMode |
| | debug-mode for input-device
|
| |
|
eC_Bool | m_bMultipleTouches |
| | supports multiple touches
|
| |
|
eC_Bool | m_bStopIdle |
| | stop idle when waiting for events
|
| |
|
Rotation_t | m_eRotation |
| | current rotation used for input-device
|
| |
|
eC_Int | m_iOffsetX |
| | x-offset
|
| |
|
eC_Int | m_iOffsetY |
| | y-offset
|
| |
|
eC_Int | m_iSizeX |
| | width
|
| |
|
eC_Int | m_iSizeY |
| | height
|
| |
|
eC_UInt | m_uiIdleTime |
| | maximum time to spend
|
| |
|
eC_UInt | m_uiSleepInterval |
| | sleep interval
|
| |
Base-class for all input devices that are attachable to the GUI.
- See also
- Porting User Input for Guiliani
◆ CGUIInputMedia()
| CGUIInputMedia::CGUIInputMedia |
( |
const eC_Bool & |
bQueuedEvents = false, |
|
|
const AcquisitionType_t & |
eType = Polling |
|
) |
| |
|
protected |
constructor
- Parameters
-
| bQueuedEvents | if true an internal list will be used to save events, otherwise only the last acquired event will be saved |
| eType | acquisition type can be POLLING or CALLBACK |
◆ ~CGUIInputMedia()
| virtual CGUIInputMedia::~CGUIInputMedia |
( |
| ) |
|
|
protectedvirtual |
◆ AddEvent()
| void CGUIInputMedia::AddEvent |
( |
CGUIEvent * |
pkEvent | ) |
|
add a new event into the queue (if used)
- Parameters
-
◆ DeleteInstance()
| static void CGUIInputMedia::DeleteInstance |
( |
| ) |
|
|
static |
◆ GetDebugMode()
| eC_Bool CGUIInputMedia::GetDebugMode |
( |
| ) |
const |
Return if debug-mode for input-device is active
- Returns
- true if active
◆ GetEvent()
| CGUIEvent * CGUIInputMedia::GetEvent |
( |
eC_UInt |
uiIdleTime | ) |
|
Retrieves a platform-specific event and creates an appropriate Guiliani event. The supplied parameter specifies the time in milliseconds until the next processing of animation timers or commands is required. An input media may use this to avoid unnecessary event polling. It MUST return from GetEvent after the specified time, though.
- Parameters
-
| uiIdleTime | specifies the maximum idle time in ms. |
- Returns
- Pointer to a newly generated Guiliani event, or NULL if nothing happened.
◆ GetMaxEventThreshold()
| eC_UInt CGUIInputMedia::GetMaxEventThreshold |
( |
| ) |
const |
get the maximum number of events
- Returns
- maximum number of events
◆ GetMinEventThreshold()
| eC_UInt CGUIInputMedia::GetMinEventThreshold |
( |
| ) |
const |
get the minimum number of events
- Returns
- minimum number of events
◆ GetMulitpleTouches()
| virtual eC_Bool CGUIInputMedia::GetMulitpleTouches |
( |
| ) |
const |
|
virtual |
get if multiple touches supported
- Returns
- true if multiple touches supported
Reimplemented in CGUIPlaybackInput.
◆ GetOffset()
| virtual void CGUIInputMedia::GetOffset |
( |
eC_Int & |
riOffsetX, |
|
|
eC_Int & |
riOffsetY |
|
) |
| const |
|
virtual |
get the offset of the input-device
- Parameters
-
| riOffsetX | x-offset |
| riOffsetY | y-offset |
Reimplemented in CGUIPlaybackInput.
◆ GetRotation()
Get the rotation of the input-device
- Returns
- rotation
◆ GetSize()
| virtual void CGUIInputMedia::GetSize |
( |
eC_Int & |
riSizeX, |
|
|
eC_Int & |
riSizeY |
|
) |
| const |
|
virtual |
get the size of the input-device
- Parameters
-
| riSizeX | width |
| riSizeY | height |
Reimplemented in CGUIPlaybackInput.
◆ GetSleepInterval()
| eC_UInt CGUIInputMedia::GetSleepInterval |
( |
| ) |
const |
get the current sleep-interval
- Returns
- interval
◆ PollEvent()
| virtual void CGUIInputMedia::PollEvent |
( |
| ) |
|
|
inlinevirtual |
◆ RetrieveEvent()
| CGUIEvent * CGUIInputMedia::RetrieveEvent |
( |
| ) |
|
retrieve and remove an event from the queue (if used)
- Returns
- event
◆ SetDebugMode()
| void CGUIInputMedia::SetDebugMode |
( |
const eC_Bool & |
bDebugMode | ) |
|
Activates debug-mode for input-device Will output messages for every input and can be used for calibrating input-device
- Parameters
-
| bDebugMode | true for active debug-mode |
◆ SetMaxEventThreshold()
| void CGUIInputMedia::SetMaxEventThreshold |
( |
const eC_UInt & |
uiMaxEventThreshold | ) |
|
set the maximum number of events in the list before events are dropped
- Parameters
-
◆ SetMinEventThreshold()
| void CGUIInputMedia::SetMinEventThreshold |
( |
const eC_UInt & |
uiMinEventThreshold | ) |
|
set the minimum number of events in the list before event dropping is disabled
- Parameters
-
◆ SetMultipleTouches()
| virtual void CGUIInputMedia::SetMultipleTouches |
( |
const eC_Bool & |
bMultipleTouches | ) |
|
|
virtual |
set multiple touches supported
- Parameters
-
◆ SetOffset()
| virtual void CGUIInputMedia::SetOffset |
( |
const eC_Int & |
iOffsetX, |
|
|
const eC_Int & |
iOffsetY |
|
) |
| |
|
virtual |
◆ SetRotation()
| void CGUIInputMedia::SetRotation |
( |
const Rotation_t & |
eRotation | ) |
|
Set the rotation of the input-device
- Parameters
-
◆ SetSize()
| virtual void CGUIInputMedia::SetSize |
( |
const eC_Int & |
iSizeX, |
|
|
const eC_Int & |
iSizeY |
|
) |
| |
|
virtual |
◆ SetSleepInterval()
| void CGUIInputMedia::SetSleepInterval |
( |
const eC_UInt & |
uiInterval | ) |
|
set the interval used for internal sleep
- Parameters
-
◆ StopIdle()
| virtual void CGUIInputMedia::StopIdle |
( |
| ) |
|
|
virtual |
Forces the input media to quit idling immediately. Called by the framework if the input media is requested to stop idling immediately. Classes derived from GUIInputMedia should implement StopIdle in such a way, that it interrupts any idling/sleeping code in GetEvent(). virtual is needed if sub-classes need to do extra stuff
Reimplemented in CGUINullInput, CGUIPlaybackInput, CGUIScriptedInput, CGUIInputDirectFb, CGUIInputDeviceUnix, CGUIInputDeviceUnix_Powermate, CGUIInputUnixMouse, CGUIInputWayland, CGUIInputSDL, CGUIInputSDL2, and CGUIInputWindows.
◆ CGUIComponentManager
The documentation for this class was generated from the following file:
