PKeyboard Class Reference

#include <PKeyboard.h>

Inheritance diagram for PKeyboard:

Public Member Functions
	PKeyboard ()
	The Standard constructor.
virtual	~PKeyboard ()
	The Standard destructor.
virtual PEBL_Keycode	TranslateString (std::string letter) const
	Translate a letter string to the appropriate keyboard symbol.
virtual std::string	TranslateKeyCode (const PEBL_Keycode code) const
virtual PEBL_Keycode	IsKeyDown (PEBL_Keycode code) const =0
virtual bool	IsKeyUp (PEBL_Keycode code) const =0
virtual int	GetState (int iface) const
virtual PEBL_DEVICE_TYPE	GetDeviceType ()
virtual int	GetModKeys () const
Public Member Functions inherited from PDevice
	PDevice ()
	The Standard constructor.
virtual	~PDevice ()
	The Standard destructor.

Protected Member Functions
virtual std::ostream &	SendToStream (std::ostream &out) const

Detailed Description

This is the base Keyboard class. It is 'virtual' and must be overridden by a PlatformKeyboard class, but contains keycodes

Definition at line 342 of file PKeyboard.h.

Constructor & Destructor Documentation

PKeyboard()

PKeyboard::PKeyboard

(

)

The Standard constructor.

This is the standard pNode constructor.

Definition at line 38 of file PKeyboard.cpp.

{
    //Standard Constructor
}

~PKeyboard()

PKeyboard::~PKeyboard ( )

virtual

The Standard destructor.

This is the standard pNode destructor.

Definition at line 44 of file PKeyboard.cpp.

{
    // Standard Destructor
}

Member Function Documentation

GetDeviceType()

virtual PEBL_DEVICE_TYPE PKeyboard::GetDeviceType ( )

inlinevirtual

Reimplemented from PDevice.

Definition at line 370 of file PKeyboard.h.

{return PDT_KEYBOARD;};

References PDT_KEYBOARD.

GetModKeys()

int PKeyboard::GetModKeys ( ) const

virtual

Definition at line 81 of file PKeyboard.cpp.

{
    PError::SignalFatalError("Getting generic state with PKeyboard::GetModKeys");
    return 0;
}

References PError::SignalFatalError().

GetState()

int PKeyboard::GetState ( int  iface ) const

virtual

Reimplemented from PDevice.

Reimplemented in PlatformKeyboard.

Definition at line 74 of file PKeyboard.cpp.

{
     cerr << "*****Error:  Getting generic state with PKeyboard::GetState\n" ;
     return 1;
}

IsKeyDown()

virtual PEBL_Keycode PKeyboard::IsKeyDown ( PEBL_Keycode  code ) const

pure virtual

This will test whether a specific key is down, and return true if it is.

Implemented in PlatformKeyboard, and PlatformKeyboard.

IsKeyUp()

virtual bool PKeyboard::IsKeyUp ( PEBL_Keycode  code ) const

pure virtual

This will test whether a specific key is up, and return true if it is.

Implemented in PlatformKeyboard, and PlatformKeyboard.

SendToStream()

ostream & PKeyboard::SendToStream ( std::ostream &  out ) const

protectedvirtual

Reimplemented from PDevice.

Reimplemented in PlatformKeyboard, and PlatformKeyboard.

Definition at line 52 of file PKeyboard.cpp.

{
    out << "<Generic Keyboard>" << std::flush;
    return out;
}

TranslateKeyCode()

std::string PKeyboard::TranslateKeyCode ( const PEBL_Keycode  code ) const

virtual

Definition at line 69 of file PKeyboard.cpp.

{
    return PEBLUtility::TranslateKeycode(key, PEBLMOD_NONE);
}

References PEBLMOD_NONE, and PEBLUtility::TranslateKeycode().

TranslateString()

PEBL_Keycode PKeyboard::TranslateString ( std::string  letter ) const

virtual

Translate a letter string to the appropriate keyboard symbol.

This does as best as it can to translate the letter string into a keyboard key.

Definition at line 63 of file PKeyboard.cpp.

{
    return PEBLUtility::TranslateString(letter);
}

References PEBLUtility::TranslateString().

---

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

• PKeyboard.h
• PKeyboard.cpp