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

.. oe:namespace:: OEDepict

.. _OEDepict_OEAddSVGToggle:


.. oe:function:: OEAddSVGToggle


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

      .. oe:api::

         bool OEAddSVGToggle(OESVGGroup* area, OESVGGroup* target,
                             bool on = false)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSVGToggle(area: OESVGGroup, target: OESVGGroup, on: bool = False) -> bool

   Adds a toggle effect to the objects drawn between the two given
   groups.
   When clicking on the objects drawn inside the **area** group
   the objects drawn in the **target** group appear / disappear.

   *on*
      The parameter that determine whether the objects drawn inside
      the **target** group are displayed initially.

   .. note::

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

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
      * :oe:func:`OEDepict::OEAddSVGClickEvent` function
      * :oe:func:`OEDepict::OEAddSVGHover` function

   **Example:**

   .. oe:source:: AddSVGToggle.cpp
      :language: c++
      :frag:     SNIPPET-ADD-SVG-TOGGLE

   .. oe:source:: AddSVGToggle.py
      :language: python
      :frag:     SNIPPET-ADD-SVG-TOGGLE

   .. oe:source:: AddSVGToggle.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADD-SVG-TOGGLE

   .. oe:source:: AddSVGToggle.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADD-SVG-TOGGLE

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

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

      .. oe:language:: python

         .. admonition:: Download code

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

      .. oe:language:: java

         .. admonition:: Download code

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

      .. oe:language:: csharp

         .. admonition:: Download code

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

   .. hint::

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

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>click on the red rectangle below</b>
      </p>

      <p align="center">
      <object data="../../_images/AddSVGToggle.svg" type="image/svg+xml"  width = "300" ></object>
      <p>

      <p align="center">
      <b>Example of using the OEAddSVGToggle function</b>
      <p>

   .. image:: ../../depicttk/images/AddSVGToggle.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|
