VirtualKey Class Reference

#include <VirtualKey.h>

Public Types
typedef base_type	data_type

Public Member Functions
	VirtualKey ()
	VirtualKey (SysChar character)
	VirtualKey (uint32 keyCode)
	VirtualKey (const VirtualKey &other)
void	ReadWrite (IPMStream *s)
VirtualKey &	operator= (const VirtualKey &copy)
bool16	operator< (const VirtualKey &other) const
bool16	operator== (const VirtualKey &s) const
bool16	operator!= (const VirtualKey &s) const
SysChar	GetChar () const
bool16	IsPlainChar () const
bool16	IsPressed () const
uint32	GetDVKeyCode () const

Detailed Description

This class encapsulates a platform independant way to handle 'virtual keys'. This allows us to do smart matching of keys that generate a plain character, as well as the tricker keys which generate extended characters or no characters. This is mostly used in our keyboard shortcut handling code. Usually code that needs a virtual key either gets it passed in, or they get one by calling IEvent::

Member Typedef Documentation

typedef base_type VirtualKey::data_type

This type is a base type. It has no special copy semantics.

See Also

K2Vector.h

Constructor & Destructor Documentation

VirtualKey::VirtualKey ( )

inline

Various constructors. Just record the passed in keycode and character code.

Member Function Documentation

SysChar VirtualKey::GetChar ( ) const

inline

Get the character for this object. Return value is 0 if IsPlainChar is false.

Returns

the raw character

uint32 VirtualKey::GetDVKeyCode ( ) const

inline

Get the drover key code for this object

Returns

the raw drover key code

bool16 VirtualKey::IsPlainChar

(

)

const

Check if this virtual key represents a plain printable character.

Returns

kTrue if this is a plain character.

bool16 VirtualKey::IsPressed

(

)

const

Check if this virtual key is pressed down

Returns

kTrue if this key is down.

bool16 VirtualKey::operator!= ( const VirtualKey &  s ) const

inline

Inequality operator. Does intelligent matching on both mac and windows

Parameters

s	the object to compare to.

Returns

kTrue if this object is not logically equal to the object passed in

bool16 VirtualKey::operator< ( const VirtualKey &  other ) const

inline

Less than operator. Implemented so that sorting of this object will work.

Parameters

other

the object to compare to.

Returns

kTrue if this object is logically less than the object passed in

VirtualKey& VirtualKey::operator= ( const VirtualKey &  copy )

inline

Assignment

Parameters

copy	the object to copy into this one.

bool16 VirtualKey::operator==

(

const VirtualKey &

s

)

const

Equality operator. Does intelligent matching on both mac and windows

Parameters

s	the object to compare to.

Returns

kTrue if this object is logically equal to the object passed in

void VirtualKey::ReadWrite

(

IPMStream *

s

)

Read or write this object from/to a stream

Parameters

s	the stream to read/write from/to