Foxit PDF SDK

Public Member Functions | List of all members
foxit::common::FontMapperCallback Class Referenceabstract

## Public Member Functions
virtual StringArray | MapFont (const char *font_family_name, Font::Charset charset, uint32 styles, int weight, int italic_angle)=0
| A callback function used to map a suitable font according to input parameters. More...
virtual FontMapResult | MapFont (const char *font_name, bool is_truetype, uint32 styles, int weight, int italic_angle, Font::Charset charset)=0
| (This function will be deprecated in the future. It is recommended to use FontMapperCallback::MapFont which returns StringArray. ) A callback function used to map a suitable font according to input parameters. More...
virtual void | Release ()=0
| A callback function used to release current callback object itself. More...

## Detailed Description

This class represents a callback object to map font in customized way. All the pure virtual functions in this class are used as callback functions and should be implemented by user. An implemented FontMapperCallback object can be set to Foxit PDF SDK by function Library::SetFontMapperCallback.

See also
  Library

## Member Function Documentation

## ◆ MapFont() [1/2]

virtual StringArray foxit::common::FontMapperCallback::MapFont | ( | const char * | font_family_name,
|  | Font::Charset | charset,
|  | uint32 | styles,
|  | int | weight,
|  | int | italic_angle
| ) |  |
| pure virtual

A callback function used to map a suitable font according to input parameters.

Parameters

  [in] | font_family_name | Font family name.
  [in] | charset | The charset of the font to be mapped. Please refer to values starting from Font::e_CharsetANSI and this would be one of these values.
  [in] | styles | Font styles. Please refer to values starting from Font::e_StyleFixedPitch and this would be one or a combination of these values.
  [in] | weight | Original font weight. 0 means unspecified.
  [in] | italic_angle | Italic angle.

Returns
  Font family name array. If the returned array is empty, that means no mapped font is found.

## ◆ MapFont() [2/2]

virtual FontMapResult foxit::common::FontMapperCallback::MapFont | ( | const char * | font_name,
|  | bool | is_truetype,
|  | uint32 | styles,
|  | int | weight,
|  | int | italic_angle,
|  | Font::Charset | charset
| ) |  |
| pure virtual

(This function will be deprecated in the future. It is recommended to use FontMapperCallback::MapFont which returns StringArray. )
A callback function used to map a suitable font according to input parameters.

Parameters

  [in] | font_name | Font name.
  [in] | is_truetype | true means the font is expected to be a TrueType font, while false means the font is expected to be a Type1 font.
  [in] | styles | Font styles. Please refer to values starting from Font::e_StyleFixedPitch and this would be one or a combination of these values.
  [in] | weight | Original font weight. 0 means unspecified.
  [in] | italic_angle | Italic angle.
  [in] | charset | The charset of the font to be mapped. Please refer to values starting from Font::e_CharsetANSI and this would be one of these values.

Returns
  Font map result object. If any member in the returned FontMapResult is invalid, that means no mapped font is found. Then Foxit PDF SDK will do font mapping.

## ◆ Release()

virtual void foxit::common::FontMapperCallback::Release | ( |  | ) |
| pure virtual

A callback function used to release current callback object itself.

Returns
  None.