Move the update method to View.

[matthijs/upstream/mobilegtd.git] / src / gui / gui.py

diff --git a/src/gui/gui.py b/src/gui/gui.py
index e4b3db05d88086b6aea5f619f31c76aa2384ba34..f03880854f2310bdccda1216bc322c4a60e1277a 100644 (file)
--- a/src/gui/gui.py
+++ b/src/gui/gui.py
@@ -93,7 +93,6 @@ def save_gui(object):
     object.old_menu = appuifw.app.menu
     object.old_exit_key_handler = appuifw.app.exit_key_handler
     object.old_title=appuifw.app.title
-    object.lock = Ao_lock()
 
 def restore_gui(object):
     appuifw.app.body = object.old_gui
@@ -101,22 +100,28 @@ def restore_gui(object):
     appuifw.app.exit_key_handler = object.old_exit_key_handler
     appuifw.app.title = object.old_title
 
-
-class ListView(object):
+class View(object):
     def __init__(self):
-        self.view = appuifw.Listbox(self.items(),self.change_entry)
-        super(ListView, self).__init__()
+        self.title = None
+        self.view = None
+        self.lock = Ao_lock()
+        self.exit_flag = False
+        super(View, self).__init__()
 
     def set_title(self, title):
         self.title = title
-    
-    def change_entry(self):
-        pass
-    
+   
+    def set_view(self, view):
+        """
+        Sets the main view to be displayed (e.g., an appuifw.Listbox
+        instance).
+        """
+        self.view = view
+
     def run(self):
         self.adjustment = None
-        appuifw.app.screen=COMMON_CONFIG['screen'].encode('utf-8')
         save_gui(self)
+        appuifw.app.screen=COMMON_CONFIG['screen'].encode('utf-8')
         appuifw.app.title=self.title
         appuifw.app.body=self.view
         appuifw.app.exit_key_handler=self.exit
@@ -128,16 +133,47 @@ class ListView(object):
         except:
             pass
         restore_gui(self)
+
     def exit(self):
         self.exit_flag = True
         self.lock.signal()
 
     def update(self,subject=None):
-        #logger.log(u'Updated %s'%repr(self))
+        """
+        Update the current view (e.g., make sure refresh is called). We
+        can't call it directly, since we're in another thread.
+        """
         if self.lock:
             self.lock.signal()
-        #pass
 
+    def refresh(self):
+        """
+        Called when the current view must be updated. Never call
+        directly. Subclasses should extend this method, not update.
+        """
+        appuifw.app.menu=self.get_menu_entries()
+
+    def get_menu_entries(self):
+        """ Returns a list of menu entries to display. Will be
+        automatically updated on each refresh.
+
+        Each menu entry is a tuple of a title for the entry and a
+        function to call when the entry is selected.
+        """
+        return []
+
+class ListView(View):
+    def __init__(self):
+        super(ListView, self).__init__()
+        self.set_view(appuifw.Listbox(self.items(),self.entry_selected))
+
+    def entry_selected(self):
+        """
+        This function is called when the user selects an an entry (e.g.,
+        navigates to it and push the ok button).
+        """
+        pass
+    
     def index_changed(self,adjustment=None):
         if adjustment:
             index = self.selected_index() + adjustment
@@ -149,9 +185,6 @@ class ListView(object):
             index = 0
         self.set_bindings_for_selection(index)
 
-    def refresh(self):
-        appuifw.app.menu=self.get_menu_entries()
-
     def set_index(self,index):
         if index > len(self.widgets):
             index = len(self.widgets)
@@ -162,12 +195,10 @@ class ListView(object):
     def selected_index(self):
         return self.view.current()
 
-
 class WidgetBasedListView(ListView):
     def __init__(self):
         self.widgets = self.generate_widgets()
         super(WidgetBasedListView,self).__init__()
-        self.exit_flag = False
 
     def run(self):
         self.refresh()
@@ -193,7 +224,7 @@ class WidgetBasedListView(ListView):
         return self.widgets[self.selected_index()]
         
 
-class KeyBindingView(object):
+class KeyBindingView(View):
     
     def __init__(self):
         self.binding_map = {}
@@ -223,7 +254,8 @@ class KeyBindingView(object):
                     description='    '+description
                 menu_entries.append((description,function)) 
         menu_entries.append((u'Exit', self.exit))
-        return menu_entries       
+        return menu_entries + super(KeyBindingView, self).get_menu_entries()
+
     def set_bindings_for_selection(self,selected_index):
         self.remove_all_key_bindings()
         
@@ -285,7 +317,7 @@ class EditableListView(SearchableListView,KeyBindingView):
             key_and_menu_bindings.append((get_key(key),key,description,execute_and_update_function))
         return key_and_menu_bindings
 
-    def change_entry(self):
+    def entry_selected(self):
         self.current_widget().change()
         self.refresh()
     def execute_and_update(self,function):