.. oe:namespace:: OEDepict



.. meta::
   :keywords: OEDisplayBondPropBase, DisplayBondPropBase


.. _OEDepict_OEDisplayBondPropBase:

.. oe:class:: OEDisplayBondPropBase

   .. oe:api::

      OESystem::OEUnaryFunction<OEChem::OEBondBase, std::string, true, true>
      class OEDisplayBondPropBase

   :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>` is an abstract class that
   defines the API used for setting bond property labels.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method
      * :oe:src:`Listing 8<SNIPPET-BOND-PROP-USER-BondPropUser>` example in the
        :ref:`chapter_mol_display` chapter

   The following classes derive from this class:

   * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class
   * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class

   .. ################################################################
      # 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__(arg0: OEBondBase) -> str

      It is a virtual const method that is implemented in the concrete
      derived classes to set bond property labels.

      *bond*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object for which the display label
         is set.

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

   .. oe:method:: CreateCopy

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

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayBondPropBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.
