swissvotes.layouts.vote
=======================

.. py:module:: swissvotes.layouts.vote


Classes
-------

.. autoapisummary::

   swissvotes.layouts.vote.VoteLayout
   swissvotes.layouts.vote.VoteDetailLayout
   swissvotes.layouts.vote.VoteStrengthsLayout
   swissvotes.layouts.vote.VoteCampaignMaterialLayout
   swissvotes.layouts.vote.UploadVoteAttachemtsLayout
   swissvotes.layouts.vote.ManageCampaingMaterialLayout
   swissvotes.layouts.vote.ManageCampaingMaterialYeaLayout
   swissvotes.layouts.vote.ManageCampaingMaterialNayLayout
   swissvotes.layouts.vote.DeleteVoteLayout
   swissvotes.layouts.vote.DeleteVoteAttachmentLayout


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

.. py:class:: VoteLayout(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.SwissVote


   .. 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:property:: attachments
      :type: onegov.core.types.RenderData


      Returns a dictionary with static URLS and locale for attachments.

      Note that only file / locale combinations with a file_name
      definition have a static URL!



   .. py:property:: search_results
      :type: list[tuple[int, str, str, bool, onegov.swissvotes.models.SwissVoteFile]]



.. py:class:: VoteDetailLayout(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.SwissVote


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



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

   Bases: :py:obj:`VoteDetailLayout`


   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:: VoteCampaignMaterialLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`VoteDetailLayout`


   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:: date_month_format
      :value: 'MM.yyyy'



   .. py:attribute:: date_year_format
      :value: 'yyyy'



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



   .. py:property:: codes
      :type: dict[str, dict[str, str]]



   .. py:method:: format_code(metadata: dict[str, Any] | None, key: str) -> str


   .. py:method:: format_partial_date(metadata: dict[str, Any] | None) -> str


   .. py:method:: format_sortable_date(metadata: dict[str, Any] | None) -> str


   .. py:method:: metadata(filename: str | None) -> dict[str, Any]


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

   Bases: :py:obj:`VoteDetailLayout`


   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:: ManageCampaingMaterialLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`VoteDetailLayout`


   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:: ManageCampaingMaterialYeaLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`VoteDetailLayout`


   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:: ManageCampaingMaterialNayLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`VoteDetailLayout`


   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:: DeleteVoteLayout(model: Any, request: onegov.swissvotes.request.SwissvotesRequest)

   Bases: :py:obj:`VoteDetailLayout`


   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:: DeleteVoteAttachmentLayout(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.SwissVoteFile


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



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



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