CPageFont_interface.h File Reference

Interface for CPageFont wrapper. More...

Go to the source code of this file.

Functions
CPageFont	CPageFont_Create (idrs_exception *pargException)
	Instantiates a new font object.
const idrs_string	CPageFont_GetFontFamilyName (const CPageFont argCPageFont, idrs_exception *pargException)
	Retrieves the family name for the current font.
const idrs_string	CPageFont_GetFontPostscriptName (const CPageFont argCPageFont, idrs_exception *pargException)
	Retrieves the postscript name for the current font.
IDRS_BOOL	CPageFont_IsBold (const CPageFont argCPageFont, idrs_exception *pargException)
	Gets a boolean flag specifying wether the font is bold.
IDRS_BOOL	CPageFont_IsItalic (const CPageFont argCPageFont, idrs_exception *pargException)
	Gets a boolean flag specifying wether the font is italic.
IDRS_BOOL	CPageFont_IsAsian (const CPageFont argCPageFont, idrs_exception *pargException)
	Gets a boolean flag specifying wether the font is asian.
enum FontFamilyType	CPageFont_GetFamilyType (const CPageFont argCPageFont, idrs_exception *pargException)
	Retrieves the font family type.
void	CPageFont_SetFontFamilyName (CPageFont argCPageFont, const idrs_string strFontFamilyName, idrs_exception *pargException)
	Sets the font family name.
void	CPageFont_SetFontPostscriptName (CPageFont argCPageFont, const idrs_string strFontPostscriptName, idrs_exception *pargException)
	Sets the font postscript name.
void	CPageFont_SetBold (CPageFont argCPageFont, IDRS_BOOL const bValue, idrs_exception *pargException)
	Sets the boolean flag for bold property.
void	CPageFont_SetItalic (CPageFont argCPageFont, IDRS_BOOL const bValue, idrs_exception *pargException)
	Sets the italic flag.
void	CPageFont_SetAsian (CPageFont argCPageFont, IDRS_BOOL const bValue, idrs_exception *pargException)
	Sets the asian flag.
void	CPageFont_SetFamilyType (CPageFont argCPageFont, const enum FontFamilyType *const evFamilyType, idrs_exception *pargException)
	Sets the font family type.
void	CPageFont_SetTextFontSet (CPageFont argCPageFont, enum FontInfoComputation const evFontSet, idrs_exception *pargException)
	Sets the font set associated to the font.
enum FontInfoComputation	CPageFont_GetTextFontSet (const CPageFont argCPageFont, idrs_exception *pargException)
	Retrieves the source text font set used for the current font.
void	CPageFont_Destroy (CPageFont argCPageFont, idrs_exception *pargException)
	Destroys a CPageFont handle.
CPageFontArray	ArrayInterface_Create_CPageFontArray (idrs_exception *pargException)
	Creates a new CPageFontArray object.

Detailed Description

Interface for CPageFont wrapper.

Function Documentation

ArrayInterface_Create_CPageFontArray()

CPageFontArray ArrayInterface_Create_CPageFontArray

(

idrs_exception *

pargException

)

Creates a new CPageFontArray object.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created CPageFontArray

CPageFont_Create()

CPageFont CPageFont_Create

(

idrs_exception *

pargException

)

Instantiates a new font object.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CPageFont_Destroy()

void CPageFont_Destroy	(	CPageFont	argCPageFont,
		idrs_exception *	pargException
	)

Destroys a CPageFont handle.

Parameters

argCPageFont	CPageFont handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_GetFamilyType()

enum FontFamilyType CPageFont_GetFamilyType	(	const CPageFont	argCPageFont,
		idrs_exception *	pargException
	)

Retrieves the font family type.

See also

FontFamilyType for a list with available font family types

Parameters

argCPageFont	CPageFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_GetFontFamilyName()

const idrs_string CPageFont_GetFontFamilyName	(	const CPageFont	argCPageFont,
		idrs_exception *	pargException
	)

Retrieves the family name for the current font.

Parameters

argCPageFont	CPageFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_GetFontPostscriptName()

const idrs_string CPageFont_GetFontPostscriptName	(	const CPageFont	argCPageFont,
		idrs_exception *	pargException
	)

Retrieves the postscript name for the current font.

Parameters

argCPageFont	CPageFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_GetTextFontSet()

enum FontInfoComputation CPageFont_GetTextFontSet	(	const CPageFont	argCPageFont,
		idrs_exception *	pargException
	)

Retrieves the source text font set used for the current font.

Parameters

argCPageFont	CPageFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_IsAsian()

IDRS_BOOL CPageFont_IsAsian	(	const CPageFont	argCPageFont,
		idrs_exception *	pargException
	)

Gets a boolean flag specifying wether the font is asian.

Parameters

argCPageFont	CPageFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_IsBold()

IDRS_BOOL CPageFont_IsBold	(	const CPageFont	argCPageFont,
		idrs_exception *	pargException
	)

Gets a boolean flag specifying wether the font is bold.

Parameters

argCPageFont	CPageFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_IsItalic()

IDRS_BOOL CPageFont_IsItalic	(	const CPageFont	argCPageFont,
		idrs_exception *	pargException
	)

Gets a boolean flag specifying wether the font is italic.

Parameters

argCPageFont	CPageFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_SetAsian()

void CPageFont_SetAsian	(	CPageFont	argCPageFont,
		IDRS_BOOL const	bValue,
		idrs_exception *	pargException
	)

Sets the asian flag.

Parameters

argCPageFont	CPageFont handle
bValue	Asian flag
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_SetBold()

void CPageFont_SetBold	(	CPageFont	argCPageFont,
		IDRS_BOOL const	bValue,
		idrs_exception *	pargException
	)

Sets the boolean flag for bold property.

Parameters

argCPageFont	CPageFont handle
bValue	Bold flag
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_SetFamilyType()

void CPageFont_SetFamilyType	(	CPageFont	argCPageFont,
		const enum FontFamilyType *const	evFamilyType,
		idrs_exception *	pargException
	)

Sets the font family type.

Parameters

argCPageFont	CPageFont handle
evFamilyType	Font family type
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_SetFontFamilyName()

void CPageFont_SetFontFamilyName	(	CPageFont	argCPageFont,
		const idrs_string	strFontFamilyName,
		idrs_exception *	pargException
	)

Sets the font family name.

Parameters

argCPageFont	CPageFont handle
strFontFamilyName	NULL terminated utf8 string containing the font family
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_SetFontPostscriptName()

void CPageFont_SetFontPostscriptName	(	CPageFont	argCPageFont,
		const idrs_string	strFontPostscriptName,
		idrs_exception *	pargException
	)

Sets the font postscript name.

Parameters

argCPageFont	CPageFont handle
strFontPostscriptName	NULL terminated utf8 string containing the font post script name
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_SetItalic()

void CPageFont_SetItalic	(	CPageFont	argCPageFont,
		IDRS_BOOL const	bValue,
		idrs_exception *	pargException
	)

Sets the italic flag.

Parameters

argCPageFont	CPageFont handle
bValue	Italic flag
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageFont_SetTextFontSet()

void CPageFont_SetTextFontSet	(	CPageFont	argCPageFont,
		enum FontInfoComputation const	evFontSet,
		idrs_exception *	pargException
	)

Sets the font set associated to the font.

Currently the only FontInfoComputation::Custom is allowed to be created by integrators. Setting any other value might cause an error.

See also

FontInfoComputation for more details

Parameters

argCPageFont	CPageFont handle
evFontSet	Font set
pargException	Pointer to exception structure that will be filled if an exception occurs