|
1 # |
|
2 # Copyright (c) 2008-2018 Thierry Florac <tflorac AT ulthar.net> |
|
3 # All Rights Reserved. |
|
4 # |
|
5 # This software is subject to the provisions of the Zope Public License, |
|
6 # Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. |
|
7 # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED |
|
8 # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
|
9 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS |
|
10 # FOR A PARTICULAR PURPOSE. |
|
11 # |
|
12 |
|
13 __docformat__ = 'restructuredtext' |
|
14 |
|
15 |
|
16 # import standard library |
|
17 |
|
18 # import interfaces |
|
19 from pyams_content.features.renderer import IContentRenderer, IRendererSettings, IRenderedContent |
|
20 from pyams_utils.interfaces.inherit import IInheritInfo |
|
21 from zope.annotation.interfaces import IAttributeAnnotatable |
|
22 |
|
23 # import packages |
|
24 from zope.interface import Attribute |
|
25 from zope.schema import Choice |
|
26 |
|
27 from pyams_content import _ |
|
28 |
|
29 |
|
30 HEADER_SETTINGS_KEY = 'pyams_content.header' |
|
31 HEADER_RENDERER_SETTINGS_KEY = 'pyams_content.header::{0}' |
|
32 |
|
33 HEADER_RENDERERS = 'PyAMS.header.renderers' |
|
34 |
|
35 |
|
36 class IHeaderSettings(IInheritInfo, IRenderedContent): |
|
37 """Header settings interface""" |
|
38 |
|
39 renderer = Choice(title=_("Header template"), |
|
40 description=_("Presentation template used for this header"), |
|
41 vocabulary=HEADER_RENDERERS, |
|
42 required=False, |
|
43 default='hidden') |
|
44 |
|
45 settings = Attribute("Renderer settings") |
|
46 |
|
47 |
|
48 class IHeaderTarget(IAttributeAnnotatable): |
|
49 """Header target marker interface""" |
|
50 |
|
51 |
|
52 class IHeaderRenderer(IContentRenderer): |
|
53 """Header renderer interface""" |
|
54 |
|
55 name = Attribute("Renderer name") |
|
56 settings_key = Attribute("Renderer settings key") |
|
57 cache_key = Attribute("Renderer cache key") |
|
58 |
|
59 |
|
60 class IHeaderRendererSettings(IRendererSettings): |
|
61 """Header renderer settings interface""" |