cFont Class Reference

#include <font.h>

List of all members.

Public Member Functions
virtual	~cFont ()
virtual int	Width (uint c) const =0
	Returns the width of the given character in pixel.
virtual int	Width (const char *s) const =0
	Returns the width of the given string in pixel.
virtual int	Height (void) const =0
	Returns the height of this font in pixel (all characters have the same height).
int	Height (const char *s) const
	Returns the height of this font in pixel (obsolete, just for backwards compatibilty).
virtual void	DrawText (cBitmap *Bitmap, int x, int y, const char *s, tColor ColorFg, tColor ColorBg, int Width) const =0
Static Public Member Functions
static void	SetFont (eDvbFont Font, const char *Name, int CharHeight)
static const cFont *	GetFont (eDvbFont Font)
static cFont *	CreateFont (const char *Name, int CharHeight, int CharWidth=0)
static bool	GetAvailableFontNames (cStringList *FontNames, bool Monospaced=false)
static cString	GetFontFileName (const char *FontName)
	Retruns the actual font file name for the given FontName.

---

Detailed Description

Definition at line 35 of file font.h.

---

Constructor & Destructor Documentation

virtual cFont::~cFont

(

)

[inline, virtual]

Definition at line 39 of file font.h.

{}

---

Member Function Documentation

static cFont* cFont::CreateFont	(	const char *	Name,
		int	CharHeight,
		int	CharWidth = 0
	)		[static]

Creates a new font object with the given Name and makes its characters CharHeight pixels high. If CharWidth is given, it overwrites the font's default width. Name is of the form "Family:Style", for instance "Verdana:Bold Italic" or "Times New Roman". See GetAvailableFontNames() for how to get a list of all available font names. If the requested font can't be created, NULL is returned. The caller must delete the font when it is no longer needed.

virtual void cFont::DrawText	(	cBitmap *	Bitmap,
		int	x,
		int	y,
		const char *	s,
		tColor	ColorFg,
		tColor	ColorBg,
		int	Width
	)		const [pure virtual]

Draws the given text into the Bitmap at position (x, y) with the given colors. The text will not exceed the given Width (if > 0), and will end with a complete character.

static bool cFont::GetAvailableFontNames	(	cStringList *	FontNames,
		bool	Monospaced = false
	)		[static]

Queries the font configuration for a list of available font names, which is returned in FontNames. If Monospaced is true, only monospaced fonts will be returned. The resulting font names are in a format that can be used with GetFontFileName() to get the name of the actual font file. Returns true if any font names were found.

static const cFont* cFont::GetFont

(

eDvbFont

Font

)

[static]

Gets the given Font, which was previously set by a call to SetFont(). If no SetFont() call has been made, the font as defined in the setup is returned. The caller must not use the returned font outside the scope in which it was retrieved by the call to GetFont(), because a call to SetFont() may delete an existing font.

static cString cFont::GetFontFileName

(

const char *

FontName

)

[static]

Retruns the actual font file name for the given FontName.

int cFont::Height

(

const char *

s

)

const [inline]

Returns the height of this font in pixel (obsolete, just for backwards compatibilty).

Definition at line 46 of file font.h.

References Height().

Referenced by Height().

virtual int cFont::Height

(

void

)

const [pure virtual]

Returns the height of this font in pixel (all characters have the same height).

static void cFont::SetFont	(	eDvbFont	Font,
		const char *	Name,
		int	CharHeight
	)		[static]

Sets the given Font to use the font data according to Name (see CreateFont()) and make its characters CharHeight pixels high.

virtual int cFont::Width

(

const char *

s

)

const [pure virtual]

Returns the width of the given string in pixel.

virtual int cFont::Width

(

uint

c

)

const [pure virtual]

Returns the width of the given character in pixel.

---

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

• contrib/sasc-ng/sc/include/vdr/font.h