(HOOPS Publish Advanced) Module to define PDF layers. More...

Data Structures

struct  A3DPDFLayerData
 Structure to define a layer. More...
 

Functions

A3DStatus A3DPDFDocumentGetLayer (const A3DPDFDocument *pDoc, const A3DInt32 iNumLayer, A3DPDFLayer **ppLayer)
 Get a layer object by its index in the document. More...
 
A3DStatus A3DPDFDocumentGetLayerByName (const A3DPDFDocument *pDoc, const A3DUTF8Char *pcName, A3DPDFLayer **ppLayer)
 Get a layer object by its name in the document. More...
 
A3DStatus A3DPDFDocumentGetNumberLayers (const A3DPDFDocument *pDoc, A3DInt32 *piNbLayers)
 Function to get the number of layers in the document. More...
 
A3DStatus A3DPDFDocumentSetLayersRBGroup (const A3DPDFDocument *pDoc, A3DUns32 iNbLayers, A3DPDFLayer **ppLayers)
 Define a "radio button" behaviour for a group of layers. That is, the state of at most one layer in the group can be activated at a time. More...
 
A3DStatus A3DPDFFieldSetLayer (A3DPDFField *pField, A3DPDFLayer *pLayer)
 Adds a field into a layer. More...
 
A3DStatus A3DPDFImageSetLayer (A3DPDFImage *pImage, A3DPDFLayer *pLayer)
 Adds an image into a layer. More...
 
A3DStatus A3DPDFLayerCreate (A3DPDFDocument *pDoc, const A3DPDFLayerData *pData, A3DPDFLayer **ppLayer)
 Creates a layer in a document. More...
 
A3DStatus A3DPDFLayerGet (const A3DPDFLayer *pLayer, A3DPDFLayerData *pData)
 Populates the A3DPDFLayerData structure with data from an A3DPDFLayer entity. More...
 
A3DStatus A3DPDFPageInsertScrollTableAndSetLayer (A3DPDFPage *pPage, A3DPDFScrollTable *pScrollTable, const A3DInt32 iPosLeft, const A3DInt32 iPosTop, A3DPDFLayer *pLayer)
 Function to insert a ScrollTable widget in a page. More...
 
A3DStatus A3DPDFPageInsertTableAndSetLayer (A3DPDFPage *pPage, A3DPDFTable *pTable, const A3DInt32 iPosLeft, const A3DInt32 iPosTop, A3DPDFLayer *pLayer)
 Function to insert a table in a page within a layer. More...
 
A3DStatus A3DPDFPageInsertTextAndSetLayer (A3DPDFPage *pPage, A3DPDFText *pText, const A3DInt32 iPosLeft, const A3DInt32 iPosBottom, A3DPDFLayer *pLayer)
 Function to insert a text line in a page within a layer. Warning: This function must be used instead of A3DPDFPageInsertText if the text is to be placed in a layer. More...
 

Detailed Description

(HOOPS Publish Advanced) Module to define PDF layers.

Function Documentation

◆ A3DPDFLayerCreate()

A3DStatus A3DPDFLayerCreate ( A3DPDFDocument pDoc,
const A3DPDFLayerData pData,
A3DPDFLayer **  ppLayer 
)

Creates a layer in a document.

Parameters
[in]pDocThe document to work with.
[in]pDataThe layer data parameters.
[out]ppLayerThe newly-created layer.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFLayerGet()

A3DStatus A3DPDFLayerGet ( const A3DPDFLayer pLayer,
A3DPDFLayerData pData 
)

Populates the A3DPDFLayerData structure with data from an A3DPDFLayer entity.

Parameters
[in]pLayerThe layer to determine data from.
[out]pDataThe layer data parameters.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFDocumentGetNumberLayers()

A3DStatus A3DPDFDocumentGetNumberLayers ( const A3DPDFDocument pDoc,
A3DInt32 piNbLayers 
)

Function to get the number of layers in the document.

Parameters
[in]pDocThe document to work with.
[out]piNbLayersThe number of layers in the document.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFDocumentGetLayer()

A3DStatus A3DPDFDocumentGetLayer ( const A3DPDFDocument pDoc,
const A3DInt32  iNumLayer,
A3DPDFLayer **  ppLayer 
)

Get a layer object by its index in the document.

Parameters
[in]pDocThe document to work with.
[in]iNumLayerThe index of the layer. The first index is 0.
[out]ppLayerThe Layer object.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFDocumentGetLayerByName()

A3DStatus A3DPDFDocumentGetLayerByName ( const A3DPDFDocument pDoc,
const A3DUTF8Char pcName,
A3DPDFLayer **  ppLayer 
)

Get a layer object by its name in the document.

Parameters
[in]pDocThe document to work with.
[in]pcNameThe name of the layer to look for.
[out]ppLayerThe Layer object.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFDocumentSetLayersRBGroup()

A3DStatus A3DPDFDocumentSetLayersRBGroup ( const A3DPDFDocument pDoc,
A3DUns32  iNbLayers,
A3DPDFLayer **  ppLayers 
)

Define a "radio button" behaviour for a group of layers. That is, the state of at most one layer in the group can be activated at a time.

Parameters
[in]pDocThe document to work with.
[in]iNbLayersThe size of the following array of layers.
[in]ppLayersThe array of pointer on layers objects.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFFieldSetLayer()

A3DStatus A3DPDFFieldSetLayer ( A3DPDFField pField,
A3DPDFLayer pLayer 
)

Adds a field into a layer.

Parameters
[in]pFieldthe field to be added
[in]pLayerThe layer in which the field must be added.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFImageSetLayer()

A3DStatus A3DPDFImageSetLayer ( A3DPDFImage pImage,
A3DPDFLayer pLayer 
)

Adds an image into a layer.

Parameters
[in]pImagethe image to be added
[in]pLayerThe layer in which the image must be added.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFPageInsertTableAndSetLayer()

A3DStatus A3DPDFPageInsertTableAndSetLayer ( A3DPDFPage pPage,
A3DPDFTable pTable,
const A3DInt32  iPosLeft,
const A3DInt32  iPosTop,
A3DPDFLayer pLayer 
)

Function to insert a table in a page within a layer.

Warning1: The positioning is not defined as in the other insertion functions (for texts or images). Here, the position is specified from the top of the page. Warning2: This function must be used instead of A3DPDFPageInsertTable if the table is to be placed in a layer.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTableThe Table object to insert on the page.
[in]iPosLeftThe x coordinate of the insertion point of the table. The insertion point is the top left corner of the table. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]iPosTopThe y coordinate of the insertion point of the table. The insertion point is the top left corner of the table. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]pLayerThe layer in which the table must be placed.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFPageInsertTextAndSetLayer()

A3DStatus A3DPDFPageInsertTextAndSetLayer ( A3DPDFPage pPage,
A3DPDFText pText,
const A3DInt32  iPosLeft,
const A3DInt32  iPosBottom,
A3DPDFLayer pLayer 
)

Function to insert a text line in a page within a layer. Warning: This function must be used instead of A3DPDFPageInsertText if the text is to be placed in a layer.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTextThe Text object to insert on the page.
[in]iPosLeftThe x coordinate of the insertion point of the text. The insertion point is the bottom left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]iPosBottomThe y coordinate of the insertion point of the text. The insertion point is the bottom left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]pLayerThe layer in which the text must be placed
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.1

◆ A3DPDFPageInsertScrollTableAndSetLayer()

A3DStatus A3DPDFPageInsertScrollTableAndSetLayer ( A3DPDFPage pPage,
A3DPDFScrollTable pScrollTable,
const A3DInt32  iPosLeft,
const A3DInt32  iPosTop,
A3DPDFLayer pLayer 
)

Function to insert a ScrollTable widget in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pScrollTableThe ScrollTable object to insert on the page.
[in]iPosLeftThe x coordinate of the insertion point of the text. The insertion point is the top left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]iPosTopThe y coordinate of the insertion point of the text. The insertion point is the top left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]pLayerThe layer in which the ScrollTable must be placed
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
A3DPDF_CANNOT_INITIALIZE_RESOURCESif the resources directory is not properly defined.
A3DPDF_CANNOT_LOAD_TABLETOPDF_DLLif the tabletopdf dll cannot be loaded.
Version
10.1