CGUINullInput Class Reference

This is the Null Input-Wrapper class. More...

#include <GUINullInput.h>

Inheritance diagram for CGUINullInput:

Public Member Functions
CGUIEvent *	GetEvent (eC_UInt uiIdleTime)
virtual void	StopIdle ()
Public Member Functions inherited from CGUIInputMedia
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	CreateInstance ()
Static Public Member Functions inherited from CGUIInputMedia
static void	DeleteInstance ()

Additional Inherited Members
Public Types inherited from CGUIInputMedia
enum	Rotation_t { ROTATION_0 , ROTATION_90 , ROTATION_180 , ROTATION_270 }
	rotation of input-device
Protected Member Functions inherited from CGUIInputMedia
	CGUIInputMedia ()
virtual	~CGUIInputMedia ()
Protected Attributes inherited from CGUIInputMedia
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

Detailed Description

This is the Null Input-Wrapper class.

It implements a null Input-Wrapper for Guiliani testing.

Member Function Documentation

CreateInstance()

static void CGUINullInput::CreateInstance ( )

inlinestatic

Singleton for creating a null Input-Wrapper.

GetEvent()

CGUIEvent * CGUINullInput::GetEvent ( eC_UInt  uiIdleTime )

inlinevirtual

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.

Implements CGUIInputMedia.

StopIdle()

virtual void CGUINullInput::StopIdle ( )

inlinevirtual

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 from CGUIInputMedia.

---

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

• GUINullInput.h