GUIKeyboard.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
#ifndef GUIKEYBOARD_H_
#define GUIKEYBOARD_H_
 
#include "GUIColorPropertyObserver.h"
#include "GUICompositeObject.h"
#include "GUIBehaviourDecorator.h"
#include "GUIFontResource.h"
#include "GUIGeneralResource.h"
#include "GUIGeneralResourceManager.h"
#include "GUIImageResource.h"
 
class CGUIButton;
 
 
// @guiliani_doxygen toplevel_control Keyboard
// @endguiliani_doxygen
class CGUIKeyboard : public CGUICompositeObject, public CGUIColorPropertyObserver
{
public:
    CGUIKeyboard(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const ObjectHandle_t eTargetObjectID,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIKeyboard();
 
    virtual ~CGUIKeyboard();
 
    eC_Bool LoadLayout(const eC_String& rkLayoutFile);
 
    void LoadLayout(const GeneralResource_t& reResource);
 
    eC_Bool LoadLayout(eC_File* pkFile, const eC_String& kFileExtension);
 
    void SetTargetObject(const ObjectHandle_t eTargetObject) { m_eTargetObject = eTargetObject; }
 
    void HandleKey(const eC_UInt uiKeycode);
 
    void SetLayout(const GeneralResource_t& eLayout);
 
    GeneralResource_t GetLayout() const;
 
    void SetFont(const FontResource_t& eFont);
 
    void SetColors(
        const eC_UInt& uiColorStandard,
        const eC_UInt& uiColorHighlighted,
        const eC_UInt& uiColorGrayedOut,
        const eC_UInt& uiColorPressed);
 
    void SetColors(
        const GlobalProperty_t& eColorStandard,
        const GlobalProperty_t& eColorHighlighted,
        const GlobalProperty_t& eColorGrayedOut,
        const GlobalProperty_t& eColorPressed);
 
    void GetColors(
        eC_UInt& uiColorStandard,
        eC_UInt& uiColorHighlighted,
        eC_UInt& uiColorGrayedOut,
        eC_UInt& uiColorPressed);
 
    void SetImages(
        const ImageResource_t& eImageNormal,
        const ImageResource_t& eImageHighlighted,
        const ImageResource_t& eImagePressed,
        const ImageResource_t& eImageGrayedOut,
        const ImageResource_t& eImageFocused);
 
    void GetImages(
        ImageResource_t& eImageNormal,
        ImageResource_t& eImageHighlighted,
        ImageResource_t& eImagePressed,
        ImageResource_t& eImageGrayedOut,
        ImageResource_t& eImageFocused);
 
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
    void Init();
 
    ObjectHandle_t m_eTargetObject;
 
private:
    CGUIKeyboard(const CGUIKeyboard& kSource);
 
    CGUIKeyboard& operator=(const CGUIKeyboard& kSource);
 
    virtual CGUIButton* CreateKeyboardButton(const eC_String& kLabel, CGUICompositeObject* pkParent);
 
    virtual CGUIButton* CreateKeyboardButton(const eC_String& kLabel, const eC_UInt uiKeyCode, CGUICompositeObject* pkParent);
 
    eC_UInt CreateKeyboardRow(
        CGUICompositeObject* pkParent,
        const eC_UInt uiTotalNOFRowsInKeyboard,
        const eC_UInt uiRowIndex,
        const eC_Value vXOffset,
        const eC_UInt uiNOFButtons,
        const eC_Value* pWidths,
        eC_String** pLabels);
 
    void UpdateButtons();
 
private:
    static const eC_UInt INDEX_COLOR_STANDARD;
    static const eC_UInt INDEX_COLOR_HIGHLIGHTED;
    static const eC_UInt INDEX_COLOR_GRAYEDOUT;
    static const eC_UInt INDEX_COLOR_PRESSED;
 
    static const eC_String ms_kSpace;
    static const eC_String ms_kEnter;
    static const eC_String ms_kBackspace;
    static const eC_String ms_kSymLayout;
    static const eC_String ms_kABCCapitalLayout;
    static const eC_String ms_kAbcLayout;
    static const eC_String ms_k123Layout;
 
    GeneralResource_t m_eLayout; 
 
    FontResource_t m_eFont; 
 
    ImageResource_t m_eImageNormal; 
    ImageResource_t m_eImageHighlighted; 
    ImageResource_t m_eImagePressed; 
    ImageResource_t m_eImageGrayedOut; 
    ImageResource_t m_eImageFocused; 
};
 
class KeyboardLayoutInterpreter : public CGUIGeneralResourceInterpreter
{
public:
    KeyboardLayoutInterpreter(CGUIKeyboard* 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:
    CGUIKeyboard * m_pkObject; 
    eC_String m_kFileExtension; 
};
 
#endif