CFntWrapNull Class Reference

The dummy font wrapper class. More...

#include <FntWrapNull.h>

Inheritance diagram for CFntWrapNull:

Static Public Member Functions
static void	CreateInstance ()
	Create the insta nce.
Static Public Member Functions inherited from CFntWrap
static void	DeleteInstance ()

Protected Member Functions
virtual void	RequiredSpace (const eC_String *const pkText, eC_Value &vWidth, eC_Value &vHeight)
virtual eC_Bool	SetNOFFonts (const eC_UInt uiNOFFonts)
virtual void	Text (const eC_Value &vX1, const eC_Value &vY1, const eC_String *const lpString)
Protected Member Functions inherited from CFntWrap
	CFntWrap ()
	Constructor.
virtual	~CFntWrap ()
	Destructor.

Additional Inherited Members
Public Types inherited from CFntWrap
enum	GUIFont_t { FNT_NORMAL = 0 , FNT_ITALIC = 1 , FNT_UNDERLINED = 2 , FNT_BOLD = 4 }
enum	TextOperation_t { RENDER_TEXT , GET_REQUIRED_SPACE }
Public Member Functions inherited from CFntWrap
void	ChangeFont (const FontResource_t &eFontID, const eC_String &pcPath, const eC_UInt uiFontSize, const GUIFont_t &eFontStyle)
virtual void	FittingNumChars (const eC_String *const pkText, eC_Value vWidthMax, eC_UInt &uiNumChars, const eC_Bool &bStartAtEnd=false)
virtual eC_Int	GetAscender () const
virtual eC_Int	GetDescender () const
virtual void	GetGlyphMetrics (const eC_Char cChar, GlyphMetrics_t &kMetrics)
virtual eC_Int	GetInternalLeading () const
virtual eC_UInt	GetNOFFonts ()
CGUICommonEnums::Rotation_t	GetRotation () const
virtual eC_Value	GetTextXPosAdjustment (const CGUIText::HorAligned_t eHorAlignment)
virtual eC_Value	GetTextYPosAdjustment (const CGUIText::VerAligned_t eVerAlignment)
virtual void	LoadFont (const FontResource_t &eFontID)
virtual void	RequiredSpace (const eC_String *const pkText, eC_Value &vWidth, eC_Value &vHeight)=0
virtual void	SetFont (const FontResource_t &eID)
virtual void	SetFontSpacing (const eC_Float &fSpacing)
virtual eC_Bool	SetNOFFonts (const eC_UInt uiNOFFonts)
void	SetRotation (const CGUICommonEnums::Rotation_t &eRotation)
virtual void	Text (const eC_Value &vX1, const eC_Value &vY1, const eC_String *const lpString)=0
virtual void	UnloadFont (const FontResource_t &eFontID)
Protected Attributes inherited from CFntWrap
FontResource_t	m_eCurFont
	Current font id.
CGUICommonEnums::Rotation_t	m_eRotation
	Rotation.
eC_UInt	m_uiNOFFonts
	Total number of fonts.
eC_Value	m_vSpacing
	Font spacing, i.e the space between letters.

Detailed Description

The dummy font wrapper class.

This is the dummy font wrapper class.

Member Function Documentation

RequiredSpace()

virtual void CFntWrapNull::RequiredSpace ( const eC_String *const  pkText, eC_Value &  vWidth, eC_Value &  vHeight  )

inlineprotectedvirtual

Calculates the required space in x- and y-direction of a given text with the currently active font.

Parameters

pkText	The text.
vWidth	Reference to width of the font in pixels.
vHeight	Reference to height of the font in pixels.

Implements CFntWrap.

SetNOFFonts()

virtual eC_Bool CFntWrapNull::SetNOFFonts ( const eC_UInt  uiNOFFonts )

inlineprotectedvirtual

Sets the total number of fonts. This is called internally by the ResourceManager when dynamically allocated font resources require the total number of fonts to be raised. Derived classes will have to override this method and resize their internal font-storage structures according to the new number of fonts which will have to be stored.

Parameters

uiNOFFonts

The number of fonts

Returns

True if internal storage has been successfully adapted to support the requested number of fonts. False otherwise.

Reimplemented from CFntWrap.

Text()

virtual void CFntWrapNull::Text ( const eC_Value &  vX1, const eC_Value &  vY1, const eC_String *const  lpString  )

inlineprotectedvirtual

Print the text to screen.

Parameters

vX1	Absolute x position of the top-left corner of the bounding rectangle.
vY1	Absolute y position of the top-left corner of the bounding rectangle.
lpString	The string to be printed.

Implements CFntWrap.

---

The documentation for this class was generated from the following file:

• FntWrapNull.h