feriennet.layout
================

.. py:module:: feriennet.layout


Classes
-------

.. autoapisummary::

   feriennet.layout.DefaultLayout
   feriennet.layout.VacationActivityCollectionLayout
   feriennet.layout.BookingCollectionLayout
   feriennet.layout.GroupInviteLayout
   feriennet.layout.VacationActivityFormLayout
   feriennet.layout.OccasionFormLayout
   feriennet.layout.VacationActivityLayout
   feriennet.layout.PeriodCollectionLayout
   feriennet.layout.PeriodFormLayout
   feriennet.layout.MatchCollectionLayout
   feriennet.layout.BillingCollectionLayout
   feriennet.layout.OnlinePaymentsLayout
   feriennet.layout.BillingCollectionImportLayout
   feriennet.layout.BillingCollectionManualBookingLayout
   feriennet.layout.BillingCollectionPaymentWithDateLayout
   feriennet.layout.InvoiceLayout
   feriennet.layout.DonationLayout
   feriennet.layout.OccasionAttendeeLayout
   feriennet.layout.NotificationTemplateCollectionLayout
   feriennet.layout.NotificationTemplateLayout
   feriennet.layout.VolunteerLayout
   feriennet.layout.VolunteerFormLayout
   feriennet.layout.HomepageLayout


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

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

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


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


   .. py:attribute:: app
      :type:  onegov.feriennet.app.FeriennetApp

      Returns the application behind the request. 



   .. py:attribute:: request
      :type:  onegov.feriennet.request.FeriennetRequest


   .. py:property:: is_owner
      :type: bool



   .. py:property:: is_editable
      :type: bool



   .. py:method:: offer_again_link(activity: onegov.feriennet.models.VacationActivity, title: str) -> onegov.core.elements.Link


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


   .. py:method:: paragraphify(text: str) -> markupsafe.Markup


.. py:class:: VacationActivityCollectionLayout(model: onegov.feriennet.collections.VacationActivityCollection, request: onegov.feriennet.request.FeriennetRequest)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.feriennet.collections.VacationActivityCollection


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


      Returns the breadcrumbs for the current page. 



   .. py:property:: organiser_links
      :type: collections.abc.Iterator[onegov.core.elements.Link | onegov.core.elements.LinkGroup]



   .. py:property:: offer_again_links
      :type: onegov.core.elements.LinkGroup | None



   .. 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:: BookingCollectionLayout(model: onegov.activity.BookingCollection, request: onegov.feriennet.request.FeriennetRequest, user: onegov.user.User | None = None)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.activity.BookingCollection


   .. py:attribute:: user
      :value: None



   .. py:method:: rega_link(attendee: onegov.activity.models.Attendee | None, period: onegov.activity.models.Period | None, grouped_bookings: dict[onegov.activity.models.Attendee, dict[str, list[onegov.activity.models.Booking]]]) -> str | None


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



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


      Returns the breadcrumbs for the current page. 



.. py:class:: GroupInviteLayout(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:: VacationActivityFormLayout(model: onegov.feriennet.models.VacationActivity | onegov.feriennet.collections.VacationActivityCollection, request: onegov.feriennet.request.FeriennetRequest, title: str)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.feriennet.models.VacationActivity | onegov.feriennet.collections.VacationActivityCollection


   .. py:attribute:: title


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


      Returns the breadcrumbs for the current page. 



   .. py:property:: editbar_links
      :type: 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:: OccasionFormLayout(model: onegov.activity.Activity, request: onegov.feriennet.request.FeriennetRequest, title: str)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.activity.Activity


   .. py:attribute:: title


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


      Returns the breadcrumbs for the current page. 



   .. py:property:: editbar_links
      :type: 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:: VacationActivityLayout(model: onegov.feriennet.models.VacationActivity, request: onegov.feriennet.request.FeriennetRequest)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.feriennet.models.VacationActivity


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


      Returns the breadcrumbs for the current page. 



   .. py:property:: latest_request
      :type: onegov.activity.models.PublicationRequest | None



   .. py:property:: ticket
      :type: onegov.ticket.Ticket | None



   .. py:property:: attendees
      :type: onegov.feriennet.collections.OccasionAttendeeCollection | None



   .. 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:: PeriodCollectionLayout(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:: PeriodFormLayout(model: onegov.activity.models.Period | onegov.activity.PeriodCollection, request: onegov.feriennet.request.FeriennetRequest, title: str)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.activity.models.Period | onegov.activity.PeriodCollection


   .. py:attribute:: title


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


      Returns the breadcrumbs for the current page. 



   .. py:property:: editbar_links
      :type: 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:: MatchCollectionLayout(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:: BillingCollectionLayout(model: onegov.feriennet.collections.BillingCollection, request: onegov.feriennet.request.FeriennetRequest)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.feriennet.collections.BillingCollection


   .. py:class:: FamilyRow

      Bases: :py:obj:`NamedTuple`


      .. py:attribute:: text
         :type:  str


      .. py:attribute:: item
         :type:  str


      .. py:attribute:: count
         :type:  int


      .. py:attribute:: has_online_payments
         :type:  bool



   .. py:property:: families
      :type: collections.abc.Iterator[FamilyRow]



   .. py:property:: family_removal_links
      :type: collections.abc.Iterator[onegov.core.elements.Link]



   .. 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:: OnlinePaymentsLayout(model: Any, request: onegov.feriennet.request.FeriennetRequest, title: str)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: title


   .. 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:: BillingCollectionImportLayout(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:: BillingCollectionManualBookingLayout(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:: BillingCollectionPaymentWithDateLayout(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:: InvoiceLayout(model: Any, request: onegov.feriennet.request.FeriennetRequest, title: str)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: title


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


      Returns the breadcrumbs for the current page. 



.. py:class:: DonationLayout(model: onegov.activity.collections.InvoiceCollection, request: onegov.feriennet.request.FeriennetRequest, title: str)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: title


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


      Returns the breadcrumbs for the current page. 



.. py:class:: OccasionAttendeeLayout(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:: NotificationTemplateCollectionLayout(model: onegov.feriennet.collections.NotificationTemplateCollection, request: onegov.feriennet.request.FeriennetRequest, subtitle: str | None = None)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.feriennet.collections.NotificationTemplateCollection


   .. py:attribute:: subtitle
      :value: None



   .. 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:: NotificationTemplateLayout(model: onegov.feriennet.models.NotificationTemplate, request: onegov.feriennet.request.FeriennetRequest, subtitle: str | None = None)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.feriennet.models.NotificationTemplate


   .. py:attribute:: subtitle
      :value: None



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


      Returns the breadcrumbs for the current page. 



.. py:class:: VolunteerLayout(model: onegov.activity.collections.VolunteerCollection, request: onegov.feriennet.request.FeriennetRequest)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.activity.collections.VolunteerCollection


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


      Returns the breadcrumbs for the current page. 



.. py:class:: VolunteerFormLayout(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:: HomepageLayout(model: onegov.org.models.Organisation, request: onegov.feriennet.request.FeriennetRequest)

   Bases: :py:obj:`DefaultLayout`


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


   .. py:attribute:: model
      :type:  onegov.org.models.Organisation


   .. 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.