Ars::KeyboardMessage Class Reference

#include <arsmessages.h>

Inheritance diagram for Ars::KeyboardMessage:

[legend]Collaboration diagram for Ars::KeyboardMessage:

[legend]

Public Member Functions
	KeyboardMessage (const EMessageType MessageType, MessageClient *pDestination, const unsigned char ScanCode, const SDLMod Modifiers, const SDLKey Key, const Uint16 Unicode)
Data Fields
const unsigned char	ScanCode
	ScanCode The scan code of the key pressed.
const SDLMod	Modifiers
	Modifiers Any modifier keys that are being pressed (alt, ctrl, shift, etc).
const SDLKey	Key
	Key The SDLKey that defines the key pressed.
const Uint16	Unicode
	The unicode character the keypress corresponds to.

---

Constructor & Destructor Documentation

Ars::KeyboardMessage::KeyboardMessage (  const EMessageType  MessageType, MessageClient *  pDestination, const unsigned char  ScanCode, const SDLMod  Modifiers, const SDLKey  Key, const Uint16  Unicode )  [inline]

Construct a new Keyboard message Parameters: MessageType  The type of message being created pDestination  A pointer to the window that the message is destined for (0 for no specific destination, or to broadcast to all) ScanCode  The scan code of the key pressed Modifiers  Any modifier keys that are being pressed (alt, ctrl, shift, etc) Key  The SDLKey that defines the key pressed Unicode  The unicode character the keypress corresponds to Definition at line 80 of file arsmessages.h. References Unicode. : Message( MessageType , pDestination ) , ScanCode(ScanCode), Modifiers(Modifiers), Key(Key), Unicode(Unicode) {}

---

Field Documentation

const SDLKey Ars::KeyboardMessage::Key

Key The SDLKey that defines the key pressed. Definition at line 86 of file arsmessages.h. Referenced by Ars::XListBox::evKeyDown(), and Ars::XEditBox::evKeyDown().

const SDLMod Ars::KeyboardMessage::Modifiers

Modifiers Any modifier keys that are being pressed (alt, ctrl, shift, etc). Definition at line 85 of file arsmessages.h. Referenced by Ars::XEditBox::evKeyDown().

const unsigned char Ars::KeyboardMessage::ScanCode

ScanCode The scan code of the key pressed. Definition at line 84 of file arsmessages.h.

const Uint16 Ars::KeyboardMessage::Unicode

The unicode character the keypress corresponds to. Definition at line 87 of file arsmessages.h. Referenced by Ars::XEditBox::evKeyDown(), and KeyboardMessage().

---

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

• arsmessages.h

---