The implementation of the Input Wrapper for Linux. More...

#include <GUIInputSDL.h>

Inheritance diagram for CGUIInputSDL:

Public Member Functions
CGUIEvent *	GetEvent (eC_UInt uiIdleTime)

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

Protected Member Functions
GUIKeyIdentifier_t	GetKeyID (const SDL_keysym &eSdlKeySym, eC_UInt uiModifiers, eC_Bool &rbIsChar)

Protected Member Functions inherited from CGUIInputMedia
	CGUIInputMedia ()

virtual	~CGUIInputMedia ()

Additional Inherited Members
Public Types inherited from CGUIInputMedia
enum	Rotation_t { ROTATION_0 , ROTATION_90 , ROTATION_180 , ROTATION_270 }
	rotation of input-device

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

The implementation of the Input Wrapper for Linux.

Member Function Documentation

◆ CreateInstance()

static void CGUIInputSDL::CreateInstance ( )

static

Singleton for creating a input window object and change the pointer in base class to input window.

◆ GetEvent()

CGUIEvent * CGUIInputSDL::GetEvent ( eC_UInt uiIdleTime )

virtual

Gets an event from the system.

Parameters

uiIdleTime Maximum idle time after which the method returns.

Returns: Pointer to the event object.

Implements CGUIInputMedia.

◆ GetKeyID()

GUIKeyIdentifier_t CGUIInputSDL::GetKeyID	(	const SDL_keysym &	eSdlKeySym,
		eC_UInt	uiModifiers,
		eC_Bool &	rbIsChar
	)

protected

Solves a pressed or released SDL keyboard key to GK_-key values.

Parameters

eSdlKeySym	The SDL Keysym to solve value, i.e. SDLK_ value.
uiModifiers	Is a modifier key pressed (CTRL, ALT, etc.)
rbIsChar	[out] Is set true by this routine in case of the input SDL key is a printable character, e.g. alphanumeric.

Returns: The GK_-key that is mapped to the SDL-key, or GK_NONE, if the key is not mapped to a specific GK_-key.

◆ StopIdle()

void CGUIInputSDL::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 from CGUIInputMedia.

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

GUIInputSDL.h

Public Member Functions

Static Public Member Functions