gnome-specimen r27 - branches/import-from-bzr

[wbolster svn gnome org]

Author: wbolster
Date: Tue Jun 17 18:52:17 2008
New Revision: 27
URL: http://svn.gnome.org/viewvc/gnome-specimen?rev=27&view=rev

Log:
* specimenwindow.py:
  - Code cleanup: moved around some methods and added
    documentation.


Modified:
   branches/import-from-bzr/   (props changed)
   branches/import-from-bzr/specimenwindow.py

Modified: branches/import-from-bzr/specimenwindow.py
==============================================================================
--- branches/import-from-bzr/specimenwindow.py	(original)
+++ branches/import-from-bzr/specimenwindow.py	Tue Jun 17 18:52:17 2008
@@ -41,13 +41,14 @@
         self.window.show_all()
 
     def quit(self):
+        'Quits the application'
         gtk.main_quit()
 
     def on_destroy_event(self, widget, data=None):
         'Callback for the window destroy event'
         self.quit()
 
-    # font loading
+    # font listing
 
     def initialize_fonts_pane(self, glade_tree):
         'Initializes the fonts pane'
@@ -143,19 +144,20 @@
         self.previews_treeview_selection.set_select_function(self._set_preview_row_selection)
 
     def cell_data_cb(self, column, cell, model, iter, data=None):
-
         if model.get_path(iter)[0] % 2 == 0:
             # this is a name row
             (name,) = model.get(iter, 0)
             self._set_cell_attributes_for_name_cell(cell, name)
-
         else:
             # this is a preview row
             (name, face) = model.get(iter, 0, 2)
             self._set_cell_attributes_for_preview_cell(cell, face)
 
     def _set_preview_row_selection(self, path):
-        # FIXME: there should be much more parameters in this callback
+        'Callback for the row selection signal'
+        # FIXME: there should be much more parameters in this callback. See
+        # http://bugzilla.gnome.org/show_bug.cgi?id=340475 for the bug report
+        # concerning this issue.
         if (path[0] % 2) == 0:
             # this is a name row
             return True
@@ -165,7 +167,6 @@
             self.previews_treeview_selection.select_path(path)
             return False
 
-
     def _set_cell_attributes_for_name_cell(self, cell, name):
         try:
             # set the values
@@ -201,6 +202,7 @@
         cell.set_property('ellipsize', pango.ELLIPSIZE_END)
 
     def add_preview(self, family, face):
+        'Adds a preview to the list of previews'
         # The face parameter can be None if a top-level row was selected. Don't
         # add a preview in that case.
         if face is None:
@@ -265,8 +267,6 @@
             if (new_path[0] >= 0):
                 self.previews_treeview.set_cursor(new_path)
 
-    # user interaction callbacks
-
     def on_row_activated(self, treeview, path, viewcolumn, *user_data):
         if len(path) == 1:
             # this is a parent row, expand/collapse
@@ -293,25 +293,6 @@
         self.preview_text = widget.get_text()
         self.schedule_update_previews()
 
-    def on_add_button_clicked(self, widget, data=None):
-        'Callback for the Add button'
-        (model, iter) = self.fonts_treeview.get_selection().get_selected()
-        if iter is not None:
-            (family, face) = model.get(iter, 1, 2)
-            self.add_preview(family, face)
-            self.fonts_treeview.grab_focus()
-
-    def on_remove_button_clicked(self, widget, data=None):
-        'Callback for the Remove button'
-        self.delete_selected();
-        self.previews_treeview.grab_focus()
-
-    def on_clear_button_clicked(self, widget, data=None):
-        'Callback for the Clear button'
-        self.clear_previews()
-        self.fonts_treeview.grab_focus()
-
-
     def on_previews_treeview_move_cursor(self, treeview, step, count, data=None):
         'Makes sure only name rows can be selected/have focus'
         (path, column) = treeview.get_cursor()
@@ -324,7 +305,6 @@
 
         return False
 
-
     def on_previews_treeview_key_release_event(self, treeview, event, data=None):
         import gtk.keysyms as syms
         keyval = event.keyval
@@ -337,15 +317,42 @@
         # propagate the event
         return False
 
-    def on_quit_item_activate(self, widget, data=None):
-        self.quit()
 
-    def on_clear_item_activate(self, widget, data=None):
+    # button callbacks
+
+    def on_add_button_clicked(self, widget, data=None):
+        'Callback for the Add button'
+        (model, iter) = self.fonts_treeview.get_selection().get_selected()
+        if iter is not None:
+            (family, face) = model.get(iter, 1, 2)
+            self.add_preview(family, face)
+            self.fonts_treeview.grab_focus()
+
+    def on_remove_button_clicked(self, widget, data=None):
+        'Callback for the Remove button'
+        self.delete_selected();
+        self.previews_treeview.grab_focus()
+
+    def on_clear_button_clicked(self, widget, data=None):
+        'Callback for the Clear button'
         self.clear_previews()
+        self.fonts_treeview.grab_focus()
+
+
+    # menu item callbacks
+
+    def on_quit_item_activate(self, widget, data=None):
+        'Callback for the File->Quit menu item'
+        self.quit()
 
     def on_copy_item_activate(self, widget, data=None):
+        'Callback for the Edit->Copy menu item'
         print 'on_copy_item_clicked'
 
+    def on_clear_item_activate(self, widget, data=None):
+        'Callback for the Edit->Clear menu item'
+        self.clear_previews()
+
     def on_about_item_activate(self, widget, data=None):
         'Callback for the Help->About menu item'