src/pyams_content/features/header/interfaces.py
changeset 1059 34e6d07ea2e9
parent 956 a8723fffbaf6
child 1115 6ca2680774ee
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/pyams_content/features/header/interfaces.py	Tue Nov 06 14:40:22 2018 +0100
@@ -0,0 +1,61 @@
+#
+# Copyright (c) 2008-2018 Thierry Florac <tflorac AT ulthar.net>
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+
+__docformat__ = 'restructuredtext'
+
+
+# import standard library
+
+# import interfaces
+from pyams_content.features.renderer import IContentRenderer, IRendererSettings, IRenderedContent
+from pyams_utils.interfaces.inherit import IInheritInfo
+from zope.annotation.interfaces import IAttributeAnnotatable
+
+# import packages
+from zope.interface import Attribute
+from zope.schema import Choice
+
+from pyams_content import _
+
+
+HEADER_SETTINGS_KEY = 'pyams_content.header'
+HEADER_RENDERER_SETTINGS_KEY = 'pyams_content.header::{0}'
+
+HEADER_RENDERERS = 'PyAMS.header.renderers'
+
+
+class IHeaderSettings(IInheritInfo, IRenderedContent):
+    """Header settings interface"""
+
+    renderer = Choice(title=_("Header template"),
+                      description=_("Presentation template used for this header"),
+                      vocabulary=HEADER_RENDERERS,
+                      required=False,
+                      default='hidden')
+
+    settings = Attribute("Renderer settings")
+
+
+class IHeaderTarget(IAttributeAnnotatable):
+    """Header target marker interface"""
+
+
+class IHeaderRenderer(IContentRenderer):
+    """Header renderer interface"""
+
+    name = Attribute("Renderer name")
+    settings_key = Attribute("Renderer settings key")
+    cache_key = Attribute("Renderer cache key")
+
+
+class IHeaderRendererSettings(IRendererSettings):
+    """Header renderer settings interface"""