Wizard shouldn't be a subclass of HelpableScreen since there is no help
[enigma2.git] / lib / python / Plugins / Plugin.py
index 183419c7fe90d357b83574963f3767ed78b73b6a..a0db1d6637ae93d24015f2e073a1e28db4624fab 100644 (file)
@@ -1,4 +1,7 @@
-from enigma import loadPNG
+from Components.config import ConfigSubsection, config
+from Tools.LoadPixmap import LoadPixmap
+
+config.plugins = ConfigSubsection()
 
 class PluginDescriptor:
        """An object to describe a plugin."""
@@ -11,35 +14,64 @@ class PluginDescriptor:
        #   servicereference
        #   reason
        
+       # you have to ignore unknown kwargs!
+       
        # argument: session
-       WHERE_BLUEMENU = 0
+       WHERE_EXTENSIONSMENU = 0
        WHERE_MAINMENU = 1
        WHERE_PLUGINMENU  = 2
        # argument: session, serviceref (currently selected)
        WHERE_MOVIELIST = 3
-       # ...
-       WHERE_SETUP    = 4
+       # argument: menuid. Fnc must return list with menuitems (4-tuple of name, fnc to call, entryid or None, weight or None)
+       WHERE_MENU = 4
        
        # reason (0: start, 1: end)
        WHERE_AUTOSTART = 5
        
-       # start as wizard. In that case, fnc must be a screen class!
+       # start as wizard. In that case, fnc must be tuple (priority,class) with class being a screen class!
        WHERE_WIZARD = 6
        
-       def __init__(self, name = "Plugin", where = [ ], description = "", icon = None, fnc = None):
+       # like autostart, but for a session. currently, only session starts are 
+       # delivered, and only on pre-loaded plugins
+       WHERE_SESSIONSTART = 7
+       
+       # start as teletext plugin. arguments: session, serviceref
+       WHERE_TELETEXT = 8
+       
+       # file-scanner, fnc must return a list of Scanners
+       WHERE_FILESCAN = 9
+       
+       # fnc must take an interface name as parameter and return None if the plugin supports an extended setup
+       # or return a function which is called with session and the interface name for extended setup of this interface
+       WHERE_NETWORKSETUP = 10
+       
+       def __init__(self, name = "Plugin", where = [ ], description = "", icon = None, fnc = None, wakeupfnc = None, internal = False):
                self.name = name
+               self.internal = internal
                if type(where) is list:
                        self.where = where
                else:
                        self.where = [ where ]
                self.description = description
 
-               self.iconstr = icon
+               if type(icon) is str or icon is None:
+                       self.iconstr = icon
+                       self.icon = None
+               else:
+                       self.icon = icon
+
+               self.wakeupfnc = wakeupfnc
 
                self.__call__ = fnc
 
        def updateIcon(self, path):
                if type(self.iconstr) is str:
-                       self.icon = loadPNG(path + self.iconstr)
+                       self.icon = LoadPixmap(path + "/" + self.iconstr)
                else:
-                       self.icon = None
\ No newline at end of file
+                       self.icon = None
+
+       def getWakeupTime(self):
+               return self.wakeupfnc and self.wakeupfnc() or -1
+
+       def __eq__(self, other):
+               return self.__call__ == other.__call__