CPageStyleFont_interface.h File Reference

Interface for CPageStyleFont wrapper. More...

Go to the source code of this file.

Functions
CPageStyleFont	CPageStyleFont_Create (idrs_exception *pargException)
	Instantiates a new CPageStyleFont object.
CPageFont	CPageStyleFont_GetPageFont (const CPageStyleFont argCPageStyleFont, idrs_exception *pargException)
	Retrieves the associated font object.
IDRS_INT	CPageStyleFont_GetFontSize (const CPageStyleFont argCPageStyleFont, idrs_exception *pargException)
	Retrieves the font size.
IDRS_INT	CPageStyleFont_GetFontStretch (const CPageStyleFont argCPageStyleFont, idrs_exception *pargException)
	Retrieves the stretching to be applied for the font.
void	CPageStyleFont_SetPageFont (CPageStyleFont argCPageStyleFont, const CPageFont argPageFont, idrs_exception *pargException)
	Sets the associated font object.
void	CPageStyleFont_SetFontSize (CPageStyleFont argCPageStyleFont, IDRS_INT const iFontSize, idrs_exception *pargException)
	Sets the font size.
void	CPageStyleFont_SetFontStretch (CPageStyleFont argCPageStyleFont, IDRS_INT const iFontStretch, idrs_exception *pargException)
	Sets the font stretching.
void	CPageStyleFont_Destroy (CPageStyleFont argCPageStyleFont, idrs_exception *pargException)
	Destroys a CPageStyleFont handle.
CPageStyleFontArray	ArrayInterface_Create_CPageStyleFontArray (idrs_exception *pargException)
	Creates a new CPageStyleFontArray object.

Detailed Description

Interface for CPageStyleFont wrapper.

Function Documentation

ArrayInterface_Create_CPageStyleFontArray()

CPageStyleFontArray ArrayInterface_Create_CPageStyleFontArray

(

idrs_exception *

pargException

)

Creates a new CPageStyleFontArray object.

Parameters

pargException

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

Returns

The newly created CPageStyleFontArray

CPageStyleFont_Create()

CPageStyleFont CPageStyleFont_Create

(

idrs_exception *

pargException

)

Instantiates a new CPageStyleFont object.

Parameters

pargException

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

CPageStyleFont_Destroy()

void CPageStyleFont_Destroy	(	CPageStyleFont	argCPageStyleFont,
		idrs_exception *	pargException
	)

Destroys a CPageStyleFont handle.

Parameters

argCPageStyleFont	CPageStyleFont handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleFont_GetFontSize()

IDRS_INT CPageStyleFont_GetFontSize	(	const CPageStyleFont	argCPageStyleFont,
		idrs_exception *	pargException
	)

Retrieves the font size.

Parameters

argCPageStyleFont	CPageStyleFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleFont_GetFontStretch()

IDRS_INT CPageStyleFont_GetFontStretch	(	const CPageStyleFont	argCPageStyleFont,
		idrs_exception *	pargException
	)

Retrieves the stretching to be applied for the font.

Default value is 100

Parameters

argCPageStyleFont	CPageStyleFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleFont_GetPageFont()

CPageFont CPageStyleFont_GetPageFont	(	const CPageStyleFont	argCPageStyleFont,
		idrs_exception *	pargException
	)

Retrieves the associated font object.

Parameters

argCPageStyleFont	CPageStyleFont handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleFont_SetFontSize()

void CPageStyleFont_SetFontSize	(	CPageStyleFont	argCPageStyleFont,
		IDRS_INT const	iFontSize,
		idrs_exception *	pargException
	)

Sets the font size.

Parameters

argCPageStyleFont	CPageStyleFont handle
iFontSize	Font size
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleFont_SetFontStretch()

void CPageStyleFont_SetFontStretch	(	CPageStyleFont	argCPageStyleFont,
		IDRS_INT const	iFontStretch,
		idrs_exception *	pargException
	)

Sets the font stretching.

Parameters

argCPageStyleFont	CPageStyleFont handle
iFontStretch	Font stretching, in percentage.
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleFont_SetPageFont()

void CPageStyleFont_SetPageFont	(	CPageStyleFont	argCPageStyleFont,
		const CPageFont	argPageFont,
		idrs_exception *	pargException
	)

Sets the associated font object.

Parameters

argCPageStyleFont	CPageStyleFont handle
argPageFont	Font object
pargException	Pointer to exception structure that will be filled if an exception occurs