CGUIInputMedia Class Reference

#include <GUIInputMedia.h>

Inheritance diagram for CGUIInputMedia:

Public Types
enum	Rotation_t { ROTATION_0 , ROTATION_90 , ROTATION_180 , ROTATION_270 }
	rotation of input-device

Public Member Functions
eC_Bool	GetDebugMode () const
virtual CGUIEvent *	GetEvent (eC_UInt uiIdleTime)=0
virtual void	GetOffset (eC_Int &riOffsetX, eC_Int &riOffsetY) const
Rotation_t	GetRotation () const
virtual void	GetSize (eC_Int &riSizeX, eC_Int &riSizeY) const
eC_UInt	GetSleepInterval () const
void	SetDebugMode (const eC_Bool &bDebugMode)
virtual void	SetOffset (const eC_Int &iOffsetX, const eC_Int &iOffsetY)
void	SetRotation (const Rotation_t &eRotation)
virtual void	SetSize (const eC_Int &iSizeX, const eC_Int &iSizeY)
void	SetSleepInterval (const eC_UInt &uiInterval)
virtual void	StopIdle ()

Static Public Member Functions
static void	DeleteInstance ()

Protected Member Functions
	CGUIInputMedia ()
virtual	~CGUIInputMedia ()

Protected Attributes
eC_Bool	m_bDebugMode
	debug-mode for input-device
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_uiSleepInterval
	sleep interval

Friends
class	CGUIComponentManager

Detailed Description

Base-class for all input devices that are attachable to the GUI.

See also

Porting User Input for Guiliani

Constructor & Destructor Documentation

CGUIInputMedia()

CGUIInputMedia::CGUIInputMedia ( )

protected

constructor

~CGUIInputMedia()

virtual CGUIInputMedia::~CGUIInputMedia ( )

protectedvirtual

destructor

Member Function Documentation

DeleteInstance()

static void CGUIInputMedia::DeleteInstance ( )

static

Delete Instance

GetDebugMode()

eC_Bool CGUIInputMedia::GetDebugMode

(

)

const

Return if debug-mode for input-device is active

Returns

true if active

GetEvent()

virtual CGUIEvent * CGUIInputMedia::GetEvent ( eC_UInt  uiIdleTime )

pure virtual

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.

Implemented in CGUINullInput, CGUIPlaybackInput, CGUIScriptedInput, CGUIInputDirectFb, CGUIInputDeviceUnix, CGUIInputDeviceUnix_Powermate, CGUIInputUnixMouse, CGUIInputSDL, CGUIInputSDL2, CGUIInput_STM32F429, CGUIInput_STM32F746, and CGUIInputWindows.

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()

Rotation_t CGUIInputMedia::GetRotation

(

)

const

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

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

SetOffset()

virtual void CGUIInputMedia::SetOffset ( const eC_Int &  iOffsetX, const eC_Int &  iOffsetY  )

virtual

set the offset for the input-device

Parameters

iOffsetX	x-offset
iOffsetY	y-offset

Reimplemented in CGUIPlaybackInput, and CGUIInputDeviceUnix.

SetRotation()

void CGUIInputMedia::SetRotation

(

const Rotation_t &

eRotation

)

Set the rotation of the input-device

Parameters

eRotation

SetSize()

virtual void CGUIInputMedia::SetSize ( const eC_Int &  iSizeX, const eC_Int &  iSizeY  )

virtual

set the size for the input-device

Parameters

iSizeX	width
iSizeY	height

Reimplemented in CGUIPlaybackInput, CGUIInputDeviceUnix, and CGUIInputUnixMouse.

SetSleepInterval()

void CGUIInputMedia::SetSleepInterval

(

const eC_UInt &

uiInterval

)

set the interval used for internal sleep

Parameters

uiInterval

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, CGUIInputSDL, CGUIInputSDL2, CGUIInputWindows, CGUIInput_STM32F429, and CGUIInput_STM32F746.

Friends And Related Function Documentation

CGUIComponentManager

friend class CGUIComponentManager

friend

---

The documentation for this class was generated from the following file:

• GUIInputMedia.h