swissvotes.layouts.page
=======================

.. py:module:: swissvotes.layouts.page


Classes
-------

.. autoapisummary::

   swissvotes.layouts.page.Slide
   swissvotes.layouts.page.PageLayout
   swissvotes.layouts.page.AddPageLayout
   swissvotes.layouts.page.PageDetailLayout
   swissvotes.layouts.page.EditPageLayout
   swissvotes.layouts.page.DeletePageLayout
   swissvotes.layouts.page.ManagePageAttachmentsLayout
   swissvotes.layouts.page.ManagePageSliderImagesLayout
   swissvotes.layouts.page.DeletePageAttachmentLayout


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

.. py:class:: Slide

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: image
      :type:  str


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: url
      :type:  str


.. py:class:: PageLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`onegov.swissvotes.layouts.default.DefaultLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:attribute:: model
      :type:  onegov.swissvotes.models.TranslatablePage


   .. py:property:: title
      :type: str



   .. py:property:: editbar_links
      :type: list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]



   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]



   .. py:method:: get_file_url(file: onegov.swissvotes.models.TranslatablePageFile) -> str


   .. py:property:: slides
      :type: list[Slide]



.. py:class:: AddPageLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`onegov.swissvotes.layouts.default.DefaultLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:property:: title
      :type: str



   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]



.. py:class:: PageDetailLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`onegov.swissvotes.layouts.default.DefaultLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:attribute:: model
      :type:  onegov.swissvotes.models.TranslatablePage


   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]



.. py:class:: EditPageLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`PageDetailLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:property:: title
      :type: str



.. py:class:: DeletePageLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`PageDetailLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:property:: title
      :type: str



.. py:class:: ManagePageAttachmentsLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`PageDetailLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:property:: title
      :type: str



.. py:class:: ManagePageSliderImagesLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`PageDetailLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:property:: title
      :type: str



.. py:class:: DeletePageAttachmentLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`onegov.swissvotes.layouts.default.DefaultLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:attribute:: model
      :type:  onegov.swissvotes.models.TranslatablePageFile


   .. py:property:: title
      :type: str



   .. py:property:: parent
      :type: onegov.swissvotes.models.TranslatablePage



   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]