A3DPDF3DViewCarouselData

struct A3DPDF3DViewCarouselData

Structure to define a view carousel widget.

The PDF document must contain the buttons for the views and the buttons to go to the next and the previous view. All buttons should be on the same page. The buttons should have been primarily created with A3DPDFButtonCreate() and positioned on the page with A3DPDFPageInsertButton(), or they might already exist on the page.

Returns

A3D_SUCCESS in case of success or an error code

Index

Variables

• m_iNbButtons
• m_ppcButtonsNames
• m_pcPreviousButtonName
• m_pcNextButtonName
• m_eScrollDirection
• m_iScrollStep
• m_bTransitionActive

Variables

A3DUns32 A3DPDF3DViewCarouselData.m_iNbButtons

A3DUns32

Size of the following array.

A3DUTF8Char **A3DPDF3DViewCarouselData.m_ppcButtonsNames

A3DUTF8Char**

List of buttons names.

A3DUTF8Char *A3DPDF3DViewCarouselData.m_pcPreviousButtonName

A3DUTF8Char*

Button name for ‘previous’ button.

A3DUTF8Char *A3DPDF3DViewCarouselData.m_pcNextButtonName

A3DUTF8Char*

Button name for ‘next’ button.

A3DPDFEDirection A3DPDF3DViewCarouselData.m_eScrollDirection

A3DPDFEDirection

Reserved for future use.

A3DInt32 A3DPDF3DViewCarouselData.m_iScrollStep

A3DInt32

Scroll step (how much buttons icons are scrolled when pushing previous or next).

If m_iScrollStep = m_iNbButtons, the carousel scrolls the icons by page (all the icons are replaced in the carousel). If m_iScrollStep = the number of rows, the icons are scrolled by rows. If m_iScrollStep = the number of columns, the icons are scrolled by columns. If m_iScrollStep = 1, the carousel scrolls the icons one by one (all the icons are shifted of 1 increment in the carousel).

A3DBool A3DPDF3DViewCarouselData.m_bTransitionActive

A3DBool

See A3DPDF3DViewListEnableViewTransitions() to control view transition.

13.1

For the carousel, it is set to A3D_TRUE by default.