wxPdfDocument 1.2.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
wxPdfEncoding Class Reference

Class representing a font encoding. More...

#include <pdfencoding.h>

Public Member Functions

 wxPdfEncoding ()
 Default constructor.
 
virtual ~wxPdfEncoding ()
 Destructor.
 
 wxPdfEncoding (const wxPdfEncoding &encoding)
 Copy constructor.
 
wxPdfEncodingoperator= (const wxPdfEncoding &encoding)
 Assignment operator.
 
bool IsOk () const
 Check whether the encoding is valid.
 
bool SetEncoding (const wxString &encoding)
 Set the encoding.
 
wxString GetEncodingName () const
 Get the name of the encoding.
 
wxString GetBaseEncodingName () const
 Get the name of the base encoding.
 
wxString GetDifferences () const
 Get the differences between the encoding and the associated base encoding.
 
wxPdfArrayUint32 GetCMap () const
 Get the character map of the encoding.
 
void InitializeEncodingMap ()
 Initialize the encoding map.
 
const wxPdfChar2GlyphMap * GetEncodingMap () const
 Get the encoding map.
 
wxArrayString GetGlyphNames () const
 Get the list of glyph names supported by the encoding.
 

Static Public Member Functions

static bool GlyphName2Unicode (const wxString &glyphName, wxUint32 &unicode)
 Convert a glyph name to a unicode character.
 
static bool Unicode2GlyphName (wxUint32 unicode, wxString &glyphName)
 Convert a unicode character to a glyph name.
 
static wxArrayString GetKnownEncodings ()
 Get a list of known encodings.
 

Protected Member Functions

void CreateEncodingConvMap ()
 Create the encoding conversion map for user defined encodings.
 

Detailed Description

Class representing a font encoding.

Constructor & Destructor Documentation

◆ wxPdfEncoding() [1/2]

wxPdfEncoding::wxPdfEncoding ( )

Default constructor.

◆ ~wxPdfEncoding()

virtual wxPdfEncoding::~wxPdfEncoding ( )
virtual

Destructor.

◆ wxPdfEncoding() [2/2]

wxPdfEncoding::wxPdfEncoding ( const wxPdfEncoding & encoding)

Copy constructor.

Member Function Documentation

◆ CreateEncodingConvMap()

void wxPdfEncoding::CreateEncodingConvMap ( )
protected

Create the encoding conversion map for user defined encodings.

◆ GetBaseEncodingName()

wxString wxPdfEncoding::GetBaseEncodingName ( ) const

Get the name of the base encoding.

Returns
the name of the base encoding

◆ GetCMap()

wxPdfArrayUint32 wxPdfEncoding::GetCMap ( ) const

Get the character map of the encoding.

Returns
the character map

◆ GetDifferences()

wxString wxPdfEncoding::GetDifferences ( ) const

Get the differences between the encoding and the associated base encoding.

Returns
the difference string

◆ GetEncodingMap()

const wxPdfChar2GlyphMap * wxPdfEncoding::GetEncodingMap ( ) const

Get the encoding map.

Returns
the encoding map

◆ GetEncodingName()

wxString wxPdfEncoding::GetEncodingName ( ) const

Get the name of the encoding.

Returns
the name of the encoding

◆ GetGlyphNames()

wxArrayString wxPdfEncoding::GetGlyphNames ( ) const

Get the list of glyph names supported by the encoding.

Returns
a list of glyph names

◆ GetKnownEncodings()

static wxArrayString wxPdfEncoding::GetKnownEncodings ( )
static

Get a list of known encodings.

Returns
an array containing all known encodings

◆ GlyphName2Unicode()

static bool wxPdfEncoding::GlyphName2Unicode ( const wxString & glyphName,
wxUint32 & unicode )
static

Convert a glyph name to a unicode character.

Parameters
[in]glyphNamename of the glyph
[out]unicodeunicode character of the glyph
Returns
TRUE if the conversion was successful, FALSE otherwise

◆ InitializeEncodingMap()

void wxPdfEncoding::InitializeEncodingMap ( )

Initialize the encoding map.

◆ IsOk()

bool wxPdfEncoding::IsOk ( ) const

Check whether the encoding is valid.

Returns
TRUE if the encoding is valid, FALSE otherwise

◆ operator=()

wxPdfEncoding & wxPdfEncoding::operator= ( const wxPdfEncoding & encoding)

Assignment operator.

◆ SetEncoding()

bool wxPdfEncoding::SetEncoding ( const wxString & encoding)

Set the encoding.

Parameters
encodingthe encoding that should be set

◆ Unicode2GlyphName()

static bool wxPdfEncoding::Unicode2GlyphName ( wxUint32 unicode,
wxString & glyphName )
static

Convert a unicode character to a glyph name.

Parameters
[in]unicodeunicode character of the glyph
[out]glyphNamename of the glyph
Returns
TRUE if the conversion was successful, FALSE otherwise

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