.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHydrogenStyle

   This namespace contains constants that control how explicit and
   implicit hydrogen information is depicted.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle` method
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle` method

   The :oe:constns:`OEDepict::OEHydrogenStyle` namespace contains the
   following constants:

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

   .. oe:constant:: Default

      The default hydrogen display style is the combination of
      :oe:const:`OEDepict::OEHydrogenStyle::ImplicitHetero` and
      :oe:const:`OEDepict::OEHydrogenStyle::ExplicitAll`.
      See example in :ref:`Figure: Example of the default hydrogens depiction<figure_OEHydrogenStyle_Default>`.

      .. _figure_OEHydrogenStyle_Default:

      .. figure:: ../images/OEHydrogenStyle_Default.*
         :align:  center

         **Example of the default hydrogens depiction**


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

   .. oe:constant:: ExplicitAll

      Depicts all explicit hydrogens.
      See example in :ref:`Figure: Example of depicting all explicit hydrogens<figure_OEHydrogenStyle_ExplicitAll>`.

      .. _figure_OEHydrogenStyle_ExplicitAll:

      .. figure:: ../images/OEHydrogenStyle_ExplicitAll.*
         :align:  center

         **Example of depicting all explicit hydrogens**


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

   .. oe:constant:: ExplicitHetero

      Depicts explicit hydrogens attached to hetero atoms.
      See example in :ref:`Figure: Example of depicting explicit hydrogens attached to hetero atoms<figure_OEHydrogenStyle_ExplicitHetero>`.

      .. _figure_OEHydrogenStyle_ExplicitHetero:

      .. figure:: ../images/OEHydrogenStyle_ExplicitHetero.*
         :align:  center

         **Example of depicting explicit hydrogens attached to hetero atoms**


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

   .. oe:constant:: ExplicitTerminal

      Depicts explicit hydrogens attached to terminal atoms.
      See example in :ref:`Figure: Example of depicting explicit hydrogens attached to terminal atoms<figure_OEHydrogenStyle_ExplicitTerminal>`.

      .. _figure_OEHydrogenStyle_ExplicitTerminal:

      .. figure:: ../images/OEHydrogenStyle_ExplicitTerminal.*
         :align:  center

         **Example of depicting explicit hydrogens attached to terminal atoms**


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

   .. oe:constant:: Hidden

      No hydrogen information is displayed.
      See example in :ref:`Figure: Example of hiding all hydrogens<figure_OEHydrogenStyle_Hidden>`.

      .. _figure_OEHydrogenStyle_Hidden:

      .. figure:: ../images/OEHydrogenStyle_Hidden.*
         :align:  center

         **Example of hiding all hydrogens**


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

   .. oe:constant:: ImplicitAll

      Depicts all implicit hydrogens.
      See example in :ref:`Figure: Example of depicting all implicit hydrogens<figure_OEHydrogenStyle_ImplicitAll>`.

      .. _figure_OEHydrogenStyle_ImplicitAll:

      .. figure:: ../images/OEHydrogenStyle_ImplicitAll.*
         :align:  center

         **Example of depicting all implicit hydrogens**


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

   .. oe:constant:: ImplicitHetero

      Depicts implicit hydrogens attached to hetero atoms.
      See example in :ref:`Figure: Example of depicting implicit hydrogens attached to hetero atoms<figure_OEHydrogenStyle_ImplicitHetero>`.

      .. _figure_OEHydrogenStyle_ImplicitHetero:

      .. figure:: ../images/OEHydrogenStyle_ImplicitHetero.*
         :align:  center

         **Example of depicting implicit hydrogens attached to hetero atoms**

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

   .. oe:constant:: ImplicitTerminal

      Depicts implicit hydrogens attached to terminal atoms.
      See example in :ref:`Figure: Example of depicting implicit hydrogens attached to terminal atoms<figure_OEHydrogenStyle_ImplicitTerminal>`.

      .. _figure_OEHydrogenStyle_ImplicitTerminal:

      .. figure:: ../images/OEHydrogenStyle_ImplicitTerminal.*
         :align:  center

         **Example of depicting implicit hydrogens attached to terminal atoms**

