aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFelix Domke <tmbinc@elitedvb.net>2006-03-07 16:32:15 +0000
committerFelix Domke <tmbinc@elitedvb.net>2006-03-07 16:32:15 +0000
commitdb676dd52192447dd3204739ebb081b4b713ad28 (patch)
tree0d38fc82499b2824e51215e90a1d26b682607eb9 /doc
parent320cfa7ae4049aa8b77ad037c4f9e480f084e413 (diff)
downloadenigma2-db676dd52192447dd3204739ebb081b4b713ad28.tar.gz
enigma2-db676dd52192447dd3204739ebb081b4b713ad28.zip
note about skins / screen names
Diffstat (limited to 'doc')
-rw-r--r--doc/PLUGINS21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/PLUGINS b/doc/PLUGINS
index ed448fa2..808fd580 100644
--- a/doc/PLUGINS
+++ b/doc/PLUGINS
@@ -76,6 +76,27 @@ stands for "keyword arguments") collects all addition keyword arguments
parameter, and probably more in the future. You must ignore all additional
keywords which you don't need!
+skins
+=====
+
+Generally, you can include the skin in your Screens by having a static (or
+non-static, if you really want) variable "skin", for example:
+
+class OurSmallTestScreen(Screen):
+ skin = "<skin>...</skin>"
+ def __init__(self, session):
+ Screen.__init__(self, session)
+ ...
+
+However, users can override the skin from their skin.xml. Note that the
+Screen's name (unless you override this, which is possible) is used for
+determining which skin is used. Thus, if you're choosing generic skin names
+like "TheScreen", it's likely to cause namespace clashes.
+
+Thus, please use skin names (i.e. Screen-names, unless you're overriding the
+skin name) which are unique enough to not clash. In doubt, prepend the
+pluginname like in our example.
+
autostarting plugins
====================