GUIScrollingText.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(SCROLLING_TEXT)
#define SCROLLING_TEXT
 
#include "GUIText.h"
#include "GUIAnimatable.h"
 
class CGUIObject;
 
// @guiliani_doxygen limitations CGUIScrollingText    
// @endguiliani_doxygen
class CGUIScrollingText : public CGUIText, public CGUIAnimatable
{
public:
    CGUIScrollingText(
        const CGUIObject* const pkParentObject,
        const eC_String &kText,
        const eC_Value& vXPos=eC_FromInt(0),
        const eC_Value& vYPos=eC_FromInt(0),
        const eC_Bool &bSingleLine = true);
 
     CGUIScrollingText(
        const CGUIObject* const pkParentObject,
        const eC_String* const pkText,
        const eC_Value& vXPos=eC_FromInt(0),
        const eC_Value& vYPos=eC_FromInt(0),
        const eC_Bool &bSingleLine = true);
 
    CGUIScrollingText(
        const CGUIObject* const pkParentObject,
        const TextResource_t &eTextID,
        const eC_Value& vXPos=eC_FromInt(0),
        const eC_Value& vYPos=eC_FromInt(0),
        const eC_Bool &bSingleLine = true);
 
    CGUIScrollingText(const CGUIText& rkText);
 
    CGUIScrollingText(const CGUIScrollingText& rkScrollingText);
 
    CGUIScrollingText();
 
    enum ScrollingCondition_t
    {
        SCROLL_ALWAYS,  
        SCROLL_FOCUSED, 
        SCROLL_CUT_TEXT_ALWAYS, 
        SCROLL_CUT_TEXT_FOCUSED, 
        SCROLL_MANUALLY          
    };
 
    void SetAnimationMode(const ScrollingCondition_t eScrollingCondition);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    void SetScrollVertical(const eC_Bool bScrollVertical);
 
    void SetAnimationInterval(const eC_UInt uiAnimationInterval);
 
    void SetAnimationStepSize(const eC_Int iAnimationStepSize);
 
    void SetAnimationActive(const eC_Bool bAnimationActive);
 
    void SetTextWidth(const eC_Value& vTextWidth);
 
    void SetTextHeight(const eC_Value& vTextHeight);
 
    eC_Value GetTextWidth() const;
 
    eC_Value GetTextHeight() const;
 
 
    void SetRelXPos(const eC_Value& vRelXPos);
 
    void SetRelYPos(const eC_Value& vRelYPos);
 
    eC_Value GetRelXPos() const;
 
    eC_Value GetRelYPos() const;
 
    void AdaptText();
 
    void ResetTextPosition();
 
    virtual CGUIScrollingText* Clone() const;
 
#if defined(GUILIANI_STREAM_GUI)
    virtual void ReadFromStream();
#endif
 
#if defined(GUILIANI_WRITE_GUI)
 
    virtual void WriteToStream(const eC_Bool bWriteTextType=false);
#endif
 
protected:
    void PreparePrint();
 
    void PrintText();
 
    void CheckScrollingCondition();
 
    void UpdateIsTextCut();
 
    eC_Bool IsScrollingTextCut() const { return m_bIsTextCut; }
 
private:
    void SetAnimationActiveInternal(const eC_Bool bAnimationActive);
 
    void Init();
 
private:
    eC_Value m_vNonAnimatedTextSize;
 
    eC_Value m_vNonAnimatedTextPos;
 
    ScrollingCondition_t m_eScrollingCondition;
 
    eC_Bool m_bScrollVertical;
 
    eC_UInt m_uiAnimationInterval;
 
    eC_Int m_iAnimationStepSize;
 
    eC_Bool m_bIsTextCut;
 
    eC_Bool m_bTextAttributesUpdated;
};
 
#endif // SCROLLING_TEXT