# HG changeset patch
# User Thinker K.F. Li <thinker@codemud.net>
# Date 1304356880 -28800
# Node ID ac390af12152c2106589a9c8f9640765569bfa35
# Parent  b0e113605382aa72bf84b81a6860abe62fe2b831
Add comment and rename methods

diff -r b0e113605382 -r ac390af12152 pyink/FSM_window.py
--- a/pyink/FSM_window.py	Mon May 02 23:26:32 2011 +0800
+++ b/pyink/FSM_window.py	Tue May 03 01:21:20 2011 +0800
@@ -782,17 +782,17 @@
             return
 
         if evtype == pybInkscape.PYSPItem.PYB_EVENT_BUTTON_RELEASE:
-            self._clean_select()
+            self._deselect_state()
             pass
         pass
 
     def _select_state(self, state):
-        self._clean_select()
+        self._deselect_state()
         self._selected_cleaner = state.hide_selected
         state.show_selected()
         pass
 
-    def _clean_select(self):
+    def _deselect_state(self):
         if self._selected_cleaner:
             self._selected_cleaner()
             pass
@@ -834,7 +834,9 @@
             pass
         pass
 
-    def _install_transition_mouse_event_handler(self, trn):
+    ## \brief Install event handler for control points of a transitions.
+    #
+    def _install_trn_cps_mouse(self, trn):
         c1, l01, c2, l32 = trn._control_points
         path = trn.path
         c0x, c0y, c1x, c1y, c2x, c2y, c3x, c3y = tuple(path)
@@ -931,25 +933,29 @@
         c2_dragger.connect(c2)
         pass
 
+    ## \brief A transition was selected.
+    #
     def _select_transition(self, trn):
-        def cleaner():
+        def deselect():
             trn.hide_control_points()
             del self._hint_transition # enable _hint_transition
             pass
         
         self._hint_transition = lambda *args: None # disable _hint_transition
         
-        self._clean_select()
-        self._selected_cleaner = cleaner
+        self._deselect_state()
+        self._selected_cleaner = deselect
         trn.show_control_points()
         
         trn.stop_hint()
         window = self._window
         window.ungrab_bg()
         
-        self._install_transition_mouse_event_handler(trn)
+        self._install_trn_cps_mouse(trn)
         pass
 
+    ## \brief Hint for mouse over a transition.
+    #
     def _hint_transition(self, trn):
         def stop_hint(*args):
             trn.stop_hint()
@@ -985,7 +991,7 @@
         pass
 
     def deactivate(self):
-        self._clean_select()
+        self._deselect_state()
         pass
     pass