GUIProgressBar.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 CGUIPROGRESSBAR__H_
#define CGUIPROGRESSBAR__H_
 
#include "GUIImageResource.h"
#include "GUIAbstractBar.h"
#include "GUICommonEnums.h"
#include "GUINinePatch.h"
#include "GUIColorPropertyObserver.h"
 
 
// @guiliani_doxygen toplevel_control Progress Bar
// @endguiliani_doxygen
class CGUIProgressBar : public CGUIAbstractBar, public CGUIColorPropertyObserver
{
public:
    enum ProgressBarType_t
    {
        PBT_PROGRESSBAR_TYPE_NORMAL,
        PBT_PROGRESSBAR_TYPE_ACTIVITY
    };
 
    enum LoopMode_t
    {
        LM_LOOP_MODE,
        LM_REVERTLOOP_MODE,
        LM_FILL_UP,
        LM_FILL_UP_TILE
    };
 
    CGUIProgressBar(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);
 
    CGUIProgressBar(CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY, const eC_Value& vWidth,
        const eC_Value& vHeight,
        const ImageResource_t &eBackground,
        const ImageResource_t &eForeground,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIProgressBar(CGUICompositeObject* const pkParent,
        const CGUIRect& kRect,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIProgressBar(CGUICompositeObject* const pkParent,
        const CGUIRect& kRect,
        const ImageResource_t &eBackground,
        const ImageResource_t &eForeground,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIProgressBar(const CGUIProgressBar& kSource);
 
 
    CGUIProgressBar& operator=(const CGUIProgressBar& kSource);
 
    virtual eC_Bool DoDraw();
 
    virtual eC_Bool IsHighlightable() const { return false; }
 
    void SetImages(const ImageResource_t eForeground, const ImageResource_t eBackground);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    void SetFullRangeSize(const eC_Value& vSize);
 
    inline eC_Value GetFullRangeSize() const
    {
        if (m_eStyle == CGUICommonEnums::OR_HORIZONTAL)
            return m_vBarWidth;
        else if (m_eStyle == CGUICommonEnums::OR_VERTICAL)
            return m_vBarHeight;
        else
            return eC_FromInt(0);
    }
 
    void SetTypeOfProgressBar(ProgressBarType_t eType);
 
    inline ProgressBarType_t GetTypeOfProgressBar() const
    {
        return m_eProgressBarType;
    }
 
    inline void SetLoopMode(LoopMode_t eLM)
    {
        m_eLoopMode = eLM;
    }
 
    inline LoopMode_t GetLoopMode() const
    {
        return m_eLoopMode;
    }
 
    eC_Bool Increase();
 
    eC_Bool Decrease();
 
    void SetVertical(eC_Bool bVert)
    {
        if (bVert)
            m_eStyle = CGUICommonEnums::OR_VERTICAL;
        else
            m_eStyle = CGUICommonEnums::OR_HORIZONTAL;
    }
 
    inline eC_Bool IsVertical() const
    {
        if (m_eStyle == CGUICommonEnums::OR_HORIZONTAL)
            return false;
        else if (m_eStyle == CGUICommonEnums::OR_VERTICAL)
            return true;
        return false;
    }
 
    inline eC_Value GetBarXPos() const
    {
        return m_vBarX;
    }
 
    inline eC_Value GetBarYPos() const
    {
        return m_vBarY;
    }
 
    inline eC_Value GetBarWidth() const
    {
        return m_vBarWidth;
    }
 
    inline eC_Value GetBarHeight() const
    {
        return m_vBarHeight;
    }
 
    inline void SetBarRect(const CGUIRect& kBarRect)
    {
        m_vBarX = kBarRect.GetX1();
        m_vBarY = kBarRect.GetY1();
        m_vBarWidth = kBarRect.GetWidth();
        m_vBarHeight = kBarRect.GetHeight();
        InvalidateArea();
    }
 
    void SetBarXPos(const eC_Value& vX);
 
    void SetBarYPos(const eC_Value& vY);
 
    void SetBarWidth(const eC_Value& vWidth);
 
    void SetBarHeight(const eC_Value& vHeight);
 
    ~CGUIProgressBar();
 
    virtual void SetWidth(const eC_Value& vWidth);
 
    virtual void SetHeight(const eC_Value& vHeight);
 
    CGUINinePatch& GetNinePatch() { return m_kNinePatch; }
 
    eC_UInt GetForegroundColor() const;
 
    void SetForegroundColor(const eC_UInt& uiForegroundColor);
 
    void SetForegroundColor(const GlobalProperty_t& eForegroundColor);
 
#ifdef GUILIANI_STREAM_GUI
    CGUIProgressBar();
 
    virtual void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
 
    eC_Bool IncrementValue(eC_Bool bInc);
 
    virtual void DrawTypeNormalBar();
 
    virtual void DrawTypeActivityBar();
 
    void Init(const ImageResource_t &eForeground, const ImageResource_t &eBackground);
 
    void CopyAttributes(const CGUIProgressBar& kSource);
 
    void DeInit();
 
    ImageResource_t m_eImgBackground;
 
    ImageResource_t m_eImgForeground;
 
    CGUICommonEnums::Orientation_t m_eStyle;
 
    eC_Value m_vBarX;
 
    eC_Value m_vBarY;
 
    eC_Value m_vBarWidth;
 
    eC_Value m_vBarHeight;
 
    ProgressBarType_t m_eProgressBarType;
 
    LoopMode_t m_eLoopMode;
 
    eC_Bool m_bLoopDirection;
 
    CGUINinePatch m_kNinePatch;
};
#endif