
########################
A3DPDF3DViewCarouselData
########################

.. c: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 :c:func:`~A3DPDFButtonCreate`\ and positioned on the page with :c:func:`~A3DPDFPageInsertButton`\ , or they might already exist on the page.
   
   **Returns**
   
   
      A3D_SUCCESS in case of success or an error code
   
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:member:`~A3DPDF3DViewCarouselData.m_iNbButtons`
   * :c:member:`~A3DPDF3DViewCarouselData.m_ppcButtonsNames`
   * :c:member:`~A3DPDF3DViewCarouselData.m_pcPreviousButtonName`
   * :c:member:`~A3DPDF3DViewCarouselData.m_pcNextButtonName`
   * :c:member:`~A3DPDF3DViewCarouselData.m_eScrollDirection`
   * :c:member:`~A3DPDF3DViewCarouselData.m_iScrollStep`
   * :c:member:`~A3DPDF3DViewCarouselData.m_bTransitionActive`
   
   



.. rst-class:: kind-group kind-variable

.. rubric:: Variables
   :class: kind-group-title


.. c:member:: A3DUns32 A3DPDF3DViewCarouselData.m_iNbButtons

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      Size of the following array.
      



.. c:member:: A3DUTF8Char** A3DPDF3DViewCarouselData.m_ppcButtonsNames

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*\*
      
      List of buttons names.
      



.. c:member:: A3DUTF8Char* A3DPDF3DViewCarouselData.m_pcPreviousButtonName

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*
      
      Button name for 'previous' button.
      



.. c:member:: A3DUTF8Char* A3DPDF3DViewCarouselData.m_pcNextButtonName

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*
      
      Button name for 'next' button.
      



.. c:member:: A3DPDFEDirection A3DPDF3DViewCarouselData.m_eScrollDirection

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFEDirection`
      
      Reserved for future use.
      



.. c:member:: A3DInt32 A3DPDF3DViewCarouselData.m_iScrollStep

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~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).
      



.. c:member:: A3DBool A3DPDF3DViewCarouselData.m_bTransitionActive

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      See :c:func:`~A3DPDF3DViewListEnableViewTransitions`\ to control view transition.
      
      For the carousel, it is set to A3D_TRUE by default.
      
      
         13.1
      
      




