CGUIInputUnixMouse Class Reference

#include <GUIInputUnixMouse.h>

Inheritance diagram for CGUIInputUnixMouse:

Public Member Functions
eC_TListDoubleLinked< CGUIEvent * > &	GetEventQueue ()
pthread_cond_t *	GetInputEventCond ()
void	LockSemaphore ()
virtual void	PollEvent ()
virtual void	SetSize (const eC_Int &iSizeX, const eC_Int &iSizeY)
virtual void	StopIdle ()
void	UnlockSemaphore ()
Public Member Functions inherited from CGUIInputMedia
void	AddEvent (CGUIEvent *pkEvent)
eC_Bool	GetDebugMode () const
CGUIEvent *	GetEvent (eC_UInt uiIdleTime)
eC_UInt	GetMaxEventThreshold () const
eC_UInt	GetMinEventThreshold () const
virtual eC_Bool	GetMulitpleTouches () const
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
virtual void	PollEvent ()
CGUIEvent *	RetrieveEvent ()
void	SetDebugMode (const eC_Bool &bDebugMode)
void	SetMaxEventThreshold (const eC_UInt &uiMaxEventThreshold)
void	SetMinEventThreshold (const eC_UInt &uiMinEventThreshold)
virtual void	SetMultipleTouches (const eC_Bool &bMultipleTouches)
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 (const char *cpcMDevice, const eC_Int &iMouseMaxPosX=0, const eC_Int &iMouseMaxPosY=0, const eC_Bool &bInvertYAxis=false)
Static Public Member Functions inherited from CGUIInputMedia
static void	DeleteInstance ()

Protected Member Functions
	CGUIInputUnixMouse (const char *cpcMDevice, const eC_Int &iMouseMaxPosX, const eC_Int &iMouseMaxPosY, const eC_Bool &bInvertYAxis)
Protected Member Functions inherited from CGUIInputMedia
	CGUIInputMedia (const eC_Bool &bQueuedEvents=false, const AcquisitionType_t &eType=Polling)
virtual	~CGUIInputMedia ()

Additional Inherited Members
Public Types inherited from CGUIInputMedia
enum	AcquisitionType_t { Polling , Callback }
	how events are collected
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_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

Detailed Description

Mouse Input implementation for Unix based targets without support for SDL.

Deprecated:

This is a provisional implementation in alpha-state and will be removed. Use CGUIInputSDL instead.

Constructor & Destructor Documentation

CGUIInputUnixMouse()

CGUIInputUnixMouse::CGUIInputUnixMouse ( const char *  cpcMDevice, const eC_Int &  iMouseMaxPosX, const eC_Int &  iMouseMaxPosY, const eC_Bool &  bInvertYAxis  )

protected

constructor

Parameters

cpcMDevice
iMouseMaxPosX
iMouseMaxPosY
bInvertYAxis

Member Function Documentation

CreateInstance()

static void CGUIInputUnixMouse::CreateInstance ( const char *  cpcMDevice, const eC_Int &  iMouseMaxPosX = 0, const eC_Int &  iMouseMaxPosY = 0, const eC_Bool &  bInvertYAxis = false  )

static

Create a instance of this input wrapper

Parameters

cpcMDevice	device
iMouseMaxPosX
iMouseMaxPosY
bInvertYAxis

GetEventQueue()

eC_TListDoubleLinked< CGUIEvent * > & CGUIInputUnixMouse::GetEventQueue

(

)

get the event queue

Returns

queue

GetInputEventCond()

pthread_cond_t * CGUIInputUnixMouse::GetInputEventCond

(

)

get the condition variable

Returns

condition

LockSemaphore()

void CGUIInputUnixMouse::LockSemaphore

(

)

lock the semaphore

PollEvent()

virtual void CGUIInputUnixMouse::PollEvent ( )

virtual

this method will be called if the input device uses polling to receive events

Reimplemented from CGUIInputMedia.

SetSize()

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

virtual

set the size for the input-device if negative values are used the axis is inverted

Parameters

iSizeX	width
iSizeY	height

Reimplemented from CGUIInputMedia.

StopIdle()

virtual void CGUIInputUnixMouse::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.

UnlockSemaphore()

void CGUIInputUnixMouse::UnlockSemaphore

(

)

unlock the semaphore

---

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

• GUIInputUnixMouse.h