ignore requests to invalidate non-existing entries
[enigma2.git] / lib / python / Components / ConfigList.py
1 from HTMLComponent import *
2 from GUIComponent import *
3 from config import KEY_LEFT, KEY_RIGHT, KEY_0, KEY_DELETE, KEY_OK, KEY_TIMEOUT, ConfigElement
4 from Components.ActionMap import NumberActionMap
5 from enigma import eListbox, eListboxPythonConfigContent, eTimer
6
7 class ConfigList(HTMLComponent, GUIComponent, object):
8         def __init__(self, list, session = None):
9                 GUIComponent.__init__(self)
10                 self.l = eListboxPythonConfigContent()
11                 self.l.setSeperation(100)
12                 self.timer = eTimer()
13                 self.list = list
14                 self.onSelectionChanged = [ ]
15                 self.current = None
16                 self.help_window = None
17                 self.setHelpWindowSession(session)
18
19         def execBegin(self):
20                 self.timer.timeout.get().append(self.timeout)
21
22         def execEnd(self):
23                 self.timer.timeout.get().remove(self.timeout)
24
25         def setHelpWindowSession(self, session):
26                 assert self.help_window is None, "you can't move a help window to another session"
27                 self.session = session
28
29         def toggle(self):
30                 selection = self.getCurrent()
31                 selection[1].toggle()
32                 self.invalidateCurrent()
33
34         def handleKey(self, key):
35                 selection = self.getCurrent()
36                 if selection and selection[1].enabled:
37                         selection[1].handleKey(key)
38                         self.invalidateCurrent()
39                         if self.help_window:
40                                 self.help_window.update(selection[1])
41                         if key not in [KEY_TIMEOUT, KEY_LEFT, KEY_RIGHT, KEY_DELETE, KEY_OK]:
42                                 self.timer.start(1000, 1)
43
44         def getCurrent(self):
45                 return self.l.getCurrentSelection()
46         
47         def invalidateCurrent(self):
48                 self.l.invalidateEntry(self.l.getCurrentSelectionIndex())
49
50         def invalidate(self, entry):
51                 # when the entry to invalidate does not exist, just ignore the request.
52                 # this eases up conditional setup screens a lot.
53                 if entry in self.__list:
54                         self.l.invalidateEntry(self.__list.index(entry))
55
56         GUI_WIDGET = eListbox
57         
58         def selectionChanged(self):
59                 n = self.getCurrent()
60                 
61                 if self.help_window:
62                         self.session.deleteDialog(self.help_window)
63                 
64                 nh = n and n[1].helpWindow()
65                 if nh is not None and self.session is not None:
66                         self.help_window = self.session.instantiateDialog(*nh)
67                         self.help_window.show()
68
69                 self.current = n
70                 for x in self.onSelectionChanged:
71                         x()
72
73         def postWidgetCreate(self, instance):
74                 instance.setContent(self.l)
75                 instance.selectionChanged.get().append(self.selectionChanged)
76         
77         def preWidgetRemove(self, instance):
78                 instance.selectionChanged.get().remove(self.selectionChanged)
79         
80         def setList(self, l):
81                 self.timer.stop()
82                 self.__list = l
83                 self.l.setList(self.__list)
84
85                 if l is not None:
86                         for x in l:
87                                 assert isinstance(x[1], ConfigElement), "entry in ConfigList " + str(x[1]) + " must be a ConfigElement"
88
89         def getList(self):
90                 return self.__list
91
92         list = property(getList, setList)
93
94         def timeout(self):
95                 self.handleKey(KEY_TIMEOUT)
96
97 class ConfigListScreen:
98         def __init__(self, list, session = None, on_change = None):
99                 self["config_actions"] = NumberActionMap(["SetupActions", "TextInputActions"],
100                 {
101                         "ok": self.keyOK,
102                         "left": self.keyLeft,
103                         "right": self.keyRight,
104                         "delete": self.keyDelete,
105                         "1": self.keyNumberGlobal,
106                         "2": self.keyNumberGlobal,
107                         "3": self.keyNumberGlobal,
108                         "4": self.keyNumberGlobal,
109                         "5": self.keyNumberGlobal,
110                         "6": self.keyNumberGlobal,
111                         "7": self.keyNumberGlobal,
112                         "8": self.keyNumberGlobal,
113                         "9": self.keyNumberGlobal,
114                         "0": self.keyNumberGlobal
115                 }, -1) # to prevent left/right overriding the listbox
116                 
117                 self["config"] = ConfigList(list, session = session)
118                 if on_change is not None:
119                         self.__changed = on_change
120                 else:
121                         self.__changed = lambda: None
122
123         def keyOK(self):
124                 self["config"].handleKey(KEY_OK)
125
126         def keyLeft(self):
127                 self["config"].handleKey(KEY_LEFT)
128                 self.__changed()
129
130         def keyRight(self):
131                 self["config"].handleKey(KEY_RIGHT)
132                 self.__changed()
133
134         def keyDelete(self):
135                 self["config"].handleKey(KEY_DELETE)
136                 self.__changed()
137
138         def keyNumberGlobal(self, number):
139                 self["config"].handleKey(KEY_0 + number)
140                 self.__changed()
141