.. include:: ../../toolkit-substitutions
.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. _OEDepict_OEAddSVGClickEvent:


.. oe:function:: OEAddSVGClickEvent


   .. list-table:: **The overloaded versions of the  OEAddSVGClickEvent function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEAddSVGClickEvent(disp, adisp, message)<api_OEAddSVGClickEvent_OE2DMolDisplay>`
        - adding click event to :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`
      * - :ref:`OEAddSVGClickEvent(disp, bdisp, message)<api_OEAddSVGClickEvent_OE2DMolDisplay>`
        - adding click event to :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>`
      * - :ref:`OEAddSVGClickEvent(svggroup, message)<api_OEAddSVGClickEvent_OESVGGroup>`
        - adding click event to :ref:`OESVGGroup <OEDepict_OESVGGroup>` (low-level function)

   .. _api_OEAddSVGClickEvent_OE2DMolDisplay:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddSVGClickEvent(OE2DMolDisplay& disp, OE2DAtomDisplay* adisp,
                                 const std::string& message)
         bool OEAddSVGClickEvent(OE2DMolDisplay& disp, OE2DBondDisplay* bdisp,
                                 const std::string& message)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSVGClickEvent(arg1: OE2DMolDisplay, arg2: OE2DAtomDisplay,
                            message: str) -> bool
         OEAddSVGClickEvent(arg1: OE2DMolDisplay, arg2: OE2DBondDisplay,
                            message: str) -> bool

   Adds a click event to an atom or bond in an :file:`.svg` image.
   When clicking at the position defined by the given atom or bond
   display, an event is triggered with the given message.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   .. seealso::

      * :ref:`chapter_svg` chapter including the
        :ref:`section_svg_event` section

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that holds the
      data necessary to depict the molecule with which it is
      initialized.

   *adisp*
      The :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object that defines the
      mouse click position.

   *bdisp*
      The :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object that defines the
      mouse click position

   *message*
      The text that will be emitted when an event is triggered
      on mouse click.

   **Example for adding event for atom displays**

   .. oe:source:: AddAtomClickEvent.cpp
      :language: c++
      :frag:     SNIPPET-ADDATOMCLICKEVENT

   .. oe:source:: AddAtomClickEvent.py
      :language: python
      :frag:     SNIPPET-ADDATOMCLICKEVENT

   .. oe:source:: AddAtomClickEvent.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADDATOMCLICKEVENT

   .. oe:source:: AddAtomClickEvent.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADDATOMCLICKEVENT


   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`AddAtomClickEvent.cpp <../../../../../sublibs/tklibs/depict/examples/docs/AddAtomClickEvent.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`AddAtomClickEvent.py <../../../../../wrappers/python/docexamples/depict/AddAtomClickEvent.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`AddAtomClickEvent.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/AddAtomClickEvent.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`AddAtomClickEvent.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/AddAtomClickEvent.cs>`


   **Example for adding event for bond displays**

   .. oe:source:: AddBondClickEvent.cpp
      :language: c++
      :frag:     SNIPPET-ADDBONDCLICKEVENT

   .. oe:source:: AddBondClickEvent.py
      :language: python
      :frag:     SNIPPET-ADDBONDCLICKEVENT

   .. oe:source:: AddBondClickEvent.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADDBONDCLICKEVENT

   .. oe:source:: AddBondClickEvent.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADDBONDCLICKEVENT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`AddBondClickEvent.cpp <../../../../../sublibs/tklibs/depict/examples/docs/AddBondClickEvent.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`AddBondClickEvent.py <../../../../../wrappers/python/docexamples/depict/AddBondClickEvent.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`AddBondClickEvent.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/AddBondClickEvent.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`AddBondClickEvent.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/AddBondClickEvent.cs>`

   .. seealso::

      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
      * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` and :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` classes

   .. #######################################################################################

   .. _api_OEAddSVGClickEvent_OESVGGroup:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddSVGClickEvent(OESVGGroup* svggroup,
                                 const std::string& message)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSVGClickEvent(svggroup: OESVGGroup, message: str) -> bool

   Adds a click event to a specific SVG group in :file:`.svg` image.
   When clicking at the elements drawn inside the given
   :ref:`OESVGGroup <OEDepict_OESVGGroup>` object, an event is triggered
   with the given message

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   .. hint::

      The :oe:func:`OEDepict::OEAddSVGClickEvent` function should always be called
      prior to pushing / popping the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.


   **Example:**

   The following example creates an :file:`.svg` image with a red rectangle and
   a blue circle.
   Both drawing elements are rendered inside :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects
   that are associated with messages ``clicked on rectangle`` and ``clicked on circle``,
   respectively.
   When the generated :file:`.svg` image is displayed in a HTTP server, clicking
   on the rectangle and the circle triggers events with the corresponding messages.

   .. oe:source:: AddSVGClickEvent.cpp
      :language: c++
      :frag:     SNIPPET-ADD-CLICK-EVENT

   .. oe:source:: AddSVGClickEvent.py
      :language: python
      :frag:     SNIPPET-ADD-CLICK-EVENT

   .. oe:source:: AddSVGClickEvent.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADD-CLICK-EVENT

   .. oe:source:: AddSVGClickEvent.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADD-CLICK-EVENT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`AddSVGClickEvent.cpp <../../../../../sublibs/tklibs/depict/examples/docs/AddBondClickEvent.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`AddSVGClickEvent.py <../../../../../wrappers/python/docexamples/depict/AddSVGClickEvent.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`AddSVGClickEvent.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/AddSVGClickEvent.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`AddSVGClickEvent.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/AddSVGClickEvent.cs>`

   .. seealso::

      * :ref:`chapter_svg` chapter including the
        :ref:`section_svg_event` section that shows how to test
        the :file:`.svg` image file generated by this example.
      * :oe:func:`OEDepict::OEAddSVGHover` function
      * :oe:func:`OEDepict::OEAddSVGToggle` function
