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

.. oe:namespace:: OEDepict

.. _OEDepict_OEDrawSVGToggleText:


.. oe:function:: OEDrawSVGToggleText


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

      .. oe:api::

         bool OEDrawSVGToggleText(OE2DMolDisplay& disp, OE2DAtomDisplay* adisp,
                                  const std::string& text, const OEFont& font)
         bool OEDrawSVGToggleText(OE2DMolDisplay& disp, OE2DBondDisplay* bdisp,
                                  const std::string& text, const OEFont& font)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSVGToggleText(arg1: OE2DMolDisplay, arg2: OE2DAtomDisplay,
                             text: str, font: OEFont) -> bool
         OEDrawSVGToggleText(arg1: OE2DMolDisplay, arg2: OE2DBondDisplay,
                             text: str, font: OEFont) -> bool

   Creates and interactive effect in :file:`.svg` images.
   The given text will appear / disappear when clicking
   at the position defined by the given atom / bond display.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format. In other image formats it has no effects.

      The generated :file:`svg` image should be included into and
      HTML page with the SVG MIME type.

      .. code-block:: console

         <object data="<imagename>.svg" type="image/svg+xml"></object>

   .. seealso::

      * :ref:`chapter_svg` chapter

   *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 where the
      text will appear.

   *bdisp*
      The :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object that defines where the
      text will appear.

   *text*
      The text that appears/disappears on mouse clicks.

   *font*
      The graphical properties of the font used to draw the text.

   .. oe:source:: ToggleAtomText.cpp
      :language: c++
      :frag:     SNIPPET-TOGGLEATOMTEXT

   .. oe:source:: ToggleAtomText.py
      :language: python
      :frag:     SNIPPET-TOGGLEATOMTEXT

   .. oe:source:: ToggleAtomText.java
      :language: java
      :noindent:
      :frag:     SNIPPET-TOGGLEATOMTEXT

   .. oe:source:: ToggleAtomText.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-TOGGLEATOMTEXT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

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

      .. oe:language:: python

         .. admonition:: Download code

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

      .. oe:language:: java

         .. admonition:: Download code

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

      .. oe:language:: csharp

         .. admonition:: Download code

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


   .. _figure_OEDrawSVGToggleText_Atom:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on any atoms</b>
         </p>

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

         <p align="center">
         <b>Example of using the OEDrawSVGToggleText function for atom positions</b>
         <p>

      .. the below is necessary to copy over the image to the build subdirectory

      .. image:: ../images/ToggleAtomText.svg
         :width: 1pt


   .. only:: oepdf

      |NOPDFIMAGE|


   .. oe:source:: ToggleBondText.cpp
      :language: c++
      :frag:     SNIPPET-TOGGLEBONDTEXT

   .. oe:source:: ToggleBondText.py
      :language: python
      :frag:     SNIPPET-TOGGLEBONDTEXT

   .. oe:source:: ToggleBondText.java
      :language: java
      :noindent:
      :frag:     SNIPPET-TOGGLEBONDTEXT

   .. oe:source:: ToggleBondText.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-TOGGLEBONDTEXT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

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

      .. oe:language:: python

         .. admonition:: Download code

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

      .. oe:language:: java

         .. admonition:: Download code

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

      .. oe:language:: csharp

         .. admonition:: Download code

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


   .. _figure_OEDrawSVGToggleText_Bond:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on the middle of any bonds</b>
         </p>

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

         <p align="center">
         <b>Example of using the OEDrawSVGToggleText function for bond positions</b>
         <p>

      .. the below is necessary to copy over the image to the build subdirectory

      .. image:: ../images/ToggleBondText.svg
         :width: 1pt


   .. only:: oepdf

      |NOPDFIMAGE|

   .. seealso::

      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
      * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` and :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` classes
      * :ref:`OEFont <OEDepict_OEFont>` class
      * :oe:func:`OEDepict::OEDrawSVGHoverText` function
