GUIBaseSlider.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 GUIBASESLIDER__H_
#define GUIBASESLIDER__H_
 
#include "GUIAbstractBar.h"
#include "GUIRange.h"
#include "GUIPoint.h"
 
#include "GUICommonEnums.h"
 
 
class CGUIBaseSlider : public CGUIAbstractBar
{
public:
    enum SliderMode_t
    {
        SM_NONE = 0,        
        SM_JUMPTOCLICK,     
        SM_SCROLLTOCLICK     
    };
 
public:
    friend class CGUIScrollBar; 
 
    CGUIBaseSlider(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const eC_Int& iValue,
        const eC_Int& iMin, const eC_Int& iMax,
        const eC_UInt& uiStepSize,
        const CGUIRange::Base_t& eBase = CGUIRange::BASE_AT_MINIMUM,
        const CGUICommonEnums::Orientation_t& eStyle = CGUICommonEnums::OR_HORIZONTAL,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIBaseSlider(
        CGUICompositeObject* const pkParent,
        const CGUIRect& kRect,
        const eC_Int& iValue,
        const eC_Int& iMin, const eC_Int& iMax,
        const eC_UInt& uiStepSize,
        const CGUIRange::Base_t& eBase = CGUIRange::BASE_AT_MINIMUM,
        const CGUICommonEnums::Orientation_t& eStyle = CGUICommonEnums::OR_HORIZONTAL,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIBaseSlider(const CGUIBaseSlider& kSource);
 
    CGUIBaseSlider& operator=(const CGUIBaseSlider& kSource);
 
#ifdef GUILIANI_STREAM_GUI
    CGUIBaseSlider();
 
 
    virtual void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
    virtual ~CGUIBaseSlider();
 
    virtual eC_Bool DoDraw();
 
    virtual eC_Bool DoClick(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 DoButtonDown(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual void SetWidth(const eC_Value& vX);
 
    virtual void SetHeight(const eC_Value& vY);
 
    void SetSliderTrackDistance(const eC_Value vPixel);
 
    inline eC_Value GetSliderTrackLength() const
    {
        return eC_Abs(m_vSliderMaxPos - m_vSliderMinPos);
    }
 
    inline CGUICommonEnums::Orientation_t GetOrientation() const
    {
        return m_eStyle;
    }
 
#ifndef GUILIANI_STREAM_GUI
    CGUIBaseSlider();
#endif
 
    inline eC_Value GetKnobSizeVertical() const
    {
        return m_vKnobSizeVertical;
    }
 
    inline eC_Value GetKnobSizeHorizontal() const
    {
        return m_vKnobSizeHorizontal;
    }
 
    inline SliderMode_t GetSliderMode() const
    {
        return m_eSliderMode;
    }
 
    inline eC_UInt GetScrollDistance() const
    {
        return m_iScrollDistance;
    }
 
    inline void SetKnobSize(const eC_Value& vKnobSize)
    {
        SetKnobSizeHorizontal(vKnobSize);
        SetKnobSizeVertical(vKnobSize);
    }
 
    void SetKnobSizeHorizontal(const eC_Value& vKnobSize);
 
    void SetKnobSizeVertical(const eC_Value& vKnobSize);
 
    void SetSliderMaxPos(const eC_Value vSliderMaxPos);
 
    void SetSliderMinPos(const eC_Value vSliderMinPos);
 
    virtual CGUIRect CalculateKnobRect();
 
    void SetMinimumKnobSize(const eC_Value vMinimumKnobSize)
    {
        m_vMinimumKnobSize = vMinimumKnobSize;
        SetKnobSizeHorizontal(m_vKnobSizeHorizontal);
        SetKnobSizeVertical(m_vKnobSizeVertical);
    }
 
    void SetSliderMode(const SliderMode_t& eMode);
     
    void SetScrollDistance(const eC_UInt& uiDistance);
 
protected:
    inline void ClipToPixelBounds(eC_Value& vPos) const
    {
        // clip to bounds
        if (vPos < m_vSliderMinPos)
            vPos = m_vSliderMinPos;
        else if (vPos > m_vSliderMaxPos)
            vPos = m_vSliderMaxPos;
    }
 
    void SetSliderPos(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    void CopyAttributes(const CGUIBaseSlider& kSource);
 
    inline eC_Int GetSliderValue(const eC_Value& vAbsX, const eC_Value& vAbsY) const;
 
    void Init(
        const eC_Int& iValue,
        const eC_Int& iMin,
        const eC_Int& iMax,
        const eC_UInt& uiStepSize,
        const CGUIRange::Base_t& eBase);
 
protected:
    CGUICommonEnums::Orientation_t m_eStyle;
 
    eC_Bool m_bDraggingMode;
 
    eC_Bool m_bStartOnKnob;
 
    CGUIPoint m_kRelDraggingPoint;
 
    CGUIRect m_kKnobAbsRect;
 
 
    eC_Value m_vSliderMaxPos, m_vSliderMinPos;
 
    eC_Value m_vKnobSizeHorizontal;
 
    eC_Value m_vKnobSizeVertical;
 
    eC_Value m_vSliderTrackDistance;
 
    eC_Value m_vDiffKnobMouse;
 
    eC_Value m_vMinimumKnobSize;
 
    SliderMode_t m_eSliderMode;
 
    eC_Int m_iScrollDistance;
};
#endif