CPageWord_interface.h File Reference

Interface for CPageWord wrapper. More...

Go to the source code of this file.

Functions
CPageWord	CPageWord_Create (idrs_exception *pargException)
	Creates a new instance of CPageWord.
CPolygon	CPageWord_GetBoundingPolygon (const CPageWord argCPageWord, idrs_exception *pargException)
	Retrieves the polygon where the text word is located.
void	CPageWord_SetBoundingPolygon (CPageWord argCPageWord, const CPolygon argBoundingPolygon, idrs_exception *pargException)
	Sets the polygon where the text word is located.
CPageStyleWord	CPageWord_GetStyle (const CPageWord argCPageWord, idrs_exception *pargException)
	Retrieves the style associated to the word.
void	CPageWord_SetStyle (CPageWord argCPageWord, const CPageStyleWord argStyleWord, idrs_exception *pargException)
	Sets the word style.
CPageTextElementArray	CPageWord_GetTextElements (const CPageWord argCPageWord, idrs_exception *pargException)
	Retrieves the array of text elements.
void	CPageWord_SetTextElements (CPageWord argCPageWord, const CPageTextElementArray argTextElements, idrs_exception *pargException)
	Sets the array of text element in the word.
enum Hyperlink	CPageWord_GetHyperlinkType (const CPageWord argCPageWord, idrs_exception *pargException)
	Retrieves the type of hyperlink for the current word.
void	CPageWord_SetHyperlinkType (CPageWord argCPageWord, enum Hyperlink const evHyperlinkType, idrs_exception *pargException)
	Sets the hyperlink type for the word.
void	CPageWord_Destroy (CPageWord argCPageWord, idrs_exception *pargException)
	Destroys a CPageWord handle.
CPageWordArray	ArrayInterface_Create_CPageWordArray (idrs_exception *pargException)
	Creates a new CPageWordArray object.

Detailed Description

Interface for CPageWord wrapper.

Function Documentation

ArrayInterface_Create_CPageWordArray()

CPageWordArray ArrayInterface_Create_CPageWordArray

(

idrs_exception *

pargException

)

Creates a new CPageWordArray object.

Parameters

pargException

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

Returns

The newly created CPageWordArray

CPageWord_Create()

CPageWord CPageWord_Create

(

idrs_exception *

pargException

)

Creates a new instance of CPageWord.

Parameters

pargException

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

Remarks

Instances created by this method can also be provided to CPageCustomData methods

CPageWord_Destroy()

void CPageWord_Destroy	(	CPageWord	argCPageWord,
		idrs_exception *	pargException
	)

Destroys a CPageWord handle.

Parameters

argCPageWord	CPageWord handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageWord_GetBoundingPolygon()

CPolygon CPageWord_GetBoundingPolygon	(	const CPageWord	argCPageWord,
		idrs_exception *	pargException
	)

Retrieves the polygon where the text word is located.

Parameters

argCPageWord	CPageWord handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageWord_GetHyperlinkType()

enum Hyperlink CPageWord_GetHyperlinkType	(	const CPageWord	argCPageWord,
		idrs_exception *	pargException
	)

Retrieves the type of hyperlink for the current word.

By default the value of the hyperlink type is set to Hyperlink::None

Parameters

argCPageWord	CPageWord handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageWord_GetStyle()

CPageStyleWord CPageWord_GetStyle	(	const CPageWord	argCPageWord,
		idrs_exception *	pargException
	)

Retrieves the style associated to the word.

Parameters

argCPageWord	CPageWord handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageWord_GetTextElements()

CPageTextElementArray CPageWord_GetTextElements	(	const CPageWord	argCPageWord,
		idrs_exception *	pargException
	)

Retrieves the array of text elements.

Parameters

argCPageWord	CPageWord handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageWord_SetBoundingPolygon()

void CPageWord_SetBoundingPolygon	(	CPageWord	argCPageWord,
		const CPolygon	argBoundingPolygon,
		idrs_exception *	pargException
	)

Sets the polygon where the text word is located.

Parameters

argCPageWord	CPageWord handle
argBoundingPolygon	Polygon containing the text word
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageWord_SetHyperlinkType()

void CPageWord_SetHyperlinkType	(	CPageWord	argCPageWord,
		enum Hyperlink const	evHyperlinkType,
		idrs_exception *	pargException
	)

Sets the hyperlink type for the word.

By default the value of the hyperlink type is set to Hyperlink::None

Parameters

argCPageWord	CPageWord handle
evHyperlinkType	Hyperlink type
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageWord_SetStyle()

void CPageWord_SetStyle	(	CPageWord	argCPageWord,
		const CPageStyleWord	argStyleWord,
		idrs_exception *	pargException
	)

Sets the word style.

Parameters

argCPageWord	CPageWord handle
argStyleWord	Object containing the word style
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageWord_SetTextElements()

void CPageWord_SetTextElements	(	CPageWord	argCPageWord,
		const CPageTextElementArray	argTextElements,
		idrs_exception *	pargException
	)

Sets the array of text element in the word.

Parameters

argCPageWord	CPageWord handle
argTextElements	Text elements array
pargException	Pointer to exception structure that will be filled if an exception occurs