Main Page   Modules   Class Hierarchy   Compound List   Compound Members  

GAUGE3D::GKeyboardMessage Class Reference

Message sent when a key is pressed or released. More...

#include <gauge3d/input/message.h>

Inherits GAUGE3D::GInputMessage.

List of all members.

Public Methods

 GKeyboardMessage (pGObject origin,GString key,GString modified,bool down)
 Create a keyboard message with the given info. More...

virtual ~GKeyboardMessage ()
 Destructor.

GString ModifiedKey ()
 Get the key name with modifiers applied.


Detailed Description

Message sent when a key is pressed or released.

This class is here for two reasons:


Constructor & Destructor Documentation

GAUGE3D::GKeyboardMessage::GKeyboardMessage ( pGObject origin,
GString key,
GString modified,
bool down ) [inline]
 

Create a keyboard message with the given info.

Parameters:
origin   A pointer to the object which is the logical "originator" of the message. For example, most messages will originate from a GDisplay.
key   The name of the key that was pressed or released. If the key has a direct ASCII translation, this should be it. Otherwise, it should be a short but unique name for the key (like "left control").
modified   This is the key with modifier keys (like shift or caps lock) applied. So, if shift is held down and the "a" key is pressed, modified should be "A", whereas key should be "a". If the key is not printable, this will be an empty sting.
down   True if the key was pressed, false if released.

Remarks:
Please, please, if you are writing a plugin which reads input from a keyboard and sends GKeyboardMessages, please make sure to check the system keyboard map! Do NOT assume querty! I have a dvorak keyboard, so I will not use your software if you disregard this.


The documentation for this class was generated from the following file:
Generated at Tue Jan 30 17:07:34 2001 for gauge3d by doxygen1.2.4 written by Dimitri van Heesch, © 1997-2000