translator_directory.layout
===========================

.. py:module:: translator_directory.layout


Classes
-------

.. autoapisummary::

   translator_directory.layout.DefaultLayout
   translator_directory.layout.TranslatorLayout
   translator_directory.layout.EditTranslatorLayout
   translator_directory.layout.ReportTranslatorChangesLayout
   translator_directory.layout.ApplyTranslatorChangesLayout
   translator_directory.layout.MailTemplatesLayout
   translator_directory.layout.TranslatorCollectionLayout
   translator_directory.layout.AddTranslatorLayout
   translator_directory.layout.TranslatorDocumentsLayout
   translator_directory.layout.LanguageCollectionLayout
   translator_directory.layout.LanguageLayout
   translator_directory.layout.EditLanguageLayout
   translator_directory.layout.AddLanguageLayout
   translator_directory.layout.AccreditationLayout
   translator_directory.layout.RequestAccreditationLayout
   translator_directory.layout.GrantAccreditationLayout
   translator_directory.layout.RefuseAccreditationLayout


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

.. py:class:: DefaultLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.town6.layout.DefaultLayout`


   The default layout meant for the public facing parts of the site. 


   .. py:attribute:: request
      :type:  onegov.translator_directory.request.TranslatorAppRequest


   .. py:method:: linkify(text: str | None) -> markupsafe.Markup
      :staticmethod:



   .. py:method:: format_languages(languages: collections.abc.Iterable[onegov.translator_directory.models.language.Language] | None) -> str
      :staticmethod:



   .. py:method:: format_gender(gender: onegov.translator_directory.models.translator.Gender) -> str


   .. py:method:: format_drive_distance(number: float | None) -> str
      :staticmethod:



   .. py:method:: format_boolean(val: bool | None) -> str


   .. py:method:: format_admission(val: onegov.translator_directory.models.translator.AdmissionState) -> str


   .. py:method:: show(attribute_name: str) -> bool

      Some attributes on the translator are hidden for less privileged
      users



   .. py:method:: color_class(count: int) -> str | None

      Depending how rare a language is offered by translators,
      apply a color code using the returned css class



   .. py:method:: format_prof_guild(key: str) -> str


   .. py:method:: format_interpreting_type(key: str) -> str


.. py:class:: TranslatorLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


   .. py:attribute:: model
      :type:  onegov.translator_directory.models.translator.Translator


   .. py:method:: translator_data_outdated() -> bool


   .. py:property:: file_collection
      :type: onegov.translator_directory.collections.documents.TranslatorDocumentCollection



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



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


      Returns the breadcrumbs for the current page. 



.. py:class:: EditTranslatorLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`TranslatorLayout`


   The default layout meant for the public facing parts of the site. 


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



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



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


      Returns the breadcrumbs for the current page. 



.. py:class:: ReportTranslatorChangesLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`TranslatorLayout`


   The default layout meant for the public facing parts of the site. 


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



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



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


      Returns the breadcrumbs for the current page. 



.. py:class:: ApplyTranslatorChangesLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`TranslatorLayout`


   The default layout meant for the public facing parts of the site. 


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



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



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


      Returns the breadcrumbs for the current page. 



.. py:class:: MailTemplatesLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`TranslatorLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



.. py:class:: TranslatorCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


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



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


      Returns the breadcrumbs for the current page. 



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



.. py:class:: AddTranslatorLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`TranslatorCollectionLayout`


   The default layout meant for the public facing parts of the site. 


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



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


      Returns the breadcrumbs for the current page. 



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



.. py:class:: TranslatorDocumentsLayout(model: Any, request: onegov.translator_directory.request.TranslatorAppRequest)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



   .. py:property:: upload_url
      :type: str



   .. py:method:: link_for(category: str) -> str


.. py:class:: LanguageCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



.. py:class:: LanguageLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



.. py:class:: EditLanguageLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`LanguageLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



.. py:class:: AddLanguageLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`LanguageLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



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


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



.. py:class:: AccreditationLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



.. py:class:: RequestAccreditationLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



.. py:class:: GrantAccreditationLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page. 



.. py:class:: RefuseAccreditationLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`DefaultLayout`


   The default layout meant for the public facing parts of the site. 


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


      Returns the breadcrumbs for the current page.