:tocdepth: 3

:py:mod:`gws.base.template.core`
================================

.. py:module:: gws.base.template.core


**Source code:** :source:`gws.base.template.core<gws/base/template/core.py>`



Module Contents
---------------



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.ConfigWithAccess`

   Template configuration.

   .. py:attribute:: mapSize
      :type:  Optional[gws.UomSizeStr]

      Map size.

   .. py:attribute:: mimeTypes
      :type:  Optional[list[gws.MimeType]]

      Mime types this template can generate.

   .. py:attribute:: pageMargin
      :type:  Optional[gws.UomExtentStr]

      Page margin.

   .. py:attribute:: pageSize
      :type:  Optional[gws.UomSizeStr]

      Page size.

   .. py:attribute:: subject
      :type:  str
      :value: ''


      Template purpose.

   .. py:attribute:: title
      :type:  str
      :value: ''


      Template title.


.. py:data:: DEFAULT_MAP_SIZE

.. py:data:: DEFAULT_PAGE_SIZE

.. py:class:: Object


   Bases: :py:obj:`gws.Template`

   Template object.

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: notify(tri: gws.TemplateRenderInput, message: str)

   .. py:method:: prepare_args(tri: gws.TemplateRenderInput)

   .. py:method:: props(user)

      Generate a ``Props`` struct for this object.

      :param user: The user for which the props should be generated.



.. py:class:: Props(*args, **kwargs)


   Bases: :py:obj:`gws.Props`

   Object properties.

   .. py:attribute:: mapSize
      :type:  Optional[gws.Size]

   .. py:attribute:: pageSize
      :type:  Optional[gws.Size]

   .. py:attribute:: title
      :type:  str