GUIScrollView.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 __GUISCROLLVIEW__H_
#define __GUISCROLLVIEW__H_
 
#include "GUICompositeObject.h"
class CGUIScrollBar;
 
// @guiliani_doxygen toplevel_control Scroll View
// @endguiliani_doxygen
class CGUIScrollView : public CGUICompositeObject
{
public:
    enum ScrollBarPolicy
    {
        AUTOMATIC,          
        ALWAYS_VISIBLE,     
        NEVER_VISIBLE       
    };
 
    CGUIScrollView(
        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);
 
    CGUIScrollView(
        CGUICompositeObject* const pkParent,
        const CGUIRect &kRect,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIScrollView(const CGUIScrollView& rkSource);
 
    CGUIScrollView& operator=(const CGUIScrollView& rkSource);
 
    virtual void SetVerticalScrollbarPolicy(const ScrollBarPolicy ePolicy)
    {
        m_eVerticalScrollBarPolicy = ePolicy;
    }
 
    virtual void SetHorizontalScrollbarPolicy(const ScrollBarPolicy ePolicy)
    {
        m_eHorizontalScrollBarPolicy = ePolicy;
    }
 
    CGUIScrollBar* GetVerticalScrollbar()
    {
        return m_pkVerScrollBar;
    }
 
    CGUIScrollBar* GetHorizontalScrollbar()
    {
        return m_pkHorScrollBar;
    }
 
    virtual eC_Bool AddObject(CGUIObject* pkObject);
 
 
    virtual void RemoveObject(CGUIObject* pkObject);
 
    virtual void SetWidth(const eC_Value& vWidth);
 
    virtual void SetHeight(const eC_Value& vHeight);
 
    virtual void AdjustScrollBars();
 
    virtual void ScrollToFocussedObject();
 
    virtual void ScrollToObject(CGUIObject* pkObject);
 
    virtual void GetFocus()
    {
        AdjustScrollBars();
        CGUICompositeObject::GetFocus();
    }
 
    virtual void SetScrollingInertia(const eC_Value vInertia);
 
    virtual void SetScrollingViewport(const eC_Value vX, const eC_Value vY);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    virtual CGUICompositeObject* GetContainer() const;
 
    virtual CGUICompositeObject* GetClipper() const;
 
    virtual void SaveScrollPosition();
 
    virtual void RestoreScrollPosition();
 
    virtual eC_Bool DoScrollUp(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoScrollDown(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoScrollLeft(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual eC_Bool DoScrollRight(
        const eC_Value& vAbsX,
        const eC_Value& vAbsY);
 
    virtual void SetVerticalScrollBarAtRight(const eC_Bool bIsAtRight);
 
    virtual void SetHorizontalScrollBarAtBottom(const eC_Bool bIsAtBottom);
 
    virtual eC_Bool IsVerticalScrollBarAtRight() const;
 
    virtual eC_Bool IsHorizontalScrollBarAtBottom() const;
 
    void SetAutoAdjustScrollViewLayout(const eC_Bool bAutoAdjustScrollViewLayout)
    {
        m_bAutoAdjustScrollViewLayout = bAutoAdjustScrollViewLayout;
    }
 
    void SetAutoAdjustContainerSize(const eC_Bool bAutoAdjustContainerSize)
    {
        m_bAutoAdjustContainerSize = bAutoAdjustContainerSize;
    }
 
    virtual void StartScrollingAnimation();
 
    virtual void StopScrollingAnimation();
 
#ifdef GUILIANI_STREAM_GUI
    CGUIScrollView();
 
    virtual void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
    void Init();
 
    virtual void AdjustClipperSize();
 
    virtual void AdjustContainerSize();
 
protected:
    CGUICompositeObject* m_pkClipper;
 
    CGUIScrollBar* m_pkHorScrollBar;
 
    CGUIScrollBar* m_pkVerScrollBar;
 
    ScrollBarPolicy m_eVerticalScrollBarPolicy;
 
    ScrollBarPolicy m_eHorizontalScrollBarPolicy;
 
    eC_Value m_vScrollingInertia;
 
    eC_Value m_vViewportXBorder;
 
    eC_Value m_vViewportYBorder;
 
    eC_Int m_iHorScrollPos;
 
    eC_Int m_iVerScrollPos;
 
    eC_Bool m_bIsVerticalScrollBarAtRight;
 
    eC_Bool m_bIsHorizontalScrollBarAtBottom;
 
    eC_Bool m_bAutoAdjustScrollViewLayout;
 
    eC_Bool m_bAutoAdjustContainerSize;
};
#endif