Font processing

Functions
HPDF_Font	HPDF_GetFont (HPDF_Doc pdf, const char *font_name, const char *encoding_name)
	Get requested font object handle. More...
const char *	HPDF_LoadType1FontFromFile (HPDF_Doc pdf, const char *afm_filename, const char *data_filename)
	Load Type1 font from external file and register it in the document object. More...
const char *	HPDF_LoadTTFontFromFile (HPDF_Doc pdf, const char *filename, HPDF_BOOL embedding)
	Load TrueType font from external .ttf file and register it in the document object. More...
const char *	HPDF_LoadTTFontFromFile2 (HPDF_Doc pdf, const char *filename, HPDF_UINT index, HPDF_BOOL embedding)
	Load TrueType font from TrueType collection file *.ttc and register it in the document object. More...
HPDF_STATUS	HPDF_UseJPFonts (HPDF_Doc pdf)
	Enable Japanese fonts. Application can use following Japanese fonts after HPDF_UseJPFonts() call: More...
HPDF_STATUS	HPDF_UseKRFonts (HPDF_Doc pdf)
	Enable Korean fonts. Application can use following Korean fonts after HPDF_UseKRFonts() call: More...
HPDF_STATUS	HPDF_UseCNSFonts (HPDF_Doc pdf)
	Enable simplified Chinese fonts. Application can use following simplified Chinese fonts after HPDF_UseCNSFonts() call: More...
HPDF_STATUS	HPDF_UseCNTFonts (HPDF_Doc pdf)
	Enable traditional Chinese fonts. Application can use following traditional Chinese fonts after HPDF_UseCNTFonts() call: More...
const char *	HPDF_Font_GetFontName (HPDF_Font font)
	Get name of the font. More...
const char *	HPDF_Font_GetEncodingName (HPDF_Font font)
	Get encoding name of the font. More...
HPDF_INT	HPDF_Font_GetUnicodeWidth (HPDF_Font font, HPDF_UNICODE code)
	Get width of a Unicode character in a specific font. More...
HPDF_Box	HPDF_Font_GetBBox (HPDF_Font font)
	Get bounding box of the font. More...
HPDF_INT	HPDF_Font_GetAscent (HPDF_Font font)
	Get vertical ascent of the font. More...
HPDF_INT	HPDF_Font_GetDescent (HPDF_Font font)
	Get vertical descent of the font. More...
HPDF_UINT	HPDF_Font_GetXHeight (HPDF_Font font)
	Get the distance from the baseline and the mean line of lowercase letters in a font. More...
HPDF_UINT	HPDF_Font_GetCapHeight (HPDF_Font font)
	Get the distance from the baseline and the mean line of uppercase letters in a font. More...
HPDF_TextWidth	HPDF_Font_TextWidth (HPDF_Font font, const HPDF_BYTE *text, HPDF_UINT len)
	Get total width of the text, number of characters, and number of words. More...
HPDF_UINT	HPDF_Font_MeasureText (HPDF_Font font, const HPDF_BYTE *text, HPDF_UINT len, HPDF_REAL width, HPDF_REAL font_size, HPDF_REAL char_space, HPDF_REAL word_space, HPDF_BOOL wordwrap, HPDF_REAL *real_width)
	Calculate byte length which can be included within the specified width. More...

Detailed Description

Routines for font loading and measuring

Function Documentation

HPDF_Font_GetAscent()

HPDF_INT HPDF_Font_GetAscent

(

HPDF_Font

font

)

Get vertical ascent of the font.

Parameters

font	Font object handle.

Returns

Font vertical ascent on success, otherwise returns 0.

HPDF_Font_GetBBox()

HPDF_Box HPDF_Font_GetBBox

(

HPDF_Font

font

)

Get bounding box of the font.

Parameters

font	Font object handle.

Returns

HPDF_Box structure specifying font bounding box, otherwise returns HPDF_Box{0, 0, 0, 0}.

HPDF_Font_GetCapHeight()

HPDF_UINT HPDF_Font_GetCapHeight

(

HPDF_Font

font

)

Get the distance from the baseline and the mean line of uppercase letters in a font.

Parameters

font	Font object handle.

Returns

Font cap height value on success, otherwise returns 0.

HPDF_Font_GetDescent()

HPDF_INT HPDF_Font_GetDescent

(

HPDF_Font

font

)

Get vertical descent of the font.

Parameters

font	Font object handle.

Returns

Font vertical descent on success, otherwise returns 0.

HPDF_Font_GetEncodingName()

const char* HPDF_Font_GetEncodingName

(

HPDF_Font

font

)

Get encoding name of the font.

Parameters

font	Font object handle.

Returns

Font encoding name on success, otherwise returns NULL

Examples

ttfont_demo_jp.c.

HPDF_Font_GetFontName()

const char* HPDF_Font_GetFontName

(

HPDF_Font

font

)

Get name of the font.

Parameters

font	Font object handle.

Returns

Font name on success, otherwise returns NULL

Examples

jpfont_demo.c.

HPDF_Font_GetUnicodeWidth()

HPDF_INT HPDF_Font_GetUnicodeWidth	(	HPDF_Font	font,
		HPDF_UNICODE	code
	)

Get width of a Unicode character in a specific font.

Actual character width on the page can be calculated as follows:

HPDF_INT char_width = HPDF_Font_GetUnicodeWidth (font, UNICODE);
float actual_width = char_width * FONT_SIZE / 1000;

Parameters

font	Font object handle.
code	Unicode character

Todo:

Clarify what is FONT_SIZE

Returns

Character width on success, otherwise returns 0

HPDF_Font_GetXHeight()

HPDF_UINT HPDF_Font_GetXHeight

(

HPDF_Font

font

)

Get the distance from the baseline and the mean line of lowercase letters in a font.

Parameters

font	Font object handle.

Returns

Font x-height value on success, otherwise returns 0.

HPDF_Font_MeasureText()

HPDF_UINT HPDF_Font_MeasureText	(	HPDF_Font	font,
		const HPDF_BYTE *	text,
		HPDF_UINT	len,
		HPDF_REAL	width,
		HPDF_REAL	font_size,
		HPDF_REAL	char_space,
		HPDF_REAL	word_space,
		HPDF_BOOL	wordwrap,
		HPDF_REAL *	real_width
	)

Calculate byte length which can be included within the specified width.

Parameters

font	Font object handle.
text	Text to get width
len	Length of the text.
width	Width of the area to put text.
font_size	The size of the font.
char_space	The character spacing value.
word_space	The word spacing value.
wordwrap	Word wrap flag. When there are three words of "ABCDE", "FGH", and "IJKL", and the substring until "J" can be included within the width, if word_wrap parameter is HPDF_FALSE it returns 12, and if word_wrap parameter is HPDF_TRUE, it returns 10 (the end of the previous word).
real_width	If this parameter is not NULL, the real widths of the text is set. An application can set it to NULL, if it is unnecessary.

Returns

Byte length which can be included within the specified width in current font size, character spacing and word spacing. Otherwise it returns 0 and calls error handler.

Todo:

Check if function return byte length or character lenght, it differs in multiple cases.

Todo:

len is byte length or character length?

HPDF_Font_TextWidth()

HPDF_TextWidth HPDF_Font_TextWidth	(	HPDF_Font	font,
		const HPDF_BYTE *	text,
		HPDF_UINT	len
	)

Get total width of the text, number of characters, and number of words.

Parameters

font	Font object handle.
text	The text to get width.
len	- The byte length of the text.

Returns

HPDF_TextWidth struct with calculation results, otherwise, returns HPDF_TextWidth{0, 0, 0, 0}.

Todo:

What is the meaning of fourth param?

Byte length or character length?

HPDF_GetFont()

HPDF_Font HPDF_GetFont	(	HPDF_Doc	pdf,
		const char *	font_name,
		const char *	encoding_name
	)

Get requested font object handle.

Parameters

pdf	Document object handle.
font_name	Valid font name.
encoding_name	Valid encoding name.

Returns

Font object handle on success, otherwise returns NULL and calls error handler.

Error codes

• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_INVALID_DOCUMENT
• HPDF_INVALID_FONT_NAME
• HPDF_INVALID_ENCODING_NAME
• HPDF_UNSUPPORTED_FONT_TYPE

See also

Fonts, Encodings

Examples

attach.c, character_map.c, chfont_demo.c, encoding_list.c, encryption.c, ext_gstate_demo.c, font_demo.c, grid_sheet.c, image_demo.c, jpeg_demo.c, jpfont_demo.c, line_demo.c, link_annotation.c, outline_demo.c, outline_demo_jp.c, permission.c, png_demo.c, raw_image_demo.c, slide_show_demo.c, text_annotation.c, text_demo.c, text_demo2.c, transforms.c, ttfont_demo.c, ttfont_demo_jp.c, and utf8.c.

HPDF_LoadTTFontFromFile()

const char* HPDF_LoadTTFontFromFile	(	HPDF_Doc	pdf,
		const char *	filename,
		HPDF_BOOL	embedding
	)

Load TrueType font from external .ttf file and register it in the document object.

Parameters

pdf	Document object handle.
filename	Path of TrueType font file (.ttf)
embedding	If this parameter is set to HPDF_TRUE, the glyph data of the font is included to PDF file, otherwise only the matrix data is included to PDF file.

Returns

Name of the font on success, otherwise, it returns NULL and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_FONT_EXISTS
• HPDF_INVALID_TTC_INDEX
• HPDF_INVALID_TTC_FILE
• HPDF_TTF_INVALID_CMAP
• HPDF_TTF_INVALID_FOMAT
• HPDF_TTF_MISSING_TABLE
• HPDF_TTF_CANNOT_EMBEDDING_FONT

See also

Fonts

Examples

ttfont_demo.c, ttfont_demo_jp.c, and utf8.c.

HPDF_LoadTTFontFromFile2()

const char* HPDF_LoadTTFontFromFile2	(	HPDF_Doc	pdf,
		const char *	filename,
		HPDF_UINT	index,
		HPDF_BOOL	embedding
	)

Load TrueType font from TrueType collection file *.ttc and register it in the document object.

Parameters

pdf	Document object handle.
filename	Path of TrueType font file (.ttc)
index	Index of font in collection to be loaded.
embedding	If this parameter is set to HPDF_TRUE, the glyph data of the font is included to PDF file, otherwise only the matrix data is included to PDF file.

Returns

Name of the font on success, otherwise, it returns NULL and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_FONT_EXISTS
• HPDF_INVALID_TTC_INDEX
• HPDF_INVALID_TTC_FILE
• HPDF_TTF_INVALID_CMAP
• HPDF_TTF_INVALID_FOMAT
• HPDF_TTF_MISSING_TABLE
• HPDF_TTF_CANNOT_EMBEDDING_FONT
• HPDF_INVALID_TTC_INDEX

See also

Fonts, Encodings

Examples

chfont_demo.c, and ttfont_demo_jp.c.

HPDF_LoadType1FontFromFile()

const char* HPDF_LoadType1FontFromFile	(	HPDF_Doc	pdf,
		const char *	afm_filename,
		const char *	data_filename
	)

Load Type1 font from external file and register it in the document object.

Parameters

pdf	Document object handle.
afm_filename	Path of AFM file
data_filename	Path of PFA/PFB file. If NULL, glyph data of font file is not embedded into the PDF file

Returns

Name of the font on success, otherwise, it returns NULL and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_FONT_EXISTS
• HPDF_INVALID_AFM_HEADER
• HPDF_INVALID_CHAR_MATRICS_DATA
• HPDF_INVALID_N_DATA
• HPDF_UNSUPPORTED_TYPE1_FONT

See also

Fonts

Examples

encoding_list.c.

HPDF_UseCNSFonts()

HPDF_STATUS HPDF_UseCNSFonts

(

HPDF_Doc

pdf

)

Enable simplified Chinese fonts. Application can use following simplified Chinese fonts after HPDF_UseCNSFonts() call:

Font name
SimSun
SimSun,Bold
SimSun,Italic
SimSun,BoldItalic
SimHei
SimHei,Bold
SimHei,Italic
SimHei,BoldItalic

Parameters

pdf	Document object handle.

Returns

HPDF_OK on success, otherwise returns error code and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_DUPLICATE_REGISTRATION

Examples

character_map.c.

HPDF_UseCNTFonts()

HPDF_STATUS HPDF_UseCNTFonts

(

HPDF_Doc

pdf

)

Enable traditional Chinese fonts. Application can use following traditional Chinese fonts after HPDF_UseCNTFonts() call:

Font name
MingLiU
MingLiU,Bold
MingLiU,Italic
MingLiU,BoldItalic

Parameters

pdf	Document object handle.

Returns

HPDF_OK on success, otherwise returns error code and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_DUPLICATE_REGISTRATION

Examples

character_map.c.

HPDF_UseJPFonts()

HPDF_STATUS HPDF_UseJPFonts

(

HPDF_Doc

pdf

)

Enable Japanese fonts. Application can use following Japanese fonts after HPDF_UseJPFonts() call:

Font name
MS-Mincyo
MS-Mincyo,Bold
MS-Mincyo,Italic
MS-Mincyo,BoldItalic
MS-Gothic
MS-Gothic,Bold
MS-Gothic,Italic
MS-Gothic,BoldItalic
MS-PMincyo
MS-PMincyo,Bold
MS-PMincyo,Italic
MS-PMincyo,BoldItalic
MS-PGothic
MS-PGothic,Bold
MS-PGothic,Italic
MS-PGothic,BoldItalic

Parameters

pdf	Document object handle.

Returns

HPDF_OK on success, otherwise returns error code and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_DUPLICATE_REGISTRATION

Examples

character_map.c, and jpfont_demo.c.

HPDF_UseKRFonts()

HPDF_STATUS HPDF_UseKRFonts

(

HPDF_Doc

pdf

)

Enable Korean fonts. Application can use following Korean fonts after HPDF_UseKRFonts() call:

Font name
DotumChe
DotumChe,Bold
DotumChe,Italic
DotumChe,BoldItalic
Dotum
Dotum,Bold
Dotum,Italic
Dotum,BoldItalic
BatangChe
BatangChe,Bold
BatangChe,Italic
BatangChe,BoldItalic
Batang
Batang,Bold
Batang,Italic
Batang,BoldItalic

Parameters

pdf	Document object handle.

Returns

HPDF_OK on success, otherwise returns error code and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_DUPLICATE_REGISTRATION

Examples

character_map.c.