lib/python/Components/ConfigList.py

   1 from HTMLComponent import HTMLComponent
   2 from GUIComponent import GUIComponent
   3 from config import KEY_LEFT, KEY_RIGHT, KEY_HOME, KEY_END, KEY_0, KEY_DELETE, KEY_BACKSPACE, KEY_OK, KEY_TOGGLEOW, KEY_ASCII, KEY_TIMEOUT, KEY_NUMBERS, ConfigElement
   4 from Components.ActionMap import NumberActionMap
   5 from enigma import eListbox, eListboxPythonConfigContent, eRCInput, eTimer
   6 from Screens.MessageBox import MessageBox
   7
   8 class ConfigList(HTMLComponent, GUIComponent, object):
   9         def __init__(self, list, session = None):
  10                 GUIComponent.__init__(self)
  11                 self.l = eListboxPythonConfigContent()
  12                 self.l.setSeperation(200)
  13                 self.timer = eTimer()
  14                 self.list = list
  15                 self.onSelectionChanged = [ ]
  16                 self.current = None
  17                 self.session = session
  18
  19         def execBegin(self):
  20                 rcinput = eRCInput.getInstance()
  21                 rcinput.setKeyboardMode(rcinput.kmAscii)
  22                 self.timer.callback.append(self.timeout)
  23
  24         def execEnd(self):
  25                 rcinput = eRCInput.getInstance()
  26                 rcinput.setKeyboardMode(rcinput.kmNone)
  27                 self.timer.callback.remove(self.timeout)
  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 key in KEY_NUMBERS:
  40                                 self.timer.start(1000, 1)
  41
  42         def getCurrent(self):
  43                 return self.l.getCurrentSelection()
  44
  45         def getCurrentIndex(self):
  46                 return self.l.getCurrentSelectionIndex()
  47
  48         def setCurrentIndex(self, index):
  49                 if self.instance is not None:
  50                         self.instance.moveSelectionTo(index)
  51
  52         def invalidateCurrent(self):
  53                 self.l.invalidateEntry(self.l.getCurrentSelectionIndex())
  54
  55         def invalidate(self, entry):
  56                 # when the entry to invalidate does not exist, just ignore the request.
  57                 # this eases up conditional setup screens a lot.
  58                 if entry in self.__list:
  59                         self.l.invalidateEntry(self.__list.index(entry))
  60
  61         GUI_WIDGET = eListbox
  62
  63         def selectionChanged(self):
  64                 if self.current:
  65                         self.current[1].onDeselect(self.session)
  66                 self.current = self.getCurrent()
  67                 if self.current:
  68                         self.current[1].onSelect(self.session)
  69                 for x in self.onSelectionChanged:
  70                         x()
  71
  72         def postWidgetCreate(self, instance):
  73                 instance.selectionChanged.get().append(self.selectionChanged)
  74                 instance.setContent(self.l)
  75
  76         def preWidgetRemove(self, instance):
  77                 if self.current:
  78                         self.current[1].onDeselect(self.session)
  79                 instance.selectionChanged.get().remove(self.selectionChanged)
  80                 instance.setContent(None)
  81
  82         def setList(self, l):
  83                 self.timer.stop()
  84                 self.__list = l
  85                 self.l.setList(self.__list)
  86
  87                 if l is not None:
  88                         for x in l:
  89                                 assert isinstance(x[1], ConfigElement), "entry in ConfigList " + str(x[1]) + " must be a ConfigElement"
  90
  91         def getList(self):
  92                 return self.__list
  93
  94         list = property(getList, setList)
  95
  96         def timeout(self):
  97                 self.handleKey(KEY_TIMEOUT)
  98
  99         def isChanged(self):
 100                 is_changed = False
 101                 for x in self.list:
 102                         is_changed |= x[1].isChanged()
 103
 104                 return is_changed
 105
 106 class ConfigListScreen:
 107         def __init__(self, list, session = None, on_change = None):
 108                 self["config_actions"] = NumberActionMap(["SetupActions", "InputAsciiActions", "KeyboardInputActions"],
 109                 {
 110                         "gotAsciiCode": self.keyGotAscii,
 111                         "ok": self.keyOK,
 112                         "left": self.keyLeft,
 113                         "right": self.keyRight,
 114                         "home": self.keyHome,
 115                         "end": self.keyEnd,
 116                         "deleteForward": self.keyDelete,
 117                         "deleteBackward": self.keyBackspace,
 118                         "toggleOverwrite": self.keyToggleOW,
 119                         "1": self.keyNumberGlobal,
 120                         "2": self.keyNumberGlobal,
 121                         "3": self.keyNumberGlobal,
 122                         "4": self.keyNumberGlobal,
 123                         "5": self.keyNumberGlobal,
 124                         "6": self.keyNumberGlobal,
 125                         "7": self.keyNumberGlobal,
 126                         "8": self.keyNumberGlobal,
 127                         "9": self.keyNumberGlobal,
 128                         "0": self.keyNumberGlobal
 129                 }, -1) # to prevent left/right overriding the listbox
 130
 131                 self["config"] = ConfigList(list, session = session)
 132                 if on_change is not None:
 133                         self.__changed = on_change
 134                 else:
 135                         self.__changed = lambda: None
 136
 137         def keyOK(self):
 138                 self["config"].handleKey(KEY_OK)
 139
 140         def keyLeft(self):
 141                 self["config"].handleKey(KEY_LEFT)
 142                 self.__changed()
 143
 144         def keyRight(self):
 145                 self["config"].handleKey(KEY_RIGHT)
 146                 self.__changed()
 147
 148         def keyHome(self):
 149                 self["config"].handleKey(KEY_HOME)
 150                 self.__changed()
 151
 152         def keyEnd(self):
 153                 self["config"].handleKey(KEY_END)
 154                 self.__changed()
 155
 156         def keyDelete(self):
 157                 self["config"].handleKey(KEY_DELETE)
 158                 self.__changed()
 159
 160         def keyBackspace(self):
 161                 self["config"].handleKey(KEY_BACKSPACE)
 162                 self.__changed()
 163
 164         def keyToggleOW(self):
 165                 self["config"].handleKey(KEY_TOGGLEOW)
 166                 self.__changed()
 167
 168         def keyGotAscii(self):
 169                 self["config"].handleKey(KEY_ASCII)
 170                 self.__changed()
 171
 172         def keyNumberGlobal(self, number):
 173                 self["config"].handleKey(KEY_0 + number)
 174                 self.__changed()
 175
 176         def saveAll(self):
 177                 for x in self["config"].list:
 178                         x[1].save()
 179
 180         # keySave and keyCancel are just provided in case you need them.
 181         # you have to call them by yourself.
 182         def keySave(self):
 183                 self.saveAll()
 184                 self.close()
 185
 186         def cancelConfirm(self, result):
 187                 if not result:
 188                         return
 189
 190                 for x in self["config"].list:
 191                         x[1].cancel()
 192                 self.close()
 193
 194         def keyCancel(self):
 195                 if self["config"].isChanged():
 196                         self.session.openWithCallback(self.cancelConfirm, MessageBox, _("Really close without saving settings?"))
 197                 else:
 198                         self.close()