GUIOnscreenKeyboardLayout.h

#ifndef __ONSCREEN_KEYBOARD_LAYOUT_H__
#define __ONSCREEN_KEYBOARD_LAYOUT_H__
 
#include "eC_TArray.h"
#include "eC_String.h"
 
#include "GUIRect.h"
 
class CGUIOnscreenKeyboardLayout
{
public:
    enum KeyboardKeyType_t
    {
        KT_UNKNOWN = 0,
        KT_PRINTABLE_KEY,
        KT_SPECIAL_KEY,
        KT_SEPARATOR,
        KT_PAGE_UPPERCASE,
        KT_PAGE_LOWERCASE,
        KT_PAGE_NUMBERS,
        KT_PAGE_SYMBOLS
    };
 
    struct KeyboardSubChars_t;
 
    struct KeyboardKey_t
    {
        KeyboardKey_t() :
            eType(KT_PRINTABLE_KEY),
            kString(""),
            uiKeyCode(0),
            ubWidth(1),
            pkSubChars(NULL)
        {}
 
        KeyboardKey_t(
            const KeyboardKeyType_t& Type,
            const eC_String& Text,
            const eC_UInt& Code,
            const eC_UByte& Width,
            KeyboardSubChars_t* SubChars = NULL) :
            eType(Type),
            kString(Text),
            uiKeyCode(Code),
            ubWidth(Width),
            pkSubChars(SubChars)
        {}
 
        KeyboardKeyType_t eType; 
        eC_String kString; 
        eC_UInt uiKeyCode; 
        eC_UByte ubWidth; 
        CGUIRect kRect; 
        KeyboardSubChars_t* pkSubChars; 
    };
 
    struct KeyboardSubChars_t
    {
        KeyboardSubChars_t() :
            uiNumRows(1)
        {}
 
        eC_UInt uiNumRows; 
        eC_TArray<KeyboardKey_t*> pkKeys; 
    };
 
    struct KeyboardLine_t
    {
        KeyboardLine_t() :
            uiTotalWidth(1)
        {}
 
        eC_UInt uiTotalWidth; 
        CGUIRect kRect; 
        eC_TArray<KeyboardKey_t*> pkKeys; 
    };
 
    enum KeyboardPageType_t
    {
        PT_UNKNOWN = 0,
        PT_LOWERCASE,
        PT_UPPERCASE,
        PT_NUMBERS,
        PT_SYMBOLS
    };
 
    struct KeyboardPage_t
    {
        KeyboardPage_t() :
            eType(PT_UNKNOWN),
            ubIndex(0)
        {}
 
        KeyboardPageType_t eType; 
        eC_UByte ubIndex; 
        eC_TArray<KeyboardLine_t*> pkLines; 
    };
 
public:
    CGUIOnscreenKeyboardLayout();
 
    virtual ~CGUIOnscreenKeyboardLayout();
 
    void Clear();
 
    void CalcKeyRects(const eC_Value& vWidth = eC_FromInt(0), const eC_Value& vHeight = eC_FromInt(0));
 
    eC_UInt GetNumberOfPages() const;
 
    KeyboardPage_t* GetPage(const eC_UInt& uiIndex);
 
    KeyboardPage_t* GetPage(KeyboardLine_t* pkLine);
 
    KeyboardPage_t* GetPage(KeyboardKey_t* pkKey);
 
    eC_Bool FindPage(const KeyboardPageType_t& ePageType, eC_UByte& ubIndex);
 
    void AddPage();
 
    void AddLine(KeyboardPage_t* pkPage);
 
    void AddKey(KeyboardLine_t* pkLine);
 
    void AddSubKey(KeyboardKey_t* pkKey);
 
    eC_Bool DeletePage(KeyboardPage_t* pkPage);
 
    eC_Bool DeleteLine(KeyboardLine_t* pkLine);
 
    eC_Bool DeleteKey(KeyboardKey_t* pkKey);
 
    eC_Bool DeleteSubKey(KeyboardKey_t* pkKey);
 
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
private:
    eC_TArray<KeyboardPage_t*> m_pkPages; 
    eC_Value m_vWidth; 
    eC_Value m_vHeight; 
};
 
#endif