CBookmarksOptions_interface.h File Reference

Interface for CBookmarksOptions wrapper. More...

Go to the source code of this file.

Functions
CBookmarksOptions	CBookmarksOptions_Create (idrs_exception *pargException)
	Create is instantiating a new instance of CBookmarksOptions and associated data object.
void	CBookmarksOptions_SetBookmarksMode (CBookmarksOptions argCBookmarksOptions, enum BookmarksMode const evBookmarksMode, idrs_exception *pargException)
	Sets the bookmarks mode.
enum BookmarksMode	CBookmarksOptions_GetBookmarksMode (const CBookmarksOptions argCBookmarksOptions, idrs_exception *pargException)
	Gets the bookmarks mode.
CPageBookmarkArray	CBookmarksOptions_GenerateBookmarks (const CPageContent argPageContent, const idrs_string strPageTitle, IDRS_UINT const argDestinationPage, idrs_exception *pargException)
	Helper method allowing to automatically generate some bookmarks corresponding to the provided page's content.
CPageBookmarkArray	CBookmarksOptions_GenerateBookmarks2 (const CPageContent argPageContent, const idrs_string strPageTitle, idrs_exception *pargException)
	Helper method allowing to automatically generate some bookmarks corresponding to the provided page's content.
CPageBookmarkArray	CBookmarksOptions_GenerateBookmarks3 (const CPageContent argPageContent, idrs_exception *pargException)
	Helper method allowing to automatically generate some bookmarks corresponding to the provided page's content.
void	CBookmarksOptions_Destroy (CBookmarksOptions argCBookmarksOptions, idrs_exception *pargException)
	Destroys a CBookmarksOptions handle.

Detailed Description

Interface for CBookmarksOptions wrapper.

Function Documentation

CBookmarksOptions_Create()

CBookmarksOptions CBookmarksOptions_Create

(

idrs_exception *

pargException

)

Create is instantiating a new instance of CBookmarksOptions and associated data object.

Returns

New instance of CBookmarksOptions

Parameters

pargException

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

CBookmarksOptions_Destroy()

void CBookmarksOptions_Destroy	(	CBookmarksOptions	argCBookmarksOptions,
		idrs_exception *	pargException
	)

Destroys a CBookmarksOptions handle.

Parameters

argCBookmarksOptions	CBookmarksOptions handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CBookmarksOptions_GenerateBookmarks()

CPageBookmarkArray CBookmarksOptions_GenerateBookmarks	(	const CPageContent	argPageContent,
		const idrs_string	strPageTitle,
		IDRS_UINT const	argDestinationPage,
		idrs_exception *	pargException
	)

Helper method allowing to automatically generate some bookmarks corresponding to the provided page's content.

The generated bookmarks will be organized the following way:

• One bookmark for the whole page, with DisplayMode set to Page
• As children of this page-level bookmark, one bookmark for each detected title, table and graphics. Title bookmarks will have DisplayMode set to PageWidth, while table and graphics bookmarks will have DisplayMode Rectangle. These bookmarks will be added following the reading order of the page.

Parameters

argPageContent	The page content
strPageTitle	The title of the parent bookmark for the whole page.
argDestinationPage	The bookmarks' destination page number starting at index zero. If not set, the first page is selected by default.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The generated bookmarks

CBookmarksOptions_GenerateBookmarks2()

CPageBookmarkArray CBookmarksOptions_GenerateBookmarks2	(	const CPageContent	argPageContent,
		const idrs_string	strPageTitle,
		idrs_exception *	pargException
	)

Helper method allowing to automatically generate some bookmarks corresponding to the provided page's content.

The generated bookmarks will be organized the following way:

• One bookmark for the whole page, with DisplayMode set to Page
• As children of this page-level bookmark, one bookmark for each detected title, table and graphics. Title bookmarks will have DisplayMode set to PageWidth, while table and graphics bookmarks will have DisplayMode Rectangle. These bookmarks will be added following the reading order of the page.

Parameters

argPageContent	The page content
strPageTitle	The title of the parent bookmark for the whole page.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The generated bookmarks

CBookmarksOptions_GenerateBookmarks3()

CPageBookmarkArray CBookmarksOptions_GenerateBookmarks3	(	const CPageContent	argPageContent,
		idrs_exception *	pargException
	)

Helper method allowing to automatically generate some bookmarks corresponding to the provided page's content.

The generated bookmarks will be organized the following way:

• One bookmark for the whole page, with DisplayMode set to Page
• As children of this page-level bookmark, one bookmark for each detected title, table and graphics. Title bookmarks will have DisplayMode set to PageWidth, while table and graphics bookmarks will have DisplayMode Rectangle. These bookmarks will be added following the reading order of the page.

Parameters

argPageContent	The page content
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The generated bookmarks

CBookmarksOptions_GetBookmarksMode()

enum BookmarksMode CBookmarksOptions_GetBookmarksMode	(	const CBookmarksOptions	argCBookmarksOptions,
		idrs_exception *	pargException
	)

Gets the bookmarks mode.

Returns

the bookmarks mode

Parameters

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

CBookmarksOptions_SetBookmarksMode()

void CBookmarksOptions_SetBookmarksMode	(	CBookmarksOptions	argCBookmarksOptions,
		enum BookmarksMode const	evBookmarksMode,
		idrs_exception *	pargException
	)

Sets the bookmarks mode.

Parameters

argCBookmarksOptions	CBookmarksOptions handle
evBookmarksMode	bookmarks mode value
pargException	Pointer to exception structure that will be filled if an exception occurs