GUIPrimitiveButton.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 GUIPRIMITIVE_BUTTON__H_
#define GUIPRIMITIVE_BUTTON__H_
 
#include "GUICompositeObject.h"
#include "GUITextResource.h"
#include "GUICommand.h"
 
class CGUIText;
 
class CGUIPrimitiveButton : public CGUICompositeObject
{
public:
    CGUIPrimitiveButton(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const eC_String& rkText,
        CGUICommandPtr pCommandObject,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIPrimitiveButton(
        CGUICompositeObject* const pkParent,
        const CGUIRect &kRect,
        const eC_String& rkText,
        CGUICommandPtr pCommandObject,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIPrimitiveButton(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const TextResource_t &eTextID,
        CGUICommandPtr pCommandObject,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIPrimitiveButton(
        CGUICompositeObject* const pkParent,
        const CGUIRect &kRect,
        const TextResource_t &eTextID,
        CGUICommandPtr pCommandObject,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIPrimitiveButton(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const TextResource_t &eTextID,
        CGUICommandPtr pCommandObject,
        const ObjectHandle_t &eBtnStandard,
        const ObjectHandle_t &eBtnPressed = NO_HANDLE,
        const ObjectHandle_t &eBtnHighlighted = NO_HANDLE,
        const ObjectHandle_t &eBtnGrayedOut = NO_HANDLE,
        const ObjectHandle_t &eBtnFocused = NO_HANDLE,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIPrimitiveButton(const CGUIPrimitiveButton& kSource);
 
    CGUIPrimitiveButton& operator=(const CGUIPrimitiveButton& kSource);
 
    CGUIPrimitiveButton();
 
    virtual ~CGUIPrimitiveButton();
 
    void SetHandles(
        ObjectHandle_t eBtnStandard,
        ObjectHandle_t eBtnPressed,
        ObjectHandle_t eBtnHighlighted,
        ObjectHandle_t eBtnGrayedOut,
        ObjectHandle_t eBtnFocused);
 
    void GetHandles(
        ObjectHandle_t& eBtnStandard,
        ObjectHandle_t& eBtnPressed,
        ObjectHandle_t& eBtnHighlighted,
        ObjectHandle_t& eBtnGrayedOut,
        ObjectHandle_t& eBtnFocused);
 
    CGUIText *GetLabel() const;
 
    inline void SetCommand(CGUICommandPtr pCommand) { m_pkCommandObject = pCommand; }
 
    CGUICommandPtr GetCommand() const { return m_pkCommandObject; }
 
    virtual eC_Bool DoDraw();
    
    virtual eC_Bool DoClick(const eC_Value&  vAbsX = eC_FromInt(-1), const eC_Value&  vAbsY = eC_FromInt(-1));
   
    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, const eC_Value& vDeltaY, const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool DoDragEnd(const eC_Value& vAbsX = eC_FromInt(-1), const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoMouseEnter(const eC_Value& vAbsX = eC_FromInt(-1), const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoMouseLeave(const eC_Value& vAbsX = eC_FromInt(-1), const eC_Value& vAbsY = eC_FromInt(-1));
 
    virtual eC_Bool DoMouseMove(const eC_Value& vAbsX = eC_FromInt(-1), const eC_Value& vAbs = eC_FromInt(-1));
 
    virtual void GetFocus();
 
    virtual void LoseFocus();
    
    virtual void SetGrayedOut(const eC_Bool &bGrayOut);
 
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
    enum ButtonState_t
    {
        BUTTON_STATE_PRESSED,         
        BUTTON_STATE_HIGHLIGHTED,     
        BUTTON_STATE_STANDARD,        
        BUTTON_STATE_GRAYEDOUT,       
        BUTTON_STATE_FOCUSED          
    };
 
    ButtonState_t m_eButtonState;
 
    virtual void SetButtonState();
 
    ObjectHandle_t m_eBtnStandard;    
    ObjectHandle_t m_eBtnPressed;     
    ObjectHandle_t m_eBtnHighlighted; 
    ObjectHandle_t m_eBtnGrayedOut;   
    ObjectHandle_t m_eBtnFocused;     
    CGUICommandPtr m_pkCommandObject; 
    
    CGUIText* m_pkLabel;              
 
private:
    void Init(const eC_String& kText);
    void Init(const TextResource_t &eTextID);
    void DeInit();
};
#endif //GUIPRIMITIVE_BUTTON__H_