.. oe:namespace:: OEDepict


.. oe:constnamespace:: OEReportSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which image report layout parameters are being
   created when invoking the
   :oe:func:`OEDepict::OEConfigureReportOptions` function.

   .. seealso::
   
      * :ref:`OEReport <OEDepict_OEReport>` class
      * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class


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

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OEReportSetup::NumColsPerPage`
      * :oe:const:`OEDepict::OEReportSetup::NumRowsPerPage`
      * :oe:const:`OEDepict::OEReportSetup::PageHeight`
      * :oe:const:`OEDepict::OEReportSetup::PageOrientation`
      * :oe:const:`OEDepict::OEReportSetup::PageSize`
      * :oe:const:`OEDepict::OEReportSetup::PageWidth`


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

   .. oe:constant:: NumColsPerPage

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the number of columns per page.

      ::

         Contents of parameter -colsperpage
             Aliases : -cols
             Type : int
             Allow list : false
             Default : 2
             Simple : true
             Required : false
             Legal ranges :
                 10 to 1
             Brief : Number of columns per page

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::NumColsPerPage` method


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

   .. oe:constant:: NumRowsPerPage

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the number of rows per page.

      ::

         Contents of parameter -rowsperpage
             Aliases : -rows
             Type : int
             Allow list : false
             Default : 3
             Simple : true
             Required : false
             Legal ranges :
                 10 to 1
             Brief : Number of rows per page

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::NumRowsPerPage` method


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

   .. oe:constant:: PageHeight

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the page height of the report.

      ::

         Contents of parameter -pageheight
             Aliases : -h
             Type : double
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Legal ranges :
                 2000.0 to 100.0
             Brief : Page height

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method


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

   .. oe:constant:: PageOrientation

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the page orientation of the report.

      ::

         Contents of parameter -pageorientation
             Aliases : -pori
             Type : string
             Allow list : false
             Default : Portrait
             Simple : true
             Required : false
             Legal values : Portrait Landscape
             Brief : Page orientation

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageOrientation` method
         * :oe:constns:`OEDepict::OEPageOrientation` namespace


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

   .. oe:constant:: PageSize

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the page size of the report.

      ::

         Contents of parameter -pagesize
             Aliases : -psize
             Type : string
             Allow list : false
             Default : US_Letter
             Simple : true
             Required : false
             Legal values : ISO_A4 US_Letter US_Legal Custom
             Brief : Page size

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageSize` method
         * :oe:constns:`OEDepict::OEPageSize` namespace


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

   .. oe:constant:: PageWidth

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the page width of the report.

      ::

         Contents of parameter -pagewidth
             Aliases : -w
             Type : double
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Legal ranges :
                 2000.0 to 100.0
             Brief : Page width

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method
