GUIOnscreenKeyboard.h

#if !defined(ONSCREENKEYBOARD_H)
#define ONSCREENKEYBOARD_H
 
#include "GUIObject.h"
 
#include "GUIOnscreenKeyboardLayout.h"
 
#include "GUIColorPropertyObserver.h"
#include "GUIImageResource.h"
#include "GUIFontResource.h"
#include "GUIObjectHandleResource.h"
#include "GUIEdit.h"
#include "GUINinePatch.h"
#include "GUIGeneralResourceManager.h"
 
class CGUIOnscreenKeyboard : public CGUIObject, public CGUIColorPropertyObserver
{
public:
    struct SelectedButton_t
    {
        SelectedButton_t() :
            bSelected(false),
            uiLineIndex(0),
            uiKeyIndex(0),
            bSubCharsSelected(false),
            uiSubCharLineIndex(0),
            uiSubCharsKeyIndex(0)
        {}
 
        void Set(const eC_UInt& LineIndex, const eC_UInt& KeyIndex)
        {
            bSelected = true;
            uiLineIndex = LineIndex;
            uiKeyIndex = KeyIndex;
        }
 
        void Reset()
        {
            bSelected = false;
            uiLineIndex = 0;
            uiKeyIndex = 0;
            bSubCharsSelected = false;
            uiSubCharLineIndex = 0;
            uiSubCharsKeyIndex = 0;
        }
 
        void SetSubChars(const eC_UInt& LineIndex, const eC_UInt& KeyIndex)
        {
            bSubCharsSelected = true;
            uiSubCharLineIndex = LineIndex;
            uiSubCharsKeyIndex = KeyIndex;
        }
 
        eC_Bool Equals(const eC_UInt& LineIndex, const eC_UInt& KeyIndex)
        {
            if (bSelected)
            {
                if ((LineIndex == uiLineIndex) && (KeyIndex == uiKeyIndex))
                    return true;
            }
            return false;
        }
 
        eC_Bool bSelected; 
        eC_UInt uiLineIndex; 
        eC_UInt uiKeyIndex; 
        eC_Bool bSubCharsSelected; 
        eC_UInt uiSubCharLineIndex; 
        eC_UInt uiSubCharsKeyIndex; 
    };
 
public:
    CGUIOnscreenKeyboard(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIOnscreenKeyboard();
 
    ~CGUIOnscreenKeyboard();
 
    void LoadLayout(const GeneralResource_t& reResource);
 
    eC_Bool LoadLayout(eC_File* pkFile, const eC_String& kFileExtension);
 
    eC_Bool LoadLayout(const eC_String& rkLayoutFile);
 
    CGUIOnscreenKeyboardLayout* GetLayout() const;
 
    void SetLayout(CGUIOnscreenKeyboardLayout* pkLayout);
 
    // attributes
    void SetFont(const FontResource_t& eFont);
 
    FontResource_t GetFont() const;
 
    void SetFontColor(const GlobalProperty_t& eProperty);
 
    void SetFontColor(const eC_UInt& uiColor);
 
    eC_UInt GetFontColor() const;
 
    void SetFontColorSelected(const GlobalProperty_t& eProperty);
 
    void SetFontColorSelected(const eC_UInt& uiColor);
 
    eC_UInt GetFontColorSelected() const;
 
    void SetBackgroundImage(const ImageResource_t& eImage);
 
    ImageResource_t GetBackgroundImage() const;
 
    void SetBackgroundColor(const GlobalProperty_t& eProperty);
 
    void SetBackgroundColor(const eC_UInt& uiColor);
 
    eC_UInt GetBackgroundColor() const;
 
    void SetBackgroundImageSelected(const ImageResource_t& eImage);
 
    ImageResource_t GetBackgroundImageSelected() const;
 
    void SetBackgroundColorSelected(const GlobalProperty_t& eProperty);
 
    void SetBackgroundColorSelected(const eC_UInt& uiColor);
 
    eC_UInt GetBackgroundColorSelected() const;
 
    void SetOverlayColor(const GlobalProperty_t& eProperty);
 
    void SetOverlayColor(const eC_UInt& uiColor);
 
    eC_UInt GetOverlayColor() const;
 
    void SetOverlayImage(const ImageResource_t& eImage);
 
    ImageResource_t GetOverlayImage() const;
 
    CGUINinePatch& GetNinePatch();
 
    void SetTargetObject(const ObjectHandle_t& eObjectID);
 
    ObjectHandle_t GetTargetObject() const;
 
    void SetUseOverlay(const eC_Bool& bUseOverlay);
 
    eC_Bool GetUseOverlay() const;
 
    void SetAllowSubChars(const eC_Bool& bAllowSubChars);
 
    eC_Bool GetAllowSubChars() const;
 
    void SetPageIndex(const eC_UByte& ubPageIndex);
 
    eC_UInt GetPageIndex() const;
 
    virtual void SetWidth(const eC_Value& vWidth);
    virtual void SetHeight(const eC_Value& vHeight);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    virtual eC_Bool DoDraw();
 
    virtual eC_Bool DoButtonDown(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoButtonUp(
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoDrag(
        const eC_Value& vDeltaX = eC_FromInt(-1),
        const eC_Value& vDeltaY = eC_FromInt(-1),
        const eC_Value& vAbsX = eC_FromInt(-1),
        const eC_Value& vAbsY = eC_FromInt(-1));
 
#if defined(GUILIANI_STREAM_GUI)
    virtual void ReadFromStream();
#endif
 
#if defined(GUILIANI_WRITE_GUI)
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
private:
    void Init();
    void DeInit();
 
    void DrawKey(
        eC_String* pkString,
        const eC_Value& vPosX,
        const eC_Value& vPosY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const eC_UInt& uiColor);
 
    void GetObject();
 
    eC_Bool GetKeyIndex(
        const eC_Value& vAbsX, const eC_Value& vAbsY,
        eC_Bool& bSubChars,
        eC_UInt& ruiLineIndex, eC_UInt& ruiKeyIndex) const;
 
    CGUIOnscreenKeyboardLayout::KeyboardKey_t* GetSelectedKey() const;
 
    void InsertKey();
 
    void StartTimer(const eC_UInt& uiInterval);
    void StopTimer();
 
    void ExpandKeyboard(const eC_Value& vNeededHeight);
    void ResetKeyboard();
 
    void DrawSelectedBackground(const CGUIRect& kRect);
 
private:
    static const eC_UInt INDEX_FONT_COLOR;
    static const eC_UInt INDEX_FONT_COLOR_SELECTED;
    static const eC_UInt INDEX_BACKGROUND_COLOR;
    static const eC_UInt INDEX_BACKGROUND_COLOR_SELECTED;
    static const eC_UInt INDEX_BACKGROUND_COLOR_OVERLAY;
 
    GeneralResource_t m_eLayout;
 
    FontResource_t m_eFont;
    ImageResource_t m_eImage;
    ImageResource_t m_eImageSelected;
    ImageResource_t m_eImageOverlay;
 
    CGUINinePatch m_kNinePatch;
 
    ObjectHandle_t m_eTargetObject;
    CGUIEdit* m_pkEdit;
 
    eC_UByte m_ubCurrentPageIndex;
    CGUIOnscreenKeyboardLayout* m_pkLayout;
 
    eC_Bool m_bShowSubChars;
    CGUIRect m_kSubCharsRect;
    eC_Bool m_bButtonDown;
    SelectedButton_t m_kLastSelectedButton;
 
    eC_Bool m_bUseOverlay;
    eC_Bool m_bAllowSubChars;
    eC_Bool m_bExpanded;
    eC_Value m_vOriginalYPos;
    eC_Value m_vOriginalHeight;
    eC_Bool m_bTimerTriggered;
};
 
class OnScreenKeyboardLayoutInterpreter : public CGUIGeneralResourceInterpreter
{
public:
    OnScreenKeyboardLayoutInterpreter(CGUIOnscreenKeyboard* pkObject, const eC_String& kFileExtension) :
        CGUIGeneralResourceInterpreter(),
        m_pkObject(pkObject),
        m_kFileExtension(kFileExtension)
    {}
 
    virtual void Interpret(eC_File* pkFile)
    {
        if (NULL != m_pkObject)
            m_pkObject->LoadLayout(pkFile, m_kFileExtension);
    }
 
private:
    CGUIOnscreenKeyboard* m_pkObject; 
    eC_String m_kFileExtension; 
};
 
#endif