.. include:: ../../toolkit-substitutions
.. include:: ../substitutions

.. oe:namespace:: OEDepict


.. _OEDepict_OESVGClass:

.. oe:class:: OESVGClass

   .. oe:api::

      class OESVGClass

   SVG `class <https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/class>`_
   is a name that can be assigned with SVG elements.

   .. seealso::

      * :oe:func:`OEDepict::OEIsValidSVGClassName` function
      * :ref:`chapter_svg` chapter
      * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class


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

   .. oe:method:: Constructors

      .. oe:api: DO NO DOCUMENT / SHOULD NOT BE CALLED DIRECTLY

         OESVGClass(const OEImageBase *parent, const std::string &name)

      To create an :ref:`OESVGClass <OEDepict_OESVGClass>` object on an image
      use the :oe:meth:`OEDepict::OEImageBase::NewSVGClass` method.


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

   .. oe:method:: GetName

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

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the :ref:`OESVGClass <OEDepict_OESVGClass>` object.
