Public Types | Public Member Functions

FIFE::Key Class Reference

#include <ec_key.h>

List of all members.

Public Types

enum  KeyType

Public Member Functions

 Key (KeyType key=INVALID_KEY, uint32_t codepoint=0)
virtual ~Key ()
bool isPrintable () const
KeyType getValue () const
std::string getAsString () const

Detailed Description

Represents a key or a character.

Definition at line 41 of file ec_key.h.


Member Enumeration Documentation

Codes for different keys

Definition at line 45 of file ec_key.h.


Constructor & Destructor Documentation

FIFE::Key::Key ( KeyType  key = INVALID_KEY,
uint32_t  codepoint = 0 
) [inline]

Constructor

Parameters:
value value of the key
codepoint Unicode representation of the key

Definition at line 284 of file ec_key.h.

virtual FIFE::Key::~Key (  )  [inline, virtual]

Destructor.

Definition at line 290 of file ec_key.h.


Member Function Documentation

std::string FIFE::Key::getAsString (  )  const [inline]

Gets the string representation of the key, encoded as UTF-8.

Definition at line 311 of file ec_key.h.

KeyType FIFE::Key::getValue (  )  const [inline]

Gets the value of the key.

Definition at line 305 of file ec_key.h.

bool FIFE::Key::isPrintable (  )  const [inline]

Tells whether the Key can be represented as a string.

Definition at line 294 of file ec_key.h.


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