# HG changeset patch
# User Thinker K.F. Li <thinker@codemud.net>
# Date 1305042192 -28800
# Node ID 5d4c7ec05bcd464b4917d4351a8e6cc373d6f54e
# Parent  89426a38752f45cd2e0f49e25f575bade7381dd0
Add comments

diff -r 89426a38752f -r 5d4c7ec05bcd pyink/FSM_window.py
--- a/pyink/FSM_window.py	Tue May 10 23:23:29 2011 +0800
+++ b/pyink/FSM_window.py	Tue May 10 23:43:12 2011 +0800
@@ -1022,6 +1022,14 @@
     pass
 
 
+## \brief Management selections
+#
+# There is only one state, control points of a transition, or
+# transition being selected at any instance.  This class manage
+# selection to keep the requirement consisted.  When caller select a
+# new state, control points of a transition, or transition, the class
+# will de-select previous one automatically.
+#
 class _select_manager(object):
     selected_state = None
     selected_transition = None
@@ -1069,6 +1077,8 @@
         self.deselect = hide
         pass
 
+    ## \brief Forget all state of the instance
+    #
     def reset(self):
         try:
             del self.deselect
@@ -1081,6 +1091,12 @@
     pass
 
 
+## \brief Handle popup menu for states and transitions.
+#
+# _FSM_popup.popup_install_handler() must be called to install event
+# handlers.  It should be called when FSM_window entering a new mode
+# since it will ungrab all events to activate a new mode.
+#
 class _FSM_popup(object):
     _window = None
     _compview = None