.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHighlightSetup

   This namespace encodes symbolic constants used as bit-masks to 
   indicate which highlighting interface parameters are being 
   created when invoking the  
   :oe:func:`OEDepict::OEConfigureHighlightParams` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEHighlightParamName` namespace

   The :oe:constns:`OEDepict::OEHighlightSetup` namespace contains the
   following constants:

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

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OEHighlightSetup::Color`
      * :oe:const:`OEDepict::OEHighlightSetup::Style`


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

   .. oe:constant:: Color

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureHighlightParams` function result
      in generating the following default interface to configure
      the color of the highlighting by invoking
      the :oe:func:`OEDepict::OEConfigureHighlightColor` function.

      ::

         Contents of parameter -highlightcolor
             Aliases : -hcolor
             Type : string
             Allow list : false
             Default : red
             Simple : true
             Required : false
             Legal values : black blue bluetint brass brown copper cyan darkblue 
               darkbrown darkcyan darkgreen darkgrey darkmagenta darkorange 
               darkpurple darkred darkrose darksalmon darkyellow gold green 
               greenblue greentint grey hotpink lightblue lightbrown lightgreen 
               lightgrey lightorange lightpurple lightsalmon limegreen magenta 
               mediumblue mediumbrown mediumgreen mediumorange mediumpurple 
               mediumsalmon mediumyellow olivebrown olivegreen olivegrey pewter 
               orange pink pinktint purple red redorange royalblue seagreen silver 
               skyblue violet white yellow yellowtint

      .. seealso::

         * :oe:const:`OEDepict::OEHighlightParamName::Color` constant
         * :oe:func:`OEDepict::OEConfigureHighlightColor` function
         * :oe:func:`OEDepict::OEGetHighlightColor` function


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

   .. oe:constant:: Style

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureHighlightParams` function result 
      in generating the following default interface to configure 
      the style of the highlighting by invoking 
      the :oe:func:`OEDepict::OEConfigureHighlightStyle` function.

      ::

         Contents of parameter -highlightstyle
             Aliases : -hstyle
             Type : string
             Allow list : false
             Default : Color
             Simple : true
             Required : false
             Legal values : Color Stick BallAndStick Cogwheel Lasso
             Brief : Highlighting style

      .. seealso::

         * :oe:const:`OEDepict::OEHighlightParamName::Style` constant
         * :oe:func:`OEDepict::OEConfigureHighlightStyle` function
         * :oe:func:`OEDepict::OEGetHighlightStyle` function

