wxPdfDocument  0.9.3
Public Member Functions
wxPdfFontDescription Class Reference

Class representing a font description. More...

#include <pdffontdescription.h>

List of all members.

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::wxPdfFontDescription ( )

Default constructor.

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:
ascentascender
descentdescender
capHeightheight of capital characters
flagsfont flags
fontBBoxbounding box of the font
italicAngleitalic angle
stemVstemV value
missingWidthwidth of missing characters
xHeightheight of character X
underlinePositionposition of underline decoration
underlineThicknessthickness of underline decoration
hheaAscenderascender in OpenType table hhea
hheaDescenderdescender in OpenType table hhea
hheaLineGapline gap in OpenType table hhea
os2sTypoAscendertypographic ascender in OpenType table OS/2
os2sTypoDescendertypographic descender in OpenType table OS/2
os2sTypoLineGaptypographic line gap in OpenType table OS/2
os2usWinAscentWindows ascender in OpenType table OS/2
os2usWinDescentWindows descender in OpenType table OS/2
wxPdfFontDescription::wxPdfFontDescription ( const wxPdfFontDescription desc)

Copy constructor.

wxPdfFontDescription::~wxPdfFontDescription ( )

Default destructor.


Member Function Documentation

int wxPdfFontDescription::GetAscent ( ) const
inline

Get ascender.

Returns:
the ascender
int wxPdfFontDescription::GetCapHeight ( ) const
inline

Get CapHeight.

Returns:
the height of capital characters
int wxPdfFontDescription::GetDescent ( ) const
inline

Get descender.

Returns:
the descender
int wxPdfFontDescription::GetFlags ( ) const
inline

Get font flags.

Returns:
the font flags
wxString wxPdfFontDescription::GetFontBBox ( ) const
inline

Get font bounding box.

Returns:
the bounding box of the font in string representation
int wxPdfFontDescription::GetItalicAngle ( ) const
inline

Get italic angle.

Returns:
the italic angle
int wxPdfFontDescription::GetMissingWidth ( ) const
inline

Get missing character width.

Returns:
the width of missing characters
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

int wxPdfFontDescription::GetStemV ( ) const
inline

Get StemV.

Returns:
the StemV value
int wxPdfFontDescription::GetUnderlinePosition ( ) const
inline

Get underline position.

Returns:
the position of the underline decoration
int wxPdfFontDescription::GetUnderlineThickness ( ) const
inline

Get underline thickness.

Returns:
the thickness of the underline decoration
int wxPdfFontDescription::GetXHeight ( ) const
inline

Get xHeight.

Returns:
the height of the character X
void wxPdfFontDescription::SetAscent ( int  ascent)
inline

Set ascender.

Parameters:
ascentascender
void wxPdfFontDescription::SetCapHeight ( int  capHeight)
inline

Set CapHeight.

Parameters:
capHeightthe height of capital characters
void wxPdfFontDescription::SetDescent ( int  descent)
inline

Set descender.

Parameters:
descentdescender
void wxPdfFontDescription::SetFlags ( int  flags)
inline

Set font flags.

Parameters:
flagsthe font flags
void wxPdfFontDescription::SetFontBBox ( const wxString &  fontBBox)
inline

Set font bounding box.

Parameters:
fontBBoxthe bounding box of the font in string representation
void wxPdfFontDescription::SetItalicAngle ( int  italicAngle)
inline

Set italic angle.

Parameters:
italicAnglethe italic angle
void wxPdfFontDescription::SetMissingWidth ( int  missingWidth)
inline

Set missing character width.

Parameters:
missingWidththe width of missing characters
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

void wxPdfFontDescription::SetStemV ( int  stemV)
inline

Set StemV.

Parameters:
stemVthe StemV value
void wxPdfFontDescription::SetUnderlinePosition ( int  underlinePosition)
inline

Set underline position.

Parameters:
underlinePositionthe position of the underline decoration
void wxPdfFontDescription::SetUnderlineThickness ( int  underlineThickness)
inline

Set underline thickness.

Parameters:
underlineThicknessthe thickness of the underline decoration
void wxPdfFontDescription::SetXHeight ( int  xHeight)
inline

Set xHeight.

Parameters:
xHeightthe height of the character X

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