GUIPageContainer.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 GUIPAGECONTAINER_H
#define GUIPAGECONTAINER_H
 
#include "GUICompositeObject.h"
#include "GUIEasing.h"
#include "GUIImageResource.h"
#include "GUINinePatch.h"
 
#include "GUICommonEnums.h"
 
// @guiliani_doxygen toplevel_control Page-Container
// @endguiliani_doxygen
 
class CGUIPageContainer : public CGUICompositeObject
{
public:
    CGUIPageContainer(
        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);
 
    CGUIPageContainer();
 
    CGUIPageContainer(const CGUIPageContainer& kToBeCopied);
 
    CGUIPageContainer& operator=(const CGUIPageContainer& kSource);
 
    virtual ~CGUIPageContainer();
 
    virtual eC_Bool AddObject(CGUIObject* pkObject);
 
    virtual void RemoveObject(CGUIObject* pkObject);
 
    virtual void ScrollTo(eC_UInt uiNodeIndex);
 
    virtual void ScrollToAnimated(eC_UInt uiNodeIndex);
 
    virtual eC_UInt GetCurrentIndex();
 
    // Methods derived from CGUIObject 
    virtual eC_Bool DoDraw();
    virtual eC_Bool DoPostDraw();
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
    virtual eC_Bool DoClick(const eC_Value& vAbsX, const eC_Value& vAbsY);
    virtual eC_Bool DoButtonDown(const eC_Value& vAbsX, const eC_Value& vAbsY);
    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, const eC_Value& vAbsY);
    virtual eC_Bool SetValue(const CGUIValue& rkValue);
 
    virtual void SetWidth(const eC_Value& vX);
    virtual void SetHeight(const eC_Value& vY);
 
#if defined(GUILIANI_STREAM_GUI)
    virtual void ReadFromStream();
#endif
 
#if defined(GUILIANI_WRITE_GUI)
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
    CGUINinePatch& GetNinePatch()
    {
        return m_kNinePatch;
    }
 
    virtual void StartScrollingAnimation();
 
    virtual void StopScrollingAnimation();
 
public:
    /* Setter/Getter */
 
    void SetDirection(const CGUICommonEnums::Orientation_t& eDirection);
 
    CGUICommonEnums::Orientation_t GetDirection() const;
 
    void SetDragActive(const eC_Bool& bDragActive);
 
    eC_Bool GetDragActive() const;
 
    void SetDragDistance(const eC_Value& vDragDistance);
 
    eC_Value GetDragDistance() const;
 
    void SetSwipeDistance(const eC_Value& vSwipeDistance);
 
    eC_Value GetSwipeDistance() const;
 
    void SetOverShoot(const eC_Value& vOvershoot);
 
    eC_Value GetOverShoot() const;
 
    void SetBGImage(const ImageResource_t& eBGImage);
 
    ImageResource_t GetBGImage() const;
 
    void SetIndicatorAlignment(const CGUICommonEnums::Alignment_t& eAlignment);
 
    CGUICommonEnums::Alignment_t GetIndicatorAlignment() const;
 
    void SetIndicatorImages(
        const ImageResource_t& eImageInactive,
        const ImageResource_t& eImageActive);
 
    void GetIndicatorImages(
        ImageResource_t& eImageInactive,
        ImageResource_t& eImageActive) const;
 
    void SetIndicatorSize(const eC_Value& vWidth, const eC_Value& vHeight);
 
    void GetIndicatorSize(eC_Value& vWidth, eC_Value& vHeight) const;
 
    void SetIndicatorsActive(const eC_Bool& bIndicatorsActive);
 
    eC_Bool GetIndicatorsActive() const;
 
    void SetNormalEasing(
        const CGUIEasing::EasingType_t& eEasing,
        const eC_Value& vEasingTime);
 
    void GetNormalEasing(
        CGUIEasing::EasingType_t& eEasing,
        eC_Value& vEasingTime) const;
 
    void SetBounceEasing(
        const CGUIEasing::EasingType_t& eEasing,
        const eC_Value& vEasingTime);
 
    void GetBounceEasing(
        CGUIEasing::EasingType_t& eEasing,
        eC_Value& vEasingTime) const;
 
private:
    void Init();
 
    void DeInit();
 
    void ArrangeChildren();
 
    void UpdateChildPositions(const eC_Value& vPosition);
 
    void AdjustPosition(const eC_Value& vPositionDelta, const eC_Value& vPositionAbs);
 
    eC_Value GetValidPosition(const eC_Value& vPosition, const eC_Value& vDistanceForDirection);
 
private:
    CGUICommonEnums::Orientation_t m_eDirection; 
    eC_Bool m_bDragActive; 
    eC_Value m_vMinimumDragDistance; 
    eC_Value m_vSwipeDistance; 
    eC_Value m_vOverShoot; 
 
    ImageResource_t m_eBGImage; 
    CGUINinePatch m_kNinePatch; 
 
    CGUICommonEnums::Alignment_t m_eIndicatorAlignment; 
    ImageResource_t m_ePageIndicatorInactive; 
    ImageResource_t m_ePageIndicatorActive; 
    eC_Value m_vIndicatorWidth; 
    eC_Value m_vIndicatorHeight; 
    eC_Bool m_bIndicatorsActive; 
 
    eC_UInt m_uiDragTimeStamp;
    eC_UInt m_uiDragStarted; 
    CGUIPoint m_kDragStart; 
 
    CGUIEasing::EasingType_t  m_eCurrentEasingType;
    eC_Value m_vCurrentEasingDuration;
    CGUIEasing::EasingType_t  m_eEasingTypeNormal;
    eC_Value m_vEasingDurationNormal;
    CGUIEasing::EasingType_t  m_eEasingTypeBounce;
    eC_Value m_vEasingDurationBounce;
 
    CGUIObject* m_pkCurrentElement;
    eC_UInt m_uiCurrentIndex;
 
    eC_Value m_vMaxPosition;
    eC_Value m_vCurrentPosition;
    eC_Value m_vTargetPosition;
 
    eC_TArray<CGUIRect> m_kIndicatorRects;
};
 
#endif