GUIScrollBar.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 __GUISCROLLBAR__H_
#define __GUISCROLLBAR__H_
 
#include "GUICompositeObject.h"
#include "GUISlider.h"
#include "GUIRange.h"
#include "GUIObserver.h"
#include "GUIException.h"
 
class CGUIButton;
 
 
class CGUIScrollBar : public CGUICompositeObject, public CGUIObserver
{
public:
    CGUIScrollBar(
        CGUICompositeObject* const pkParent,
        CGUIObject* const pScrolledObject,
        const eC_UInt &uiStepSize = 1,
        const CGUIRange::Base_t &eBase = CGUIRange::BASE_AT_MINIMUM,
        const CGUICommonEnums::Orientation_t &eStyle = CGUICommonEnums::OR_HORIZONTAL,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    virtual ~CGUIScrollBar();
 
    eC_Bool DoClick(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    void RecalculateScrollingRange(const eC_Value vCLipperSize);
 
    void SetScrolledObject(CGUIObject* pkObject);
 
    CGUIObject* GetScrolledObject() const;
 
    eC_Bool SetValue(const CGUIValue& rkValue);
 
    CGUISlider* GetSlider() const;
 
    CGUIButton* GetUpLeftButton() const;
 
    CGUIButton* GetDownRightButton() const;
 
    const CGUIRange& GetRange() const;
 
    void OnNotification(const CGUIValue& kObservedValue, const CGUIObject* const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    void SetScrollInterval(const eC_UInt &ruiScrollInterval);
 
    eC_UInt GetScrollInterval() const;
 
    void SetScrollSpeed(const eC_UInt &ruiScrollSpeed) const;
 
    eC_UInt GetScrollSpeed() const;
 
    void HideButtons(const eC_Bool &bHide);
 
    virtual void RemoveObject(CGUIObject* pkObject);
 
#ifdef GUILIANI_STREAM_GUI
    CGUIScrollBar()
    {
        Init();
    }
 
    virtual void ReadFromStream();
 
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
    eC_Bool DoButtonDown(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    eC_Bool DoDragEnd(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
private:
    void Init();
    void DeInit();
    void AdaptKnobSize();
    void AdaptSliderSize();
 
    void CreateChildObjects(const eC_UInt& uiStepSize, const CGUIRange::Base_t &eBase, const CGUICommonEnums::Orientation_t &eStyle);
 
    eC_UInt     m_uiScrollInterval;     
    eC_Bool     m_bScrollDownRight;     
    eC_Int      m_iOldValue;            
    CGUIObject* m_pkScrolledObject;     
    CGUISlider* m_pkSlider;             
    CGUIButton* m_pkUpLeftButton;       
    CGUIButton* m_pkDownRightButton;    
 
    ObjectHandle_t m_eScrolledObject;
    eC_Bool m_bAutoStretch;
};
#endif