GUIRichText.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 GUIRICHTEXT__H_
#define GUIRICHTEXT__H_
 
#include "GUIFontResource.h"
#include "GUITextResource.h"
#include "eC_TList_doubleLinked.h"
#include "GUIText.h"
#include "FntWrap.h"
 
class CGUIObject;
// @guiliani_doxygen toplevel_module Rich Text
// @endguiliani_doxygen
 
class CGUIRichText : public CGUIText
{
public:
    CGUIRichText(
        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);
 
    CGUIRichText(
        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);
 
    CGUIRichText(
        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);
 
    CGUIRichText(const CGUIRichText& kTextToBeCopied);
 
    virtual ~CGUIRichText();
 
    virtual void SetRichFonts(const FontResource_t& eFontNormal = DUMMY_FONT,
                               const FontResource_t& eFontBold = DUMMY_FONT,
                               const FontResource_t& eFontItalic = DUMMY_FONT,
                               const FontResource_t& eFontBoldItalic = DUMMY_FONT);
 
    virtual void SetFont(const FontResource_t &eFontID)
    {
        SetRichFonts(eFontID, eFontID, eFontID, eFontID);
    }
 
    CGUIRichText& operator=(const CGUIRichText& kSource);
 
    virtual void PrintText();
    virtual void SetTextID(const TextResource_t &eTextID);
    virtual void SetTextString(const eC_String& kTextString);
    virtual void SetTextColor(const eC_UInt &uiTextColorStandard, const eC_UInt &uiTextColorHighlighted, const eC_UInt &uiTextColorGrayedOut, const eC_UInt &uiTextColorPressed);
    virtual void GetRequiredOrgTextSpace(eC_Value& vTextWidth, eC_Value& vTextHeight);
 
    inline void SetFormatTagBold(const eC_String& kTag) {m_kTagBold = kTag; ParseTextToRich();}
 
    inline void SetFormatTagItalic(const eC_String& kTag) {m_kTagItalic = kTag; ParseTextToRich();}
 
    inline void SetFormatTagUnderlined(const eC_String& kTag) {m_kTagUnderlined = kTag; ParseTextToRich();}
 
    inline void SetFormatTagNoBreak(const eC_String& kTag) {m_kTagNoBreak = kTag; ParseTextToRich();}
 
    inline void SetFormatTagLineBreak(const eC_String& kTag) {m_kTagLineBreak = kTag; ParseTextToRich();}
 
    inline void SetFormatTagUnorderedList(const eC_String& kTag) {m_kTagUnorderedList = kTag; ParseTextToRich();}
 
    inline void SetFormatTagOrderedList(const eC_String& kTag) {m_kTagOrderedList = kTag; ParseTextToRich();}
 
    inline void SetFormatTagListItem(const eC_String& kTag) {m_kTagListItem = kTag; ParseTextToRich();}
 
    inline void SetFormatTagColor(const eC_String& kTag) {m_kTagColor = kTag; ParseTextToRich();}
 
    inline void SetFormatTagOpening(const eC_String& kTag) {m_kTagOpening = kTag; ParseTextToRich();}
 
    inline void SetFormatTagClosing(const eC_String& kTag) {m_kTagClosing = kTag; ParseTextToRich();}
 
    inline void SetFormatTagFinished(const eC_String& kTag) {m_kTagFinished = kTag; ParseTextToRich();}
 
    inline const eC_String& GetFormatTagBold() const {return m_kTagBold;}
 
    inline const eC_String& GetFormatTagItalic() const {return m_kTagItalic;}
 
    inline const eC_String& GetFormatTagUnderlined() const {return m_kTagUnderlined;}
 
    inline const eC_String& GetFormatTagNoBreak() const {return m_kTagNoBreak;}
 
    inline const eC_String& GetFormatTagLineBreak() const {return m_kTagLineBreak;}
 
    inline const eC_String& GetFormatTagUnorderedList() const {return m_kTagUnorderedList;}
 
    inline const eC_String& GetFormatTagOrderedList() const {return m_kTagOrderedList;}
 
    inline const eC_String& GetFormatTagListItem() const {return m_kTagListItem;}
 
    inline const eC_String& GetFormatTagColor() const {return m_kTagColor;}
 
    inline const eC_String& GetFormatTagOpening() const {return m_kTagOpening;}
 
    inline const eC_String& GetFormatTagClosing() const {return m_kTagClosing;}
 
    inline const eC_String& GetFormatTagFinished() const {return m_kTagFinished;}
 
    void EnablePreformatting(const eC_Bool& bPreformatText) {m_bPreformatText = bPreformatText;}
 
    eC_Bool IsTextPreformatted() {return m_bPreformatText;}
 
    virtual CGUIRichText* Clone() const;
 
protected:
    enum ListType_t
    {
        LT_ORDERED,
        LT_UNORDERED,
        LT_NONE
    };
 
    void ParseTextToRich();
 
    void PreformatText();
 
    class CRichTextFragment
    {
    public:
        CRichTextFragment():
            m_eFontID(DUMMY_FONT),
            m_kText(""),
            m_uiColorStandard(0xFF000000),
            m_uiColorHighlighted(0xFF000000),
            m_uiColorGrayedOut(0xFF000000),
            m_uiColorPressed(0xFF000000),
            m_vWidth(0),
            m_vHeight(0),
            m_uiLine(0),
            m_eFontStyle(CFntWrap::FNT_NORMAL),
            m_bLineBreakAllowed(true),
            m_uiForcedLineBreaks(0),
            m_uiPartOfListItem(0),
            m_eListType(LT_NONE)
        {
        }
 
        FontResource_t      m_eFontID;              
        eC_String           m_kText;                
        eC_UInt             m_uiColorStandard;      
        eC_UInt             m_uiColorHighlighted;   
        eC_UInt             m_uiColorGrayedOut;     
        eC_UInt             m_uiColorPressed;       
        eC_Value            m_vWidth;               
        eC_Value            m_vHeight;              
        eC_UInt             m_uiLine;               
        CFntWrap::GUIFont_t m_eFontStyle;           
        eC_Bool             m_bLineBreakAllowed;    
        eC_UInt             m_uiForcedLineBreaks;   
        eC_UInt             m_uiPartOfListItem;     
        ListType_t          m_eListType;            
    };
 
    typedef eC_TListDoubleLinked<CRichTextFragment> RichTextFragmentList;
 
    RichTextFragmentList m_kRichTextFragments;
    RichTextFragmentList m_kOriginalRichTextFragments;
    eC_TArray< eC_Value> m_kLineWidths;
 
    void PreparePrintForFragment(const CRichTextFragment &Fragment);
 
    void OnNotification();
 
    void AdaptText();
 
    void FitFragmentWithEllipsis(CRichTextFragment &TextFragment, eC_Value vMaxWidth);
 
    void SplitFragment(CRichTextFragment &FirstTextFragment, CRichTextFragment &SecondTextFragment, eC_Value vMaxWidth, eC_UInt uiCharOffsetFromStart);
 
    // Font identifiers which will be used for the different formatting options
    FontResource_t m_eFontBold; 
    FontResource_t m_eFontItalic; 
    FontResource_t m_eFontBoldItalic; 
 
    // Supported format tags
    eC_String m_kTagBold; 
    eC_String m_kTagItalic; 
    eC_String m_kTagUnderlined; 
    eC_String m_kTagColor; 
    eC_String m_kTagNoBreak; 
    eC_String m_kTagLineBreak; 
    eC_String m_kTagUnorderedList; 
    eC_String m_kTagOrderedList; 
    eC_String m_kTagListItem; 
    eC_String m_kTagOpening; 
    eC_String m_kTagClosing; 
    eC_String m_kTagFinished; 
 
    eC_Bool m_bPreformatText; 
 
    eC_Value m_vSpaceWidth; 
    eC_Value m_vUnorderedListSignWidth; 
    eC_Value m_vListIndentation; 
 
    eC_String m_kUnorderedListSign; 
 
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteTextType=false);
#endif
 
private:
    CGUIRichText();
 
    void Init();
 
    void AddTextFragment(CRichTextFragment& kFragment, const eC_String& kStringFragment);
 
    void ExtractTag(eC_String& kString, eC_String& kTag);
 
    void AddEmptyLine(eC_Value& vRemainingHeight, eC_Bool& bAllAvailableSpaceUsed, eC_UInt& uiLine, eC_Value& vRemainingSpaceInLine);
 
    eC_Bool RemoveLeadingSpace(CRichTextFragment& kFragment);
 
    eC_Value GetListSignSpace(const ListType_t eListType, const eC_UInt uiPartOfListItem);
};
#endif