r6647 - trunk/gnue-forms/src/uidrivers/gtk2/widgets

[kilo]

Author: kilo
Date: 2004-11-08 04:52:03 -0600 (Mon, 08 Nov 2004)
New Revision: 6647

Modified:
   trunk/gnue-forms/src/uidrivers/gtk2/widgets/_base.py
Log:
Added comments

Modified: trunk/gnue-forms/src/uidrivers/gtk2/widgets/_base.py
===================================================================
--- trunk/gnue-forms/src/uidrivers/gtk2/widgets/_base.py        2004-11-08 
10:47:26 UTC (rev 6646)
+++ trunk/gnue-forms/src/uidrivers/gtk2/widgets/_base.py        2004-11-08 
10:52:03 UTC (rev 6647)
@@ -36,6 +36,9 @@
 # =============================================================================
 
 class UIHelper (UIWidget):
+  """
+  Implements the common behaviour of GTK2 widgets
+  """
 
   # ---------------------------------------------------------------------------
   # Create a new GTK widget
@@ -168,7 +171,7 @@
 
   def hide (self):
     """
-    This function calls the show () on all gtk-widgets managed by this
+    This function calls the hide () on all gtk-widgets managed by this
     instance. This is needed if a row-count greater than 0 is given.
     """
     for widget in self.widgets:
@@ -315,15 +318,24 @@
       widget.set_sensitive (0)
 
 
-
+  # --------------------------------------------------------------------------
+  # Set the cursor's location in a widget
+  # --------------------------------------------------------------------------
   def setCursorPosition (self, position, index = 0):
+    """
+    Sets the cursor's position to the given location inside a capable widget.
+    """
     if hasattr (self.widgets [index], 'set_position'):
       self.widgets [index].set_position (position)
 
 
-
-
+  # --------------------------------------------------------------------------
+  # Set the selection inside a widget
+  # --------------------------------------------------------------------------
   def setSelectedArea (self, selection1, selection2, index=0):
+    """
+    Sets the selection start/end inside a capable widget.
+    """
     try:
       self.widgets [index].select_region (selection1, selection2)
 
@@ -331,7 +343,6 @@
       pass
 
 
-
   # ---------------------------------------------------------------------------
   # Block or unblock a given event handler of a widget
   # ---------------------------------------------------------------------------