CPageStyleTabulation_interface.h File Reference

Interface for CPageStyleTabulation wrapper. More...

Go to the source code of this file.

Functions
CPageStyleTabulation	CPageStyleTabulation_Create (idrs_exception *pargException)
	Creates a new instance of a CPageStyleTabulation object.
IDRS_INT	CPageStyleTabulation_GetStopValue (const CPageStyleTabulation argCPageStyleTabulation, idrs_exception *pargException)
	Retrieves the tabulation stop value.
enum HorizontalAlignment	CPageStyleTabulation_GetHorizontalAlignment (const CPageStyleTabulation argCPageStyleTabulation, idrs_exception *pargException)
	Returns the horizontal alignment for the tabulation.
enum TabulationLeader	CPageStyleTabulation_GetTabulationLeader (const CPageStyleTabulation argCPageStyleTabulation, idrs_exception *pargException)
	Returns the tabulation leader type.
void	CPageStyleTabulation_SetStopValue (CPageStyleTabulation argCPageStyleTabulation, IDRS_INT const iStopValue, idrs_exception *pargException)
	Sets the tabulation stop value.
void	CPageStyleTabulation_SetHorizontalAlignment (CPageStyleTabulation argCPageStyleTabulation, enum HorizontalAlignment const evHorizontalAlignment, idrs_exception *pargException)
	Sets the horizontal alignment for the tabulation.
void	CPageStyleTabulation_SetTabulationLeader (CPageStyleTabulation argCPageStyleTabulation, enum TabulationLeader const evTabLeader, idrs_exception *pargException)
	Sets the tabulation leader type.
IDRS_UINT	CPageStyleTabulation_GetId (const CPageStyleTabulation argCPageStyleTabulation, idrs_exception *pargException)
	Retrieves the id associated to the tabulation style.
IDRS_UINT	CPageStyleTabulation_GetCellWidth (const CPageStyleTabulation argCPageStyleTabulation, idrs_exception *pargException)
	Retrieves the tabulation cell width.
IDRS_INT	CPageStyleTabulation_GetLeftPadding (const CPageStyleTabulation argCPageStyleTabulation, idrs_exception *pargException)
	Returns the tabulation left padding.
IDRS_INT	CPageStyleTabulation_GetRightPadding (const CPageStyleTabulation argCPageStyleTabulation, idrs_exception *pargException)
	Returns the tabulation right padding.
void	CPageStyleTabulation_SetId (CPageStyleTabulation argCPageStyleTabulation, IDRS_UINT const uiId, idrs_exception *pargException)
	Sets the id for the tabulation style.
void	CPageStyleTabulation_SetCellWidth (CPageStyleTabulation argCPageStyleTabulation, IDRS_UINT const uiCellWidth, idrs_exception *pargException)
	Sets the tabulation cell width.
void	CPageStyleTabulation_SetLeftPadding (CPageStyleTabulation argCPageStyleTabulation, IDRS_INT const iLeftPadding, idrs_exception *pargException)
	Sets the tabulation style left padding.
void	CPageStyleTabulation_SetRightPadding (CPageStyleTabulation argCPageStyleTabulation, IDRS_INT const iRightPadding, idrs_exception *pargException)
	Sets the tabulation style right padding.
void	CPageStyleTabulation_Destroy (CPageStyleTabulation argCPageStyleTabulation, idrs_exception *pargException)
	Destroys a CPageStyleTabulation handle.
CPageStyleTabulationArray	ArrayInterface_Create_CPageStyleTabulationArray (idrs_exception *pargException)
	Creates a new CPageStyleTabulationArray object.

Detailed Description

Interface for CPageStyleTabulation wrapper.

Function Documentation

ArrayInterface_Create_CPageStyleTabulationArray()

CPageStyleTabulationArray ArrayInterface_Create_CPageStyleTabulationArray

(

idrs_exception *

pargException

)

Creates a new CPageStyleTabulationArray object.

Parameters

pargException

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

Returns

The newly created CPageStyleTabulationArray

CPageStyleTabulation_Create()

CPageStyleTabulation CPageStyleTabulation_Create

(

idrs_exception *

pargException

)

Creates a new instance of a CPageStyleTabulation object.

Parameters

pargException

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

CPageStyleTabulation_Destroy()

void CPageStyleTabulation_Destroy	(	CPageStyleTabulation	argCPageStyleTabulation,
		idrs_exception *	pargException
	)

Destroys a CPageStyleTabulation handle.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_GetCellWidth()

IDRS_UINT CPageStyleTabulation_GetCellWidth	(	const CPageStyleTabulation	argCPageStyleTabulation,
		idrs_exception *	pargException
	)

Retrieves the tabulation cell width.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_GetHorizontalAlignment()

enum HorizontalAlignment CPageStyleTabulation_GetHorizontalAlignment	(	const CPageStyleTabulation	argCPageStyleTabulation,
		idrs_exception *	pargException
	)

Returns the horizontal alignment for the tabulation.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_GetId()

IDRS_UINT CPageStyleTabulation_GetId	(	const CPageStyleTabulation	argCPageStyleTabulation,
		idrs_exception *	pargException
	)

Retrieves the id associated to the tabulation style.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_GetLeftPadding()

IDRS_INT CPageStyleTabulation_GetLeftPadding	(	const CPageStyleTabulation	argCPageStyleTabulation,
		idrs_exception *	pargException
	)

Returns the tabulation left padding.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_GetRightPadding()

IDRS_INT CPageStyleTabulation_GetRightPadding	(	const CPageStyleTabulation	argCPageStyleTabulation,
		idrs_exception *	pargException
	)

Returns the tabulation right padding.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_GetStopValue()

IDRS_INT CPageStyleTabulation_GetStopValue	(	const CPageStyleTabulation	argCPageStyleTabulation,
		idrs_exception *	pargException
	)

Retrieves the tabulation stop value.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_GetTabulationLeader()

enum TabulationLeader CPageStyleTabulation_GetTabulationLeader	(	const CPageStyleTabulation	argCPageStyleTabulation,
		idrs_exception *	pargException
	)

Returns the tabulation leader type.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_SetCellWidth()

void CPageStyleTabulation_SetCellWidth	(	CPageStyleTabulation	argCPageStyleTabulation,
		IDRS_UINT const	uiCellWidth,
		idrs_exception *	pargException
	)

Sets the tabulation cell width.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
uiCellWidth	Tabulation cell width
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_SetHorizontalAlignment()

void CPageStyleTabulation_SetHorizontalAlignment	(	CPageStyleTabulation	argCPageStyleTabulation,
		enum HorizontalAlignment const	evHorizontalAlignment,
		idrs_exception *	pargException
	)

Sets the horizontal alignment for the tabulation.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
evHorizontalAlignment	Horizontal alignment value
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_SetId()

void CPageStyleTabulation_SetId	(	CPageStyleTabulation	argCPageStyleTabulation,
		IDRS_UINT const	uiId,
		idrs_exception *	pargException
	)

Sets the id for the tabulation style.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
uiId	Unique id for the tabulation style
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_SetLeftPadding()

void CPageStyleTabulation_SetLeftPadding	(	CPageStyleTabulation	argCPageStyleTabulation,
		IDRS_INT const	iLeftPadding,
		idrs_exception *	pargException
	)

Sets the tabulation style left padding.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
iLeftPadding	Left padding value
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_SetRightPadding()

void CPageStyleTabulation_SetRightPadding	(	CPageStyleTabulation	argCPageStyleTabulation,
		IDRS_INT const	iRightPadding,
		idrs_exception *	pargException
	)

Sets the tabulation style right padding.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
iRightPadding	Right padding value
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_SetStopValue()

void CPageStyleTabulation_SetStopValue	(	CPageStyleTabulation	argCPageStyleTabulation,
		IDRS_INT const	iStopValue,
		idrs_exception *	pargException
	)

Sets the tabulation stop value.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
iStopValue	Tabulation stop value
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageStyleTabulation_SetTabulationLeader()

void CPageStyleTabulation_SetTabulationLeader	(	CPageStyleTabulation	argCPageStyleTabulation,
		enum TabulationLeader const	evTabLeader,
		idrs_exception *	pargException
	)

Sets the tabulation leader type.

Parameters

argCPageStyleTabulation	CPageStyleTabulation handle
evTabLeader	Tabulation leader type
pargException	Pointer to exception structure that will be filled if an exception occurs