GUITouchScrollView.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.
*/
 
#if !defined(GUI_TOUCH_SCROLL_VIEW_H)
#define GUI_TOUCH_SCROLL_VIEW_H
 
// Touchscreen-optimized scrollview
#include "GUIScrollView.h"
#include "SafeGUIObjectPtr.h"
#include "GUIEasing.h"
 
#include "GUICommonEnums.h"
 
// @guiliani_doxygen toplevel_control Touch Scroll View
// @endguiliani_doxygen
class CGUITouchScrollView : public CGUIScrollView
{
public:
    CGUITouchScrollView(
        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);
 
#ifdef GUILIANI_STREAM_GUI
    CGUITouchScrollView();
#endif
 
    void SetKineticScrolling(const eC_Bool bVertical, const eC_Bool bHorizontal)
    {
        m_bKineticScrollingVertical = bVertical; m_bKineticScrollingHorizontal = bHorizontal;
    }
 
    eC_Bool HasKineticScrollingVertical() const { return m_bKineticScrollingVertical; }
 
    eC_Bool HasKineticScrollingHorizontal() const { return m_bKineticScrollingHorizontal; }
 
    eC_Int GetElementIndexOfActiveObject() const;
 
    void SetDestination(const CGUICommonEnums::AxisAlignment_t eDestinationDirection, const eC_Value vRelDestinationPos = eC_FromInt(-1))
    {
        m_eDestinationDirection = eDestinationDirection;
        m_vDestination = vRelDestinationPos;
    }
 
    CGUICommonEnums::AxisAlignment_t GetDestinationDirection() const { return m_eDestinationDirection; }
 
    eC_Value GetDestinationPosition() const { return m_vDestination; }
 
    eC_Value GetBounceBackFactor() const { return m_vBounceBackFactor; }
 
    void SetBounceBackFactor(const eC_Value vBounceBackFactor) { m_vBounceBackFactor = vBounceBackFactor; }
 
    eC_Bool ScrollsToImmediateChildrenOnly() const { return m_bScrollToImmediateChildrenOnly; }
 
    void SetScrollToImmediateChildrenOnly(const eC_Bool bOnlyImmediateChildren) { m_bScrollToImmediateChildrenOnly = bOnlyImmediateChildren; }
 
    virtual void ScrollToObject(CGUIObject* pkObjectToScrollTo);
 
    virtual void ScrollToObjectAnimated(CGUIObject* pkObjectToScrollTo);
 
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
    CGUIObject* GetActiveObject() const { return m_pActiveObject; }
 
    eC_Value GetAbsDestinationPosX() const;
 
    eC_Value GetAbsDestinationPosY() const;
 
    CGUIObject* FindClosestObjectToPosition(const CGUICompositeObject* pSearchInObject, const eC_Value& vAbsPosInXDirection, const eC_Value& vAbsPosInYDirection) const;
 
    void SetActiveObjectDistanceFactor(const eC_Value vActiveObjectDistanceFactor) { m_vActiveObjectDistanceFactor = vActiveObjectDistanceFactor; }
 
protected:
    void ScrollToFocussedObject();
 
    CGUIObject* GetValidScrollTarget(CGUIObject* pActiveObject);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    virtual void StopScrollingAnimation();
 
    virtual eC_Bool DoClick(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool DoDragEnd(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);
 
    eC_Bool HasTargetPosition() const;
    eC_Bool HasTargetPositionInScrollDirection() const;
    eC_Bool HasTargetPositionInDragDirection() const;
 
    eC_Value CalcDistanceToObject(const CGUIObject* pkObject, const eC_Value& vAbsPosInXDirection, const eC_Value& vAbsPosInYDirection) const;
 
protected:
    CSafeGUIObjectPtr m_pActiveObject; 
 
    eC_UInt     m_uiLastDrag; 
    CGUIPoint   m_kDragStart; 
    eC_Value    m_vScrollSpeedX; 
    eC_Value    m_vScrollSpeedY; 
    eC_Value    m_vBounceBackFactor; 
 
    eC_Value m_vDestination; 
    CGUICommonEnums::AxisAlignment_t m_eDestinationDirection; 
 
    eC_Bool     m_bScrollToImmediateChildrenOnly;
 
    eC_Bool     m_bKineticScrollingVertical;
    eC_Bool     m_bKineticScrollingHorizontal;
 
    CGUICommonEnums::AxisAlignment_t m_eScrollAnimationDirection;
 
    CGUICommonEnums::AxisAlignment_t m_eCurrentDragDirection;
 
    eC_Value    m_vActiveObjectDistanceFactor;
 
    eC_UInt     m_uiDragTimeStamp;
 
    eC_Value    m_vStartScrollSpeedX; 
    eC_Value    m_vStartScrollSpeedY; 
 
    CGUIEasing::EasingType_t  m_eEasingType;
 
    eC_Value m_vEasingDuration;
 
    eC_Bool m_bDragActive; 
};
 
#endif