← 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

Restore the media files (just help.css) to the new help system.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/plugins.py
22
22
    Base class for all Plugin classes.
23
23
    """
24
24
    pass
25
 
 
 
25
    
26
26
class ViewPlugin(BasePlugin):
27
27
    """Marker class for plugins that provide views.
28
 
 
 
28
    
29
29
    View plugins must have a 'urls' property which contains an iterable of pairs
30
30
    or triples, like (routex string, handler class, kwargs dict). The kwargs
31
31
    dict is optional. If present, the members of the kwargs dict will be passed
32
32
    as keyword arguments to the constructor of the view object.
33
 
 
 
33
    
34
34
    View plugins may also have a 'help' property, which should contain a dict
35
35
    of dicts and help file names. This dict is then used to generate the
36
36
    appropriate entries in the help system.
37
 
 
38
 
    Tabs can also be defined by view plugins. To define tabs, provide a 'tabs'
39
 
    property containing 6-tuples of (name, title, desc, icon, path, weight).
40
 
    The icon should be relative to the plugin's media directory, and the path
41
 
    should be relative to the root. The weight is used for ordering; larger
42
 
    weights are further right.
43
 
    """
44
 
    pass
45
 
 
46
 
class PublicViewPlugin(BasePlugin):
47
 
    """Marker class for plugins that provide public mode views.
48
 
 
49
 
    Public view plugins can specify the same 'urls' property as normal view
50
 
    plugins, but they are added to the public mode router instead.
51
 
    """
52
 
    pass
53
 
 
 
37
    """
 
38
    pass
 
39
    
54
40
class OverlayPlugin(BasePlugin):
55
41
    """Marker class for plugins which provide overlays.
56
 
 
 
42
    
57
43
    Overlay plugins provide mini-views which can be displayed on top of other
58
44
    views. The canonical example of a plugin of this type is the Console plugin.
59
45
    """