Changeset 5968 for main/waeup.sirp/trunk/src/waeup/sirp/browser

Timestamp:

23 Apr 2011, 01:46:57 (14 years ago)

Author:

uli

Message:

Replace themes source by themes vocabulary. It looks like this is much easier to handle in the long run.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/browser/theming.py (modified) (2 diffs)

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

@@ -26 +26 @@
 from zope.component import getUtilitiesFor
 from zope.interface import Interface
-from waeup.sirp.interfaces import IThemesProvider
+from zope.schema.interfaces import IVocabularyFactory
+from waeup.sirp.interfaces import SimpleWAeUPVocabulary
 from waeup.sirp.browser.interfaces import ITheme
 from waeup.sirp.browser.resources import waeuptheme_red1, waeuptheme_gray1
@@ -58 +59 @@
         yield name, theme
 
-class ThemesProvider(grok.GlobalUtility):
-    """A global utility providing all themes available.
+class ThemesVocabulary(grok.GlobalUtility):
+    """A vocabulary that provides all themes available.
+
+    A named global utility implementing
+
+      :class:`zope.schema.interfaces.IVocabularyFactory
+
+    and registered under the name
+
+      'waeup.sirp.browser.theming.ThemesVocabulary'
+    
+    Interface fields that wish to provide a list of available themes
+    can require a 'named vocabulary', i.e. set:
+
+      vocabulary = 'waeup.sirp.browser.theming.ThemesVocabulary'
+
+    and the vocabulary will deliver themes and their descriptive text
+    for instance in select boxes of forms.
+
+    The name is chosen so that the location of this vocabulary can be
+    found easily when used in an interface definition.
     """
-    grok.implements(IThemesProvider)
-    grok.name('default')
+    grok.implements(IVocabularyFactory)
+    grok.name('waeup.sirp.browser.theming.ThemesVocabulary')
+    
+    def __call__(self, context):
+        """Deliver a vocabulary of available themes.
 
-    def __call__(self):
-        return get_all_themes()
+        The `description`s of available themes are used as 'title' and
+        the utility names delivering the different themes as 'value'
+        and 'token'.
+        """
+        terms = [(theme.description, name)
+                 for name, theme in get_all_themes()]
+        vocab = SimpleWAeUPVocabulary(*terms)
+        return vocab