.. _group__a3d__pdf__iconimage__module:

#################
Icon Image Module
#################

**(HOOPS Publish Advanced)**\ Module to define icon image used for interactivity.

This module describes the functions that allows to define an icon image that can be used for interactivity.

Icon images are stored into the document on a way that is accessible for interactivity. An icon image is referenced by its identifier during interactivity. Identifier must be unique in the document. An Icon image can be set as button icon, which can be set by javascript. Also, icons can be set interactively on widgets populated by data model (Button or Scrolltable).

**Parameters**


   **pDoc**\ : The Document object to work with.

   **pImage**\ : The image to store as icon in the Document.

   **pcInIconId**\ : The icon identifier. If provided, this is the internal id used into PDF document to name the icon. Warning, the name should be unique into the document! If NULL is specified, a unique id is automatically generated. The unique id is returned in ``ppcOutIconId``\ argument.

   **ppcOutIconId**\ : The identifier as a string. NULL is accepted if this information is not useful.


**Returns**


   A3D_SUCCESS in case of success or an error code


.. rst-class:: kind-group kind-function

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


.. rst-class:: api-xref-list


* :c:func:`~A3DPDFDocumentAddImageAsIcon2`

.. toctree::
   :maxdepth: 1
   :hidden:

   ../functions/A3DPDFDocumentAddImageAsIcon2


