CGUIInputWindows Class Reference

Standard input Wrapper for systems running a windows OS. More...

#include <GUIInputWindows.h>

Inheritance diagram for CGUIInputWindows:

Public Member Functions
eC_Bool	GetEmulateTouchScreen () const
void	SetEmulateTouchScreen (const eC_Bool &bEmulateTouchScreen)
virtual void	StopIdle ()
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 HWND &hWnd, const eC_Bool &bEmulateTouchScreen=false)
Static Public Member Functions inherited from CGUIInputMedia
static void	DeleteInstance ()

Protected Member Functions
	CGUIInputWindows (const HWND &hWnd, const eC_Bool &bEmulateTouchScreen=false)
	~CGUIInputWindows ()
virtual CGUIEvent *	CreateGuilianiEventFromWindowsMessage (MSG &kMsg)
virtual void	PollEvent ()
Protected Member Functions inherited from CGUIInputMedia
	CGUIInputMedia (const eC_Bool &bQueuedEvents=false, const AcquisitionType_t &eType=Polling)
virtual	~CGUIInputMedia ()

Protected Attributes
eC_Bool	m_bEmulateTouchScreen
	if this is true the moving of mouse will only create ET_MOUSEMOVE while a mouse-button is pressed
eC_Bool	m_bLeftButtonPressed
	Indicate that the left mouse button is currently pressed.
eC_Bool	m_bRightButtonPressed
	Indicate that the right mouse button is currently pressed.
HWND	m_hWnd
	Handle to associated window.
int	m_iLastX
	last mouse-position x
int	m_iLastY
	last mouse-position y
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

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

Detailed Description

Standard input Wrapper for systems running a windows OS.

Constructor & Destructor Documentation

CGUIInputWindows()

CGUIInputWindows::CGUIInputWindows ( const HWND &  hWnd, const eC_Bool &  bEmulateTouchScreen = false  )

protected

Constructor

Parameters

hWnd	Window handle
bEmulateTouchScreen	true if touch-screen-like behaviour should be forced

~CGUIInputWindows()

CGUIInputWindows::~CGUIInputWindows ( )

protected

Destructor

Member Function Documentation

CreateGuilianiEventFromWindowsMessage()

virtual CGUIEvent * CGUIInputWindows::CreateGuilianiEventFromWindowsMessage ( MSG &  kMsg )

protectedvirtual

Creates a Guiliani Event from the given windows message

Parameters

kMsg	Windows message for which a corresponding Guiliani event shall be created

Returns

Newly created Guiliani event (or NULL)

CreateInstance()

static void CGUIInputWindows::CreateInstance ( const HWND &  hWnd, const eC_Bool &  bEmulateTouchScreen = false  )

static

Creates the singleton instance.

Parameters

hWnd	handle to window
bEmulateTouchScreen	if true mouse-move without pressed button will not result in any action

GetEmulateTouchScreen()

eC_Bool CGUIInputWindows::GetEmulateTouchScreen

(

)

const

get emulate touchscreen-setting

Returns

true if active

PollEvent()

virtual void CGUIInputWindows::PollEvent ( )

protectedvirtual

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

Reimplemented from CGUIInputMedia.

SetEmulateTouchScreen()

void CGUIInputWindows::SetEmulateTouchScreen

(

const eC_Bool &

bEmulateTouchScreen

)

set emulate touchscreen

Parameters

bEmulateTouchScreen

if set to true ET_MOUSEMOVE is only created while a mouse-button is pressed

StopIdle()

virtual void CGUIInputWindows::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:

• GUIInputWindows.h