Interface for CPageStyleParagraph wrapper. More...

Functions
CPageStyleParagraph	CPageStyleParagraph_Create (idrs_exception *pargException)
	Creates an instance of CPageStyleParagraph and initializes it with default values.

enum HorizontalAlignment	CPageStyleParagraph_GetHorizontalAlignment (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the horizontal alignment.

MarginInfo	CPageStyleParagraph_GetMargins (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the margins for the paragraph.

CPageStyleFont	CPageStyleParagraph_GetFont (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the font style used for the paragraph.

CPageStyleFont	CPageStyleParagraph_GetDropCapFont (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the font style used for the drop-cap character(s)

IDRS_COLOR	CPageStyleParagraph_GetForegroundColor (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the foreground color used for a paragraph.

IDRS_COLOR	CPageStyleParagraph_GetBackgroundColor (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the text paragraph background color.

IDRS_INT	CPageStyleParagraph_GetFirstLineIndentation (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the indentation that should be applied for the first line in the paragraph.

CPageStyleTabulationArray	CPageStyleParagraph_GetPageStyleTabulations (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the list of tabulations applied to the text paragraph.

IDRS_INT	CPageStyleParagraph_GetLineHeight (const CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Get the height of a text line in the paragraph.

void	CPageStyleParagraph_SetHorizontalAlignment (CPageStyleParagraph argCPageStyleParagraph, enum HorizontalAlignment const evHorizontalAlignment, idrs_exception *pargException)
	Set the paragraph text horizontal alignment.

void	CPageStyleParagraph_SetMargins (CPageStyleParagraph argCPageStyleParagraph, const MarginInfo stMargins, idrs_exception pargException)
	Set the paragraph margins.

void	CPageStyleParagraph_SetFont (CPageStyleParagraph argCPageStyleParagraph, const CPageStyleFont argFont, idrs_exception *pargException)
	Set the font style used for the paragraph.

void	CPageStyleParagraph_SetDropCapFont (CPageStyleParagraph argCPageStyleParagraph, const CPageStyleFont argDropCapFont, idrs_exception *pargException)
	Set the font style used for the drop cap character.

void	CPageStyleParagraph_SetForegroundColor (CPageStyleParagraph argCPageStyleParagraph, const IDRS_COLOR stColor, idrs_exception pargException)
	Set the foreground color for the text in the paragraph.

void	CPageStyleParagraph_SetBackgroundColor (CPageStyleParagraph argCPageStyleParagraph, const IDRS_COLOR stColor, idrs_exception pargException)
	Set the background color for the text in the paragraph.

void	CPageStyleParagraph_SetFirstLineIndentation (CPageStyleParagraph argCPageStyleParagraph, IDRS_INT const iFirstLineIndentation, idrs_exception *pargException)
	Set the indentation for the first line in the paragraph.

void	CPageStyleParagraph_SetPageStyleTabulations (CPageStyleParagraph argCPageStyleParagraph, const CPageStyleTabulationArray xPageStyleTabulation, idrs_exception *pargException)
	Set the list of tabulation styles associated to the paragraph.

void	CPageStyleParagraph_SetLineHeight (CPageStyleParagraph argCPageStyleParagraph, IDRS_INT const iLineHeight, idrs_exception *pargException)
	Set the line height for the lines in the paragraph.

void	CPageStyleParagraph_Destroy (CPageStyleParagraph argCPageStyleParagraph, idrs_exception *pargException)
	Destroys a CPageStyleParagraph handle.

CPageStyleParagraphArray	ArrayInterface_Create_CPageStyleParagraphArray (idrs_exception *pargException)
	Creates a new CPageStyleParagraphArray object.

Detailed Description

Interface for CPageStyleParagraph wrapper.

Function Documentation

◆ ArrayInterface_Create_CPageStyleParagraphArray()

CPageStyleParagraphArray ArrayInterface_Create_CPageStyleParagraphArray ( idrs_exception * pargException )

Creates a new CPageStyleParagraphArray object.

Parameters

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

Returns: The newly created CPageStyleParagraphArray

◆ CPageStyleParagraph_Create()

CPageStyleParagraph CPageStyleParagraph_Create ( idrs_exception * pargException )

Creates an instance of CPageStyleParagraph and initializes it with default values.

Parameters

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

◆ CPageStyleParagraph_Destroy()

void CPageStyleParagraph_Destroy	(	CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Destroys a CPageStyleParagraph handle.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetBackgroundColor()

IDRS_COLOR CPageStyleParagraph_GetBackgroundColor	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the text paragraph background color.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetDropCapFont()

CPageStyleFont CPageStyleParagraph_GetDropCapFont	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the font style used for the drop-cap character(s)

This font style is expected to be set only if drop-cap is present in a paragraph

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetFirstLineIndentation()

IDRS_INT CPageStyleParagraph_GetFirstLineIndentation	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the indentation that should be applied for the first line in the paragraph.

The indentation value is specified in pixels

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetFont()

CPageStyleFont CPageStyleParagraph_GetFont	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the font style used for the paragraph.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetForegroundColor()

IDRS_COLOR CPageStyleParagraph_GetForegroundColor	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the foreground color used for a paragraph.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetHorizontalAlignment()

enum HorizontalAlignment CPageStyleParagraph_GetHorizontalAlignment	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the horizontal alignment.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetLineHeight()

IDRS_INT CPageStyleParagraph_GetLineHeight	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the height of a text line in the paragraph.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetMargins()

MarginInfo CPageStyleParagraph_GetMargins	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the margins for the paragraph.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_GetPageStyleTabulations()

CPageStyleTabulationArray CPageStyleParagraph_GetPageStyleTabulations	(	const CPageStyleParagraph	argCPageStyleParagraph,
		idrs_exception *	pargException
	)

Get the list of tabulations applied to the text paragraph.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_SetBackgroundColor()

void CPageStyleParagraph_SetBackgroundColor	(	CPageStyleParagraph	argCPageStyleParagraph,
		const IDRS_COLOR *	stColor,
		idrs_exception *	pargException
	)

Set the background color for the text in the paragraph.

Please note that individual components of the paragraph (lines, words, letters) are allowed to have different background colors

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
stColor	Structure containing the color in RGB components
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_SetDropCapFont()

void CPageStyleParagraph_SetDropCapFont	(	CPageStyleParagraph	argCPageStyleParagraph,
		const CPageStyleFont	argDropCapFont,
		idrs_exception *	pargException
	)

Set the font style used for the drop cap character.

The drop cap font style is used only if the paragraph has a drop cap character

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
argDropCapFont	Font style used by the drop cap character
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_SetFirstLineIndentation()

void CPageStyleParagraph_SetFirstLineIndentation	(	CPageStyleParagraph	argCPageStyleParagraph,
		IDRS_INT const	iFirstLineIndentation,
		idrs_exception *	pargException
	)

Set the indentation for the first line in the paragraph.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
iFirstLineIndentation	Indentation value, in pixels
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_SetFont()

void CPageStyleParagraph_SetFont	(	CPageStyleParagraph	argCPageStyleParagraph,
		const CPageStyleFont	argFont,
		idrs_exception *	pargException
	)

Set the font style used for the paragraph.

Please note that individual components of the paragraph (lines, words, letters) are allowed to have different font styles

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
argFont	Font style used in the paragraph
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_SetForegroundColor()

void CPageStyleParagraph_SetForegroundColor	(	CPageStyleParagraph	argCPageStyleParagraph,
		const IDRS_COLOR *	stColor,
		idrs_exception *	pargException
	)

Set the foreground color for the text in the paragraph.

Please note that individual components of the paragraph (lines, words, letters) are allowed to have different foreground colors

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
stColor	Structure containing the color in RGB components
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_SetHorizontalAlignment()

void CPageStyleParagraph_SetHorizontalAlignment	(	CPageStyleParagraph	argCPageStyleParagraph,
		enum HorizontalAlignment const	evHorizontalAlignment,
		idrs_exception *	pargException
	)

Set the paragraph text horizontal alignment.

Parameters

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

◆ CPageStyleParagraph_SetLineHeight()

void CPageStyleParagraph_SetLineHeight	(	CPageStyleParagraph	argCPageStyleParagraph,
		IDRS_INT const	iLineHeight,
		idrs_exception *	pargException
	)

Set the line height for the lines in the paragraph.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
iLineHeight	Line height value, in pixels
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_SetMargins()

void CPageStyleParagraph_SetMargins	(	CPageStyleParagraph	argCPageStyleParagraph,
		const MarginInfo *	stMargins,
		idrs_exception *	pargException
	)

Set the paragraph margins.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
stMargins	Structure containing the paragraph margins
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageStyleParagraph_SetPageStyleTabulations()

void CPageStyleParagraph_SetPageStyleTabulations	(	CPageStyleParagraph	argCPageStyleParagraph,
		const CPageStyleTabulationArray	xPageStyleTabulation,
		idrs_exception *	pargException
	)

Set the list of tabulation styles associated to the paragraph.

Parameters

argCPageStyleParagraph	CPageStyleParagraph handle
xPageStyleTabulation	Array of tabulation styles
pargException	Pointer to exception structure that will be filled if an exception occurs

Functions

Detailed Description

Function Documentation

◆ ArrayInterface_Create_CPageStyleParagraphArray()

◆ CPageStyleParagraph_Create()

◆ CPageStyleParagraph_Destroy()

◆ CPageStyleParagraph_GetBackgroundColor()

◆ CPageStyleParagraph_GetDropCapFont()

◆ CPageStyleParagraph_GetFirstLineIndentation()

◆ CPageStyleParagraph_GetFont()

◆ CPageStyleParagraph_GetForegroundColor()

◆ CPageStyleParagraph_GetHorizontalAlignment()

◆ CPageStyleParagraph_GetLineHeight()

◆ CPageStyleParagraph_GetMargins()

◆ CPageStyleParagraph_GetPageStyleTabulations()

◆ CPageStyleParagraph_SetBackgroundColor()

◆ CPageStyleParagraph_SetDropCapFont()

◆ CPageStyleParagraph_SetFirstLineIndentation()

◆ CPageStyleParagraph_SetFont()

◆ CPageStyleParagraph_SetForegroundColor()

◆ CPageStyleParagraph_SetHorizontalAlignment()

◆ CPageStyleParagraph_SetLineHeight()

◆ CPageStyleParagraph_SetMargins()

◆ CPageStyleParagraph_SetPageStyleTabulations()