.. oe:namespace:: OEDepict



.. meta::
   :keywords: OEDisplayAtomPropBase, DisplayAtomPropBase


.. _OEDepict_OEDisplayAtomPropBase:

.. oe:class:: OEDisplayAtomPropBase

   .. oe:api::

      OESystem::OEUnaryFunction<OEChem::OEAtomBase, std::string, true, true>
      OEDisplayAtomPropBase

   :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>` is an abstract class that
   defines the API used for setting atom property labels.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
      * :oe:src:`Listing 6<SNIPPET-ATOM-PROP-USER-AtomPropUser>` example in the
        :ref:`chapter_mol_display` chapter

   The following classes derive from this class:

   * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
   * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
   * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class

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

   .. oe:method:: operator()

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

         .. oe:api::

            std::string operator () (const OEChem::OEAtomBase& atom) const
 
      .. oe:language:: python

         .. oe:api:: python

            __call__(arg0: OEAtomBase) -> str

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

      *atom*
         The :ref:`OEAtomBase <OEChem_OEAtomBase>` 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() -> OEDisplayAtomPropBase

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