wxPdfFontDescription Class Reference

Class representing a font description. More...

#include <pdffontdescription.h>

Public Member Functions
	wxPdfFontDescription ()
	Default constructor.
	wxPdfFontDescription (int ascent, int descent, int capHeight, int flags, const wxString &fontBBox, int italicAngle, int stemV, int missingWidth, int xHeight, int underlinePosition, int underlineThickness, int hheaAscender=0, int hheaDescender=0, int hheaLineGap=0, int os2sTypoAscender=0, int os2sTypoDescender=0, int os2sTypoLineGap=0, int os2usWinAscent=0, int os2usWinDescent=0)
	Constructor.
	wxPdfFontDescription (const wxPdfFontDescription &desc)
	Copy constructor.
	~wxPdfFontDescription ()
	Default destructor.
void	SetAscent (int ascent)
	Set ascender.
int	GetAscent () const
	Get ascender.
void	SetDescent (int descent)
	Set descender.
int	GetDescent () const
	Get descender.
void	SetCapHeight (int capHeight)
	Set CapHeight.
int	GetCapHeight () const
	Get CapHeight.
void	SetFlags (int flags)
	Set font flags.
int	GetFlags () const
	Get font flags.
void	SetFontBBox (const wxString &fontBBox)
	Set font bounding box.
wxString	GetFontBBox () const
	Get font bounding box.
void	SetItalicAngle (int italicAngle)
	Set italic angle.
int	GetItalicAngle () const
	Get italic angle.
void	SetStemV (int stemV)
	Set StemV.
int	GetStemV () const
	Get StemV.
void	SetMissingWidth (int missingWidth)
	Set missing character width.
int	GetMissingWidth () const
	Get missing character width.
void	SetXHeight (int xHeight)
	Set xHeight.
int	GetXHeight () const
	Get xHeight.
void	SetUnderlinePosition (int underlinePosition)
	Set underline position.
int	GetUnderlinePosition () const
	Get underline position.
void	SetUnderlineThickness (int underlineThickness)
	Set underline thickness.
int	GetUnderlineThickness () const
	Get underline thickness.
void	SetOpenTypeMetrics (int hheaAscender, int hheaDescender, int hheaLineGap, int os2sTypoAscender, int os2sTypoDescender, int os2sTypoLineGap, int os2usWinAscent, int os2usWinDescent)
	Set OpenType Font Metrics.
void	GetOpenTypeMetrics (int *hheaAscender, int *hheaDescender, int *hheaLineGap, int *os2sTypoAscender, int *os2sTypoDescender, int *os2sTypoLineGap, int *os2usWinAscent, int *os2usWinDescent)
	Get OpenType Font Metrics.

Detailed Description

Class representing a font description.

Constructor & Destructor Documentation

wxPdfFontDescription() [1/3]

wxPdfFontDescription::wxPdfFontDescription

(

)

Default constructor.

wxPdfFontDescription() [2/3]

wxPdfFontDescription::wxPdfFontDescription	(	int	ascent,
		int	descent,
		int	capHeight,
		int	flags,
		const wxString &	fontBBox,
		int	italicAngle,
		int	stemV,
		int	missingWidth,
		int	xHeight,
		int	underlinePosition,
		int	underlineThickness,
		int	hheaAscender = 0,
		int	hheaDescender = 0,
		int	hheaLineGap = 0,
		int	os2sTypoAscender = 0,
		int	os2sTypoDescender = 0,
		int	os2sTypoLineGap = 0,
		int	os2usWinAscent = 0,
		int	os2usWinDescent = 0 )

Constructor.

Parameters

ascent	ascender
descent	descender
capHeight	height of capital characters
flags	font flags
fontBBox	bounding box of the font
italicAngle	italic angle
stemV	stemV value
missingWidth	width of missing characters
xHeight	height of character X
underlinePosition	position of underline decoration
underlineThickness	thickness of underline decoration
hheaAscender	ascender in OpenType table hhea
hheaDescender	descender in OpenType table hhea
hheaLineGap	line gap in OpenType table hhea
os2sTypoAscender	typographic ascender in OpenType table OS/2
os2sTypoDescender	typographic descender in OpenType table OS/2
os2sTypoLineGap	typographic line gap in OpenType table OS/2
os2usWinAscent	Windows ascender in OpenType table OS/2
os2usWinDescent	Windows descender in OpenType table OS/2

wxPdfFontDescription() [3/3]

wxPdfFontDescription::wxPdfFontDescription

(

const wxPdfFontDescription &

desc

)

Copy constructor.

~wxPdfFontDescription()

wxPdfFontDescription::~wxPdfFontDescription

(

)

Default destructor.

Member Function Documentation

GetAscent()

int wxPdfFontDescription::GetAscent ( ) const

inline

Get ascender.

Returns

the ascender

GetCapHeight()

int wxPdfFontDescription::GetCapHeight ( ) const

inline

Get CapHeight.

Returns

the height of capital characters

GetDescent()

int wxPdfFontDescription::GetDescent ( ) const

inline

Get descender.

Returns

the descender

GetFlags()

int wxPdfFontDescription::GetFlags ( ) const

inline

Get font flags.

Returns

the font flags

GetFontBBox()

wxString wxPdfFontDescription::GetFontBBox ( ) const

inline

Get font bounding box.

Returns

the bounding box of the font in string representation

GetItalicAngle()

int wxPdfFontDescription::GetItalicAngle ( ) const

inline

Get italic angle.

Returns

the italic angle

GetMissingWidth()

int wxPdfFontDescription::GetMissingWidth ( ) const

inline

Get missing character width.

Returns

the width of missing characters

GetOpenTypeMetrics()

void wxPdfFontDescription::GetOpenTypeMetrics	(	int *	hheaAscender,
		int *	hheaDescender,
		int *	hheaLineGap,
		int *	os2sTypoAscender,
		int *	os2sTypoDescender,
		int *	os2sTypoLineGap,
		int *	os2usWinAscent,
		int *	os2usWinDescent )

Get OpenType Font Metrics.

Get stored font metrics from the OpneType tables hhea and OS/2

GetStemV()

int wxPdfFontDescription::GetStemV ( ) const

inline

Get StemV.

Returns

the StemV value

GetUnderlinePosition()

int wxPdfFontDescription::GetUnderlinePosition ( ) const

inline

Get underline position.

Returns

the position of the underline decoration

GetUnderlineThickness()

int wxPdfFontDescription::GetUnderlineThickness ( ) const

inline

Get underline thickness.

Returns

the thickness of the underline decoration

GetXHeight()

int wxPdfFontDescription::GetXHeight ( ) const

inline

Get xHeight.

Returns

the height of the character X

SetAscent()

void wxPdfFontDescription::SetAscent ( int ascent )

inline

Set ascender.

Parameters

ascent

ascender

SetCapHeight()

void wxPdfFontDescription::SetCapHeight ( int capHeight )

inline

Set CapHeight.

Parameters

capHeight

the height of capital characters

SetDescent()

void wxPdfFontDescription::SetDescent ( int descent )

inline

Set descender.

Parameters

descent

descender

SetFlags()

void wxPdfFontDescription::SetFlags ( int flags )

inline

Set font flags.

Parameters

flags

the font flags

SetFontBBox()

void wxPdfFontDescription::SetFontBBox ( const wxString & fontBBox )

inline

Set font bounding box.

Parameters

fontBBox

the bounding box of the font in string representation

SetItalicAngle()

void wxPdfFontDescription::SetItalicAngle ( int italicAngle )

inline

Set italic angle.

Parameters

italicAngle

the italic angle

SetMissingWidth()

void wxPdfFontDescription::SetMissingWidth ( int missingWidth )

inline

Set missing character width.

Parameters

missingWidth

the width of missing characters

SetOpenTypeMetrics()

void wxPdfFontDescription::SetOpenTypeMetrics	(	int	hheaAscender,
		int	hheaDescender,
		int	hheaLineGap,
		int	os2sTypoAscender,
		int	os2sTypoDescender,
		int	os2sTypoLineGap,
		int	os2usWinAscent,
		int	os2usWinDescent )

Set OpenType Font Metrics.

Set font metrics from the OpenType tables hhea and OS/2

SetStemV()

void wxPdfFontDescription::SetStemV ( int stemV )

inline

Set StemV.

Parameters

stemV

the StemV value

SetUnderlinePosition()

void wxPdfFontDescription::SetUnderlinePosition ( int underlinePosition )

inline

Set underline position.

Parameters

underlinePosition

the position of the underline decoration

SetUnderlineThickness()

void wxPdfFontDescription::SetUnderlineThickness ( int underlineThickness )

inline

Set underline thickness.

Parameters

underlineThickness

the thickness of the underline decoration

SetXHeight()

void wxPdfFontDescription::SetXHeight ( int xHeight )

inline

Set xHeight.

Parameters

xHeight

the height of the character X

---

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

• pdffontdescription.h