.. oe:namespace:: OEDepict


.. meta::
   :keywords: OEDisplayBondIdx, DisplayBondIdx


.. _OEDepict_OEDisplayBondIdx:

.. oe:class:: OEDisplayBondIdx

   .. oe:api::

      class OEDisplayBondIdx : public OEDisplayBondPropBase

   This class represents `OEDisplayBondIdx`.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method
      * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class
      * :oe:src:`Listing 7<SNIPPET-BOND-PROP-INDEX-BondPropIndex>` example in the
        :ref:`chapter_mol_display` chapter

   The following methods are publicly inherited from :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>`:

   ================================================================== ==================================================================
   :oe:meth:`CreateCopy<OEDepict::OEDisplayBondPropBase::CreateCopy>` :oe:meth:`operator()<OEDepict::OEDisplayBondPropBase::operator()>`
   ================================================================== ==================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OEDisplayBondIdx()

      .. oe:language:: python

         .. oe:api:: python

            OEDisplayBondIdx() -> OEDisplayBondIdx

      Default constructor.

   .. ################################################################
      # operator()
      ################################################################

   .. oe:method:: operator()

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

         .. oe:api::

            std::string operator()(const OEChem::OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> str

      Returns the string representation of the index of the bond 
      (*i.e.* the number returned by the :oe:meth:`OEChem::OEBondBase::GetIdx` 
      method)

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

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

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayBondPropBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>`
      object is dynamically allocated and owned by the caller.
