← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/webapp/base/overlays.py

  • Committer: William Grant
  • Date: 2009-01-13 01:36:15 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1123
Merge setup-refactor branch. This completely breaks existing installations;
every path (both filesystem and Python) has changed. Do not upgrade without
knowing what you are doing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/overlays.py
1
 
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2009 The University of Melbourne
3
 
#
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
#
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
#
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
 
 
18
 
# Author: Nick Chadwick, Will Grant
19
 
 
20
 
import os
21
 
import inspect
22
 
 
23
 
import genshi
24
 
 
25
 
from ivle.webapp.base.xhtml import GenshiLoaderMixin
26
 
 
27
 
 
28
 
class BaseOverlay(object):
29
 
    """Abstract base class for all overlays."""
30
 
    plugin_scripts = {}
31
 
    plugin_styles = {}
32
 
    plugin_scripts_init = []
33
 
    def __init__(self, req):
34
 
        self.req = req
35
 
 
36
 
    def render(self, req):
37
 
        raise NotImplementedError()
38
 
 
39
 
 
40
 
class XHTMLOverlay(GenshiLoaderMixin, BaseOverlay):
41
 
    """Abstract base class for XHTML overlays.
42
 
 
43
 
    An overlay which provides a base class for overlays which need to return 
44
 
    XHTML. It is expected that apps which use this overlay will be written using
45
 
    Genshi templates.
46
 
    """
47
 
 
48
 
    template = 'template.html'
49
 
 
50
 
    def render(self, req):
51
 
        """Renders an XML stream from the template for this overlay."""
52
 
        ctx = genshi.template.Context()
53
 
        # This is where the sub-class is actually called
54
 
        self.populate(req, ctx)
55
 
 
56
 
        # Renders out the template.
57
 
        template_path = os.path.join(os.path.dirname(
58
 
                        inspect.getmodule(self).__file__), self.template)
59
 
        tmpl = self._loader.load(template_path)
60
 
        return tmpl.generate(ctx)
61
 
 
62
 
    def populate(self, req, ctx):
63
 
        raise NotImplementedError()