os::Keymap Class Reference

Keymap class. More...

Public Member Functions
	Keymap (const os::String &cKeymap="")
	Default Constructor... More...
virtual	~Keymap ()
int32_t	Find (char zFind)
	Finds a character in the keymap based on the normal key set. More...
std::vector< std::pair < int32_t, int32_t > >	FindAllOccurances (char zFind)
	Finds all occurances of the character in all of the keymap. More...
std::vector< int32_t >	GetKeys ()
	Returns an std::vector of ints corresponding to the normal keys in the keymap. More...
keymap *	GetKeymapData () const

Static Public Member Functions
static os::String	GetKeymapDirectory ()
	Get the keymap directory. More...
static std::vector< os::String >	GetKeymapNames ()
	Gets all keymap names that the appserver can currently use. More...

Detailed Description

Description:

Keymaps are handled by the appserver, but as time goes on we realized that we needed some way of allowing the user to see this data.

Note

This class will allow you to see the data, but not manipulate anything

A brief history on how keymaps work in Syllable: A keymap starts out as a plain text file in Syllable and then is converted into a binary file for use in the appserver. This binary file can be pretty hard to decipher, but if you need a glimpse into how it works take a look at appserver/keymap.h in your include directory.

Author

Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)

Constructor & Destructor Documentation

Keymap::Keymap

(

const os::String &

cKeymap = ""

)

Parameters

cKeymap

- an os::String that contains the actual keymap you want to look at. If you just create an instance with Keymap() the class will use the current keymap loaded by the appserver

Author

Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)

Keymap::~Keymap ( )

virtual

Member Function Documentation

int32_t Keymap::Find

(

char

zFind

)

Author

Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)

std::vector< std::pair< int32_t, int32_t > > Keymap::FindAllOccurances

(

char

zFind

)

Author

Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)

keymap * Keymap::GetKeymapData

(

)

const

os::String Keymap::GetKeymapDirectory ( )

static

Author

Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)

Referenced by GetKeymapNames(), and os::Application::SetKeymap().

std::vector< os::String > Keymap::GetKeymapNames ( )

static

Author

Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)

References GetKeymapDirectory(), and os::Directory::GetNextEntry().

std::vector< int32_t > Keymap::GetKeys

(

)

Author

Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)