darc::protox::DIKeyboardScanner Class Reference

Controller class for a keyboard device. More...

#include <px_keyboard.h>

Inheritance diagram for darc::protox::DIKeyboardScanner:

List of all members.

Public Member Functions
	DIKeyboardScanner ()
DCR	Init (Window *_wnd, GUID *_guid, DWORD _cLevel, PFN_EVENTCALLBACK _func)
	~DIKeyboardScanner ()
virtual DCR	Destroy ()
virtual UInt	getStructSize () const
virtual void *	getStruct ()
virtual DCR	UpdateState ()
	This function updates the m_keyState array.
virtual bool	IsKeyDown (Byte _key) const
	Returns true if a key, specified by its scan code, is pressed.

---

Detailed Description

Controller class for a keyboard device.

Provides basic functionality to receive and process keyboard events. Produces pressed, released, and clicked, double clicked, repeat, and move event management.

---

Constructor & Destructor Documentation

darc::protox::DIKeyboardScanner::DIKeyboardScanner

(

)

[inline]

darc::protox::DIKeyboardScanner::~DIKeyboardScanner

(

)

[inline]

---

Member Function Documentation

DCR darc::protox::DIKeyboardScanner::Destroy

(

)

[virtual]

Reimplemented from darc::protox::PX_DI_Device.

virtual void* darc::protox::DIKeyboardScanner::getStruct

(

)

[inline, virtual]

Implements darc::protox::PX_DI_Device.

virtual UInt darc::protox::DIKeyboardScanner::getStructSize

(

)

const [inline, virtual]

Implements darc::protox::PX_DI_Device.

DCR darc::protox::DIKeyboardScanner::Init	(	Window *	_wnd,
		GUID *	_guid,
		DWORD	_cLevel,
		PFN_EVENTCALLBACK	_func
	)

Initializes the mouse controller.

Parameters:

_wnd	Pointer to a valid window object. This is needed to set the cooperation level.
_guid	Device ID. Can be NULL for the system mouse.
_eventProc	Function to receive mouse events.

bool darc::protox::DIKeyboardScanner::IsKeyDown

(

Byte

_code

)

const [virtual]

Returns true if a key, specified by its scan code, is pressed.

All subclasses must implement a layout specific way to determine a keys status.

See also:

UpdateState()

Implements darc::core::IKeyboardScanner.

DCR darc::protox::DIKeyboardScanner::UpdateState

(

)

[virtual]

This function updates the m_keyState array.

All subclasses must implement a layout specific way to Setup the key states.

See also:

IsKeyDown()

Implements darc::core::IKeyboardScanner.

---

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

• Protox/px_keyboard.h
• Protox/px_keyboard.cpp