← 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

Merged from new-dispatch branch.
This branch is now a child of new-dispatch (until that branch is merged with
    trunk).

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
    pass
 
35
    
 
36
class OverlayPlugin(BasePlugin):
 
37
    """
 
38
    Marker class for plugins which provide overlays.
 
39
    
 
40
    Overlay plugins provide mini-views which can be displayed on top of other
 
41
    views. The canonical example of a plugin of this type is the Console plugin.
 
42
    """
 
43
    pass
 
44
 
 
45
class CookiePlugin(BasePlugin):
 
46
    """Marker class for plugins which provide cookies.
 
47
 
 
48
    Cookie plugins provide a 'cookies' dict mapping names to generation
 
49
    functions. The function should return the data to store in the cookie on
 
50
    login. If the function is None, the cookie is not created on login, just
 
51
    deleted on logout.
 
52
    """
 
53
    pass
 
54
 
 
55
class MediaPlugin(BasePlugin):
 
56
    """Marker class for plugins which provide media files.
 
57
 
 
58
    Media plugins provide a 'media' attribute, which is a string pointing to a
 
59
    subdirectory that contains media files to be served statically.
 
60
    """
 
61
    pass