CPageParagraphsGroup_interface.h File Reference

Interface for CPageParagraphsGroup wrapper. More...

Go to the source code of this file.

Functions
CPageParagraphsGroup	CPageParagraphsGroup_Create (idrs_exception *pargException)
	Creates a new instance of CPageParagraphsGroup.
CPolygon	CPageParagraphsGroup_GetBoundingPolygon (const CPageParagraphsGroup argCPageParagraphsGroup, idrs_exception *pargException)
	Returns the polygon that embeds the paragraphs group content.
void	CPageParagraphsGroup_SetBoundingPolygon (CPageParagraphsGroup argCPageParagraphsGroup, const CPolygon argBoundingPolygon, idrs_exception *pargException)
	Sets the polygon that embeds the paragraphs group content.
CPageStyleParagraph	CPageParagraphsGroup_GetStyle (const CPageParagraphsGroup argCPageParagraphsGroup, idrs_exception *pargException)
	Retrieves the style that is applied to the paragraphs group.
CPageParagraphArray	CPageParagraphsGroup_GetParagraphs (const CPageParagraphsGroup argCPageParagraphsGroup, idrs_exception *pargException)
	Returns the list with inner paragraphs.
void	CPageParagraphsGroup_SetStyle (CPageParagraphsGroup argCPageParagraphsGroup, const CPageStyleParagraph argPageStyleParagraph, idrs_exception *pargException)
	Sets the paragraph group style.
void	CPageParagraphsGroup_SetParagraphs (CPageParagraphsGroup argCPageParagraphsGroup, const CPageParagraphArray xParagraphs, idrs_exception *pargException)
	Sets the list with paragraphs.
enum ParagraphType	CPageParagraphsGroup_GetParagraphType (const CPageParagraphsGroup argCPageParagraphsGroup, idrs_exception *pargException)
	Gets the paragraph type for the paragraphs in the group.
CPageStyleParagraphList	CPageParagraphsGroup_GetParagraphListStyle (const CPageParagraphsGroup argCPageParagraphsGroup, idrs_exception *pargException)
	Returns the paragraph list style applied to the paragraph group.
void	CPageParagraphsGroup_SetParagraphType (CPageParagraphsGroup argCPageParagraphsGroup, enum ParagraphType const evParagraphType, idrs_exception *pargException)
	Sets the paragraph type for the paragraphs in the group.
void	CPageParagraphsGroup_SetParagraphListStyle (CPageParagraphsGroup argCPageParagraphsGroup, const CPageStyleParagraphList argPageParagraphList, idrs_exception *pargException)
	Sets the paragraph list style applied to the paragraph group.
void	CPageParagraphsGroup_Destroy (CPageParagraphsGroup argCPageParagraphsGroup, idrs_exception *pargException)
	Destroys a CPageParagraphsGroup handle.
CPageParagraphsGroupArray	ArrayInterface_Create_CPageParagraphsGroupArray (idrs_exception *pargException)
	Creates a new CPageParagraphsGroupArray object.

Detailed Description

Interface for CPageParagraphsGroup wrapper.

Function Documentation

ArrayInterface_Create_CPageParagraphsGroupArray()

CPageParagraphsGroupArray ArrayInterface_Create_CPageParagraphsGroupArray

(

idrs_exception *

pargException

)

Creates a new CPageParagraphsGroupArray object.

Parameters

pargException

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

Returns

The newly created CPageParagraphsGroupArray

CPageParagraphsGroup_Create()

CPageParagraphsGroup CPageParagraphsGroup_Create

(

idrs_exception *

pargException

)

Creates a new instance of CPageParagraphsGroup.

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

CPageParagraphsGroup_Destroy()

void CPageParagraphsGroup_Destroy	(	CPageParagraphsGroup	argCPageParagraphsGroup,
		idrs_exception *	pargException
	)

Destroys a CPageParagraphsGroup handle.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_GetBoundingPolygon()

CPolygon CPageParagraphsGroup_GetBoundingPolygon	(	const CPageParagraphsGroup	argCPageParagraphsGroup,
		idrs_exception *	pargException
	)

Returns the polygon that embeds the paragraphs group content.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_GetParagraphListStyle()

CPageStyleParagraphList CPageParagraphsGroup_GetParagraphListStyle	(	const CPageParagraphsGroup	argCPageParagraphsGroup,
		idrs_exception *	pargException
	)

Returns the paragraph list style applied to the paragraph group.

The paragraph list style is expected to be used only if the group paragraph type is ParagraphType::List

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_GetParagraphs()

CPageParagraphArray CPageParagraphsGroup_GetParagraphs	(	const CPageParagraphsGroup	argCPageParagraphsGroup,
		idrs_exception *	pargException
	)

Returns the list with inner paragraphs.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_GetParagraphType()

enum ParagraphType CPageParagraphsGroup_GetParagraphType	(	const CPageParagraphsGroup	argCPageParagraphsGroup,
		idrs_exception *	pargException
	)

Gets the paragraph type for the paragraphs in the group.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_GetStyle()

CPageStyleParagraph CPageParagraphsGroup_GetStyle	(	const CPageParagraphsGroup	argCPageParagraphsGroup,
		idrs_exception *	pargException
	)

Retrieves the style that is applied to the paragraphs group.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_SetBoundingPolygon()

void CPageParagraphsGroup_SetBoundingPolygon	(	CPageParagraphsGroup	argCPageParagraphsGroup,
		const CPolygon	argBoundingPolygon,
		idrs_exception *	pargException
	)

Sets the polygon that embeds the paragraphs group content.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
argBoundingPolygon	Bounding polygon
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_SetParagraphListStyle()

void CPageParagraphsGroup_SetParagraphListStyle	(	CPageParagraphsGroup	argCPageParagraphsGroup,
		const CPageStyleParagraphList	argPageParagraphList,
		idrs_exception *	pargException
	)

Sets the paragraph list style applied to the paragraph group.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
argPageParagraphList	Paragraph list style object
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_SetParagraphs()

void CPageParagraphsGroup_SetParagraphs	(	CPageParagraphsGroup	argCPageParagraphsGroup,
		const CPageParagraphArray	xParagraphs,
		idrs_exception *	pargException
	)

Sets the list with paragraphs.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
xParagraphs	List containing the paragraphs in the group
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_SetParagraphType()

void CPageParagraphsGroup_SetParagraphType	(	CPageParagraphsGroup	argCPageParagraphsGroup,
		enum ParagraphType const	evParagraphType,
		idrs_exception *	pargException
	)

Sets the paragraph type for the paragraphs in the group.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
evParagraphType	Group paragraph type
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageParagraphsGroup_SetStyle()

void CPageParagraphsGroup_SetStyle	(	CPageParagraphsGroup	argCPageParagraphsGroup,
		const CPageStyleParagraph	argPageStyleParagraph,
		idrs_exception *	pargException
	)

Sets the paragraph group style.

Parameters

argCPageParagraphsGroup	CPageParagraphsGroup handle
argPageStyleParagraph	Style to be applied to the entire paragraph group
pargException	Pointer to exception structure that will be filled if an exception occurs