← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: mattgiuca
  • Date: 2008-01-11 00:49:06 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:172
util: Added buildurl function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/plugins.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: Matt Giuca, Will Grant
19
 
 
20
 
class BasePlugin(object):
21
 
    """
22
 
    Base class for all Plugin classes.
23
 
    """
24
 
    pass
25
 
    
26
 
class ViewPlugin(BasePlugin):
27
 
    """Marker class for plugins that provide views.
28
 
    
29
 
    View plugins must have a 'urls' property which contains an iterable of pairs
30
 
    or triples, like (routex string, handler class, kwargs dict). The kwargs
31
 
    dict is optional. If present, the members of the kwargs dict will be passed
32
 
    as keyword arguments to the constructor of the view object.
33
 
    
34
 
    View plugins may also have a 'help' property, which should contain a dict
35
 
    of dicts and help file names. This dict is then used to generate the
36
 
    appropriate entries in the help system.
37
 
    """
38
 
    pass
39
 
    
40
 
class OverlayPlugin(BasePlugin):
41
 
    """Marker class for plugins which provide overlays.
42
 
    
43
 
    Overlay plugins provide mini-views which can be displayed on top of other
44
 
    views. The canonical example of a plugin of this type is the Console plugin.
45
 
    """
46
 
    pass
47
 
 
48
 
class CookiePlugin(BasePlugin):
49
 
    """Marker class for plugins which provide cookies.
50
 
 
51
 
    Cookie plugins provide a 'cookies' dict mapping names to generation
52
 
    functions. The function should return the data to store in the cookie on
53
 
    login. If the function is None, the cookie is not created on login, just
54
 
    deleted on logout.
55
 
    """
56
 
    pass
57
 
 
58
 
class MediaPlugin(BasePlugin):
59
 
    """Marker class for plugins which provide media files.
60
 
 
61
 
    Media plugins provide a 'media' attribute, which is a string pointing to a
62
 
    subdirectory that contains media files to be served statically.
63
 
    """
64
 
    pass