.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEBondStereoStyle

   This namespace encodes symbolic constants used as bit-masks to
   indicate what bond stereo information is displayed.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle`

   The :oe:constns:`OEDepict::OEBondStereoStyle` namespace contains the
   following constants and nested namespaces:

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

   .. oe:constant:: Default

      The default bond stereo  style is
      :oe:const:`OEDepict::OEBondStereoStyle::Display::Default`.
      See example in :ref:`Figure: Example of using the 'Default'
      bond stereo style<figure_OEBondStereoStyle_Default>`.

      .. _figure_OEBondStereoStyle_Default:

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

         **Example of using the 'Default' bond stereo style**


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

   .. oe:constant:: Hidden

      Displays no bond stereo information.
      See example in :ref:`Figure: Example of using the 'Hidden'
      bond stereo style<figure_OEAtomStereoStyle_Hidden>`.

      .. _figure_OEBondStereoStyle_Hidden:

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

         **Example of using the 'Hidden' bond stereo style**


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

   .. oe:constant: DisplayMask # IGNORE


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

   .. oe:constnamespace:: OEBondStereoStyle::Display

      This nested namespace encodes symbolic constants used as bit-masks to
      indicate what bond stereo information is displayed.


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

      .. oe:constant:: Default

         The default bond stereo display style is
         :oe:const:`OEDepict::OEBondStereoStyle::Display::BondStereo`.

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

      .. oe:constant:: BondStereo

         See example in :ref:`Table: Example of using the 'BondStereo'
         display style<table_OEBondStereoStyle_Display_BondStereo>`.

         .. _table_OEBondStereoStyle_Display_BondStereo:

         .. list-table::  **Example of using the 'BondStereo' display style**
            :widths: 100 100 100 100
            :header-rows: 1

            * -  cis
              -  trans
              -  undefined 
              -  over-defined
            * -  `C\\C(Br)=C(/C)Br`
              -  `C\\C(Br)=C(\\C)Br`
              -  `CC(Br)=C(C)Br`
              -  `Br\\C(Br)=C(\\Br)Br`
            * - .. image:: ../images/OEBondStereoStyle_Display_BondStereo_Cis.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_BondStereo_Trans.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_BondStereo_Undef.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_BondStereo_Overdef.*
                  :scale:  100
                  :align:  center


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

      .. oe:constant:: CIPBondStereo

         Displays the CIP bond stereo information next to the
         corresponding bond.
         See example in :ref:`Table: Example of using the 'CIPBondStereo'
         display style<table_OEBondStereoStyle_Display_CIPBondStereo>`.

         .. _table_OEBondStereoStyle_Display_CIPBondStereo:

         .. list-table::  **Example of using the 'CIPBondStereo' display style**
            :widths: 100 100 100 100
            :header-rows: 1

            * -  cis
              -  trans
              -  undefined 
              -  over-defined
            * -  `C\\C(Br)=C(/C)Br`
              -  `C\\C(Br)=C(\\C)Br`
              -  `CC(Br)=C(C)Br`
              -  `Br\\C(Br)=C(\\Br)Br`
            * - .. image:: ../images/OEBondStereoStyle_Display_CIPBondStereo_Cis.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_CIPBondStereo_Trans.*
                  :scale:  100
                  :align:  center    

              - .. image:: ../images/OEBondStereoStyle_Display_CIPBondStereo_Undef.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_CIPBondStereo_Overdef.*
                  :scale:  100
                  :align:  center


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

      .. oe:constant:: All

         The combination of the following flags:

         * :oe:const:`OEDepict::OEBondStereoStyle::Display::CIPBondStereo`
         * :oe:const:`OEDepict::OEBondStereoStyle::Display::BondStereo`

         See example in :ref:`Table: Example of using the 'All'
         display style<figure_OEBondStereoStyle_Display_All>`.

         .. _figure_OEBondStereoStyle_Display_All:

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

            **Example of using the 'All' display style**

