FntWrap.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 __FNT_WRAP__H__
#define __FNT_WRAP__H__
 
#include "eC_Types.h"
#include "GUIFontResource.h"
 
#include "GUIText.h"
#include "GUITrace.h"
#include "GUICommonEnums.h"
 
class CGUIRenderTarget;
class eC_String;
 
 
class CFntWrap
{
    friend class CGUIComponentManager; 
 
public:
    enum GUIFont_t
    {
        FNT_NORMAL = 0,
        FNT_ITALIC =  1,
        FNT_UNDERLINED = 2,
        FNT_BOLD = 4
    };
 
    static void DeleteInstance();
 
    typedef struct
    {
        eC_Value vWidth;    
        eC_Value vHeight;   
    } GlyphMetrics_t;
 
public:
    enum TextOperation_t
    {
        RENDER_TEXT, 
        GET_REQUIRED_SPACE 
    };
 
public:
    virtual void Text(const eC_Value& vX1, const eC_Value& vY1, const eC_String * const lpString) = 0;
 
    // ---------------------------------------------------------------
    // Font-access
    // ---------------------------------------------------------------
 
    virtual void SetFont(const FontResource_t &eID);
 
    virtual void SetFontSpacing(const eC_Float &fSpacing);
 
    virtual void GetGlyphMetrics(const eC_Char cChar, GlyphMetrics_t& kMetrics) {}
 
    virtual void RequiredSpace(const eC_String * const pkText, eC_Value& vWidth, eC_Value& vHeight) = 0;
 
    virtual void FittingNumChars(const eC_String * const pkText, eC_Value vWidthMax, eC_UInt &uiNumChars, const eC_Bool& bStartAtEnd = false);
 
    virtual eC_Int GetAscender() const
    {
        return 0;
    }
 
    virtual eC_Int GetDescender() const
    {
        return 0;
    }
 
    virtual eC_Int GetInternalLeading() const
    {
        return 0;
    }
 
    void ChangeFont(const FontResource_t &eFontID,
        const eC_String& pcPath,
        const eC_UInt uiFontSize,
        const GUIFont_t &eFontStyle);
 
    virtual void LoadFont(const FontResource_t &eFontID) {}
 
    virtual void UnloadFont(const FontResource_t &eFontID) {}
 
    virtual eC_Bool SetNOFFonts(const eC_UInt uiNOFFonts);
 
    virtual eC_UInt GetNOFFonts()
    {
        return m_uiNOFFonts;
    }
 
    virtual eC_Value GetTextXPosAdjustment(const CGUIText::HorAligned_t eHorAlignment)
    {
        return 0;
    }
 
    virtual eC_Value GetTextYPosAdjustment(const CGUIText::VerAligned_t eVerAlignment)
    {
        return 0;
    }
 
    void SetRotation(const CGUICommonEnums::Rotation_t& eRotation)
    {
        m_eRotation = eRotation;
    }
 
    CGUICommonEnums::Rotation_t GetRotation() const
    {
        return m_eRotation;
    }
 
protected:
    CFntWrap();
 
    virtual ~CFntWrap();
 
    void* GetWorkingMemory(const eC_UInt& uiSize);
 
    void ReleaseWorkingMemory();
 
protected:
    FontResource_t m_eCurFont;
 
    eC_Value m_vSpacing;
 
    eC_UInt m_uiNOFFonts;
 
    CGUICommonEnums::Rotation_t m_eRotation;
 
 private:
    CFntWrap(const CFntWrap& kSource);
 
    CFntWrap& operator=(const CFntWrap& kSource);
};
#endif