LayOut C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
pagelist.h File Reference
#include <LayOutAPI/common.h>
#include <LayOutAPI/model/defs.h>

Go to the source code of this file.

Functions

LO_RESULT LOPageListCreate (LOPageListRef *page_list)
 Creates a new empty page list object. More...
 
LO_RESULT LOPageListRelease (LOPageListRef *page_list)
 Releases a page list object. *page_list will be set to invalid by this function. More...
 
LO_RESULT LOPageListGetNumberOfPages (LOPageListRef page_list, size_t *num_pages)
 Gets the number of pages in this list. More...
 
LO_RESULT LOPageListGetPageAtIndex (LOPageListRef page_list, size_t index, LOPageRef *page)
 Gets the page at the specified index. More...
 
LO_RESULT LOPageListAddPage (LOPageListRef page_list, LOPageRef page)
 Adds a page at the end of the list. More...
 

Function Documentation

LO_RESULT LOPageListAddPage ( LOPageListRef  page_list,
LOPageRef  page 
)

Adds a page at the end of the list.

Parameters
[in]page_listThe page list object.
[in]pageThe page object to add.
Returns
LO_RESULT LOPageListCreate ( LOPageListRef page_list)

Creates a new empty page list object.

Parameters
[out]page_listAn empty page list object.
Returns
LO_RESULT LOPageListGetNumberOfPages ( LOPageListRef  page_list,
size_t *  num_pages 
)

Gets the number of pages in this list.

Parameters
[in]page_listThe page list object.
[out]num_pagesThe number of page objects in the list.
Returns
LO_RESULT LOPageListGetPageAtIndex ( LOPageListRef  page_list,
size_t  index,
LOPageRef page 
)

Gets the page at the specified index.

Parameters
[in]page_listThe page list object.
[in]indexThe index of the page to get.
[out]pageThe page object at index in the list.
Returns
LO_RESULT LOPageListRelease ( LOPageListRef page_list)

Releases a page list object. *page_list will be set to invalid by this function.

Parameters
[in]page_listThe page list object.
Returns