Changeset 5957

Timestamp:

22 Apr 2011, 01:43:53 (14 years ago)

Author:

uli

Message:

Define, what a theme means in waeup.sirp terms from now on.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/browser/interfaces.py (modified) (1 diff)

main/waeup.sirp/trunk/src/waeup/sirp/browser/interfaces.py

@@ -55 +55 @@
         """Get the list of breadcrumbs as real Python list.
         """
+class ITheme(Interface):
+    """An theme or 'skin'.
 
+    Themes are basically collections of CSS- and/or JavaScript files
+    stored somewhere. In Grok-contexts these files can be registered
+    as 'resources' (see :mod:`waeup.sirp.browser.resources`).
+
+    Furthermore, to make themes selectable and distinctable from each
+    other we assign them short descriptions.
+
+    Themes should be registered as named utilities so that they can be
+    defined also in third-party packages and be looked up by other
+    components like theme-selectors.
+    """
+    description = schema.TextLine(
+        title = u'Description',
+        description = u'Short description of the theme for choice fields',
+        required = False,
+        )
+        
+    def getResources():
+        """Get resources of the theme.
+
+        Deliver a list of resources that must be included in a web page to
+        let it be rendered in the theme's style.
+
+        A resource is normally defined in the `resources` module. If a
+        theme needs several of them which normally do not depend on
+        each other then all these resources can be returned by this
+        method. Normally, you will only return one resource.
+
+        These resources will (if the theme is selected) be `need()`-ed
+        by the `update()` method of the general site layout.
+        """