1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
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.
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.
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
18
# Author: Nick Chadwick, Will Grant
25
class BaseOverlay(object):
26
"""Abstract base class for all overlays."""
29
plugin_scripts_init = []
30
def __init__(self, req):
33
def render(self, req):
34
raise NotImplementedError()
36
class XHTMLOverlay(BaseOverlay):
37
"""Abstract base class for XHTML overlays.
39
An overlay which provides a base class for overlays which need to return
40
XHTML. It is expected that apps which use this overlay will be written using
44
template = 'template.html'
46
def render(self, req):
47
"""Renders an XML stream from the template for this overlay."""
48
ctx = genshi.template.Context()
49
# This is where the sub-class is actually called
50
self.populate(req, ctx)
52
# Renders out the template.
53
template_path = os.path.join(os.path.dirname(
54
inspect.getmodule(self).__file__), self.template)
55
loader = genshi.template.TemplateLoader(".", auto_reload=True)
56
tmpl = loader.load(template_path)
57
return tmpl.generate(ctx)
59
def populate(self, req, ctx):
60
raise NotImplementedError()