town6.layout ============ .. py:module:: town6.layout Attributes ---------- .. autoapisummary:: town6.layout.NavigationEntry town6.layout.T Classes ------- .. autoapisummary:: town6.layout.PartnerCard town6.layout.Layout town6.layout.DefaultLayout town6.layout.DefaultMailLayout town6.layout.AdjacencyListLayout town6.layout.SettingsLayout town6.layout.PageLayout town6.layout.NewsLayout town6.layout.EditorLayout town6.layout.FormEditorLayout town6.layout.FormSubmissionLayout town6.layout.SurveySubmissionLayout town6.layout.FormDocumentLayout town6.layout.FormCollectionLayout town6.layout.SurveySubmissionWindowLayout town6.layout.SurveyCollectionLayout town6.layout.PersonCollectionLayout town6.layout.PersonLayout town6.layout.TicketsLayout town6.layout.ArchivedTicketsLayout town6.layout.TicketLayout town6.layout.TicketNoteLayout town6.layout.TicketChatMessageLayout town6.layout.TextModulesLayout town6.layout.TextModuleLayout town6.layout.ResourcesLayout town6.layout.FindYourSpotLayout town6.layout.ResourceRecipientsLayout town6.layout.ResourceRecipientsFormLayout town6.layout.ResourceLayout town6.layout.ReservationLayout town6.layout.AllocationRulesLayout town6.layout.AllocationEditFormLayout town6.layout.OccurrencesLayout town6.layout.OccurrenceLayout town6.layout.EventLayout town6.layout.NewsletterLayout town6.layout.RecipientLayout town6.layout.ImageSetCollectionLayout town6.layout.ImageSetLayout town6.layout.UserManagementLayout town6.layout.UserLayout town6.layout.UserGroupCollectionLayout town6.layout.UserGroupLayout town6.layout.ExportCollectionLayout town6.layout.PaymentProviderLayout town6.layout.PaymentCollectionLayout town6.layout.MessageCollectionLayout town6.layout.DirectoryCollectionLayout town6.layout.DirectoryEntryCollectionLayout town6.layout.DirectoryEntryLayout town6.layout.PublicationLayout town6.layout.DashboardLayout town6.layout.GeneralFileCollectionLayout town6.layout.ImageFileCollectionLayout town6.layout.ExternalLinkLayout town6.layout.HomepageLayout town6.layout.ChatLayout town6.layout.StaffChatLayout town6.layout.ClientChatLayout town6.layout.ChatInitiationFormLayout town6.layout.ArchivedChatsLayout Module Contents --------------- .. py:type:: NavigationEntry :canonical: tuple[PageMeta, Link, tuple['NavigationEntry', ...]] .. py:data:: T .. py:class:: PartnerCard Bases: :py:obj:`NamedTuple` .. py:attribute:: url :type: str | None .. py:attribute:: image_url :type: str | None .. py:attribute:: lead :type: str | None .. py:class:: Layout(model: Any, request: onegov.town6.request.TownRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.Layout` Contains methods to render a page inheriting from layout.pt. All pages inheriting from layout.pt rely on this class being present as 'layout' variable:: @OrgApp.html(model=Example, template='example.pt', permission=Public) def view_example(self, request): return { 'layout': DefaultLayout(self, request) } It is meant to be extended for different parts of the site. For example, the :class:`DefaultLayout` includes the top navigation defined by onegov.page. It's possible though to have a different part of the website use a completely different top navigation. For that, a new Layout class inheriting from this one should be added. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:attribute:: edit_mode :value: False .. py:property:: primary_color :type: str .. py:property:: font_awesome_path :type: str .. py:property:: sentry_init_path :type: str .. py:property:: drilldown_back :type: str .. py:property:: on_homepage :type: bool .. py:property:: partners :type: list[PartnerCard] .. py:property:: show_partners :type: bool .. py:property:: search_keybindings_help :type: str .. py:property:: page_collection :type: onegov.page.PageCollection .. py:method:: page_by_path(path: str) -> onegov.page.Page | None .. py:class:: DefaultLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.DefaultLayout`, :py:obj:`Layout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:property:: top_navigation :type: tuple[NavigationEntry, Ellipsis] Returns a list of :class:`onegov.org.elements.Link` objects. Those links are used for the top navigation. If nothing is returned, no top navigation is displayed. .. py:property:: sortable_url_template :type: str .. py:class:: DefaultMailLayout(model: Any, request: onegov.core.request.CoreRequest) Bases: :py:obj:`onegov.org.layout.DefaultMailLayout`, :py:obj:`Layout` A special layout for creating HTML E-Mails. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: AdjacencyListLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.AdjacencyListLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: SettingsLayout(model: Any, request: onegov.org.request.OrgRequest, setting: str | None = None) Bases: :py:obj:`onegov.org.layout.SettingsLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: PageLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.PageLayout`, :py:obj:`AdjacencyListLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:property:: contact_html :type: str .. py:class:: NewsLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.NewsLayout`, :py:obj:`AdjacencyListLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:property:: contact_html :type: str .. py:class:: EditorLayout(model: onegov.org.models.Editor, request: onegov.org.request.OrgRequest, site_title: str | None) Bases: :py:obj:`onegov.org.layout.EditorLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: FormEditorLayout(model: AnyFormDefinitionOrCollection, request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.FormEditorLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: FormSubmissionLayout(model: onegov.form.FormSubmission | onegov.form.FormDefinition, request: onegov.town6.request.TownRequest, title: str | None = None, *, hide_steps: bool = False) Bases: :py:obj:`onegov.stepsequence.extension.StepsLayoutExtension`, :py:obj:`onegov.org.layout.FormSubmissionLayout`, :py:obj:`DefaultLayout` For steps registered on layouts. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:attribute:: model :type: onegov.form.FormSubmission | onegov.form.FormDefinition .. py:property:: step_position :type: int | None Can be overwritten by the model and based request params. .. py:class:: SurveySubmissionLayout(model: onegov.form.models.submission.SurveySubmission | onegov.form.models.definition.SurveyDefinition, request: onegov.town6.request.TownRequest, title: str | None = None, *, hide_steps: bool = False) Bases: :py:obj:`onegov.stepsequence.extension.StepsLayoutExtension`, :py:obj:`onegov.org.layout.SurveySubmissionLayout`, :py:obj:`DefaultLayout` For steps registered on layouts. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:attribute:: model :type: onegov.form.models.submission.SurveySubmission | onegov.form.models.definition.SurveyDefinition .. py:property:: step_position :type: int | None Can be overwritten by the model and based request params. .. py:class:: FormDocumentLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.FormDocumentLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: FormCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.FormCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:property:: forms_url :type: str .. py:class:: SurveySubmissionWindowLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.SurveySubmissionWindowLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: SurveyCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.SurveyCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: PersonCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.PersonCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: PersonLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.PersonLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: TicketsLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.TicketsLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ArchivedTicketsLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.ArchivedTicketsLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: TicketLayout(model: onegov.ticket.Ticket, request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.TicketLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. 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:: TicketNoteLayout(model: onegov.ticket.Ticket, request: onegov.org.request.OrgRequest, title: str, ticket: None = None) TicketNoteLayout(model: Any, request: onegov.org.request.OrgRequest, title: str, ticket: onegov.ticket.Ticket) Bases: :py:obj:`onegov.org.layout.TicketNoteLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: TicketChatMessageLayout(model: onegov.ticket.Ticket, request: onegov.town6.request.TownRequest, internal: bool = False, *, hide_steps: bool = False) Bases: :py:obj:`onegov.stepsequence.extension.StepsLayoutExtension`, :py:obj:`onegov.org.layout.TicketChatMessageLayout`, :py:obj:`DefaultLayout` For steps registered on layouts. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:property:: step_position :type: int Can be overwritten by the model and based request params. .. py:class:: TextModulesLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.TextModulesLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: TextModuleLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.TextModuleLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ResourcesLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.ResourcesLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: FindYourSpotLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.FindYourSpotLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ResourceRecipientsLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.ResourceRecipientsLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ResourceRecipientsFormLayout(model: Any, request: onegov.org.request.OrgRequest, title: str) Bases: :py:obj:`onegov.org.layout.ResourceRecipientsFormLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ResourceLayout(model: onegov.reservation.Resource, request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.ResourceLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ReservationLayout(model: onegov.reservation.Resource, request: onegov.town6.request.TownRequest, *, hide_steps: bool = False) Bases: :py:obj:`onegov.stepsequence.extension.StepsLayoutExtension`, :py:obj:`onegov.org.layout.ReservationLayout`, :py:obj:`ResourceLayout` For steps registered on layouts. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:attribute:: editbar_links :value: 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:: step_position :type: int | None Note the last step is the ticket status page with step 3. .. py:class:: AllocationRulesLayout(model: onegov.reservation.Resource, request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.AllocationRulesLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: AllocationEditFormLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.AllocationEditFormLayout`, :py:obj:`DefaultLayout` Same as the resource layout, but with different editbar links, because there's not really an allocation view, but there are allocation forms. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: OccurrencesLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.OccurrencesLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. 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:: OccurrenceLayout(model: onegov.event.Occurrence, request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.OccurrenceLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: EventLayout(model: onegov.event.Event, request: onegov.town6.request.TownRequest, *, hide_steps: bool = False) Bases: :py:obj:`onegov.stepsequence.extension.StepsLayoutExtension`, :py:obj:`onegov.org.layout.EventLayout`, :py:obj:`DefaultLayout` For steps registered on layouts. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:attribute:: model :type: onegov.event.Event .. py:property:: step_position :type: int Can be overwritten by the model and based request params. .. py:class:: NewsletterLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.NewsletterLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: RecipientLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.RecipientLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ImageSetCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.ImageSetCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ImageSetLayout(model: onegov.org.models.ImageSet, request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.ImageSetLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: UserManagementLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.UserManagementLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: UserLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.UserLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: UserGroupCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.UserGroupCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: UserGroupLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.UserGroupLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ExportCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.ExportCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: PaymentProviderLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.PaymentProviderLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: PaymentCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.PaymentCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: MessageCollectionLayout(model: Any, request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.MessageCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: DirectoryCollectionLayout(model: onegov.directory.DirectoryCollection[Any] | onegov.directory.DirectoryEntryCollection[Any], request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.DirectoryCollectionLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: DirectoryEntryCollectionLayout(*args: Any, hide_steps: bool = False, **kwargs: Any) Bases: :py:obj:`onegov.stepsequence.extension.StepsLayoutExtension`, :py:obj:`onegov.org.layout.DirectoryEntryCollectionLayout`, :py:obj:`DefaultLayout` For steps registered on layouts. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:property:: step_position :type: int Can be overwritten by the model and based request params. .. 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:: DirectoryEntryLayout(model: onegov.org.models.ExtendedDirectoryEntry, request: onegov.town6.request.TownRequest, *, hide_steps: bool = False) Bases: :py:obj:`onegov.stepsequence.extension.StepsLayoutExtension`, :py:obj:`onegov.org.layout.DirectoryEntryLayout`, :py:obj:`DefaultLayout` For steps registered on layouts. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:property:: step_position :type: int Can be overwritten by the model and based request params. .. py:class:: PublicationLayout(model: Any, request: onegov.org.request.OrgRequest) Bases: :py:obj:`onegov.org.layout.PublicationLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: DashboardLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.DashboardLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: GeneralFileCollectionLayout(model: Any, request: onegov.town6.request.TownRequest) Bases: :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:class:: ImageFileCollectionLayout(model: Any, request: onegov.town6.request.TownRequest) Bases: :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:class:: ExternalLinkLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.ExternalLinkLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: HomepageLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False) Bases: :py:obj:`onegov.org.layout.HomepageLayout`, :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:attribute:: app :type: onegov.town6.app.TownApp Returns the application behind the request. .. py:attribute:: request :type: onegov.town6.request.TownRequest .. py:class:: ChatLayout(model: Any, request: onegov.town6.request.TownRequest) Bases: :py:obj:`DefaultLayout` The default layout meant for the public facing parts of the site. .. py:method:: make_websocket_token() -> str A user (authenticated or anonymous) attempts to create a chat connection. For the connection to succeed, they must present a one-time token to the WebSocket server. TODO: Add lifespan to the token? .. py:class:: StaffChatLayout(model: Any, request: onegov.town6.request.TownRequest) Bases: :py:obj:`ChatLayout` 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:: ClientChatLayout(model: Any, request: onegov.town6.request.TownRequest) Bases: :py:obj:`ChatLayout` The default layout meant for the public facing parts of the site. .. py:class:: ChatInitiationFormLayout(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:class:: ArchivedChatsLayout(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.