r6018 - trunk/gnue-forms/src

[reinhard]

Author: reinhard
Date: 2004-07-21 17:09:17 -0500 (Wed, 21 Jul 2004)
New Revision: 6018

Modified:
   trunk/gnue-forms/src/GFForm.py
Log:
Fixed docstring.


Modified: trunk/gnue-forms/src/GFForm.py
===================================================================
--- trunk/gnue-forms/src/GFForm.py      2004-07-21 22:06:22 UTC (rev 6017)
+++ trunk/gnue-forms/src/GFForm.py      2004-07-21 22:09:17 UTC (rev 6018)
@@ -927,11 +927,11 @@
     """
     This function brings up a message box of a given kind.
     @param message: text to be displayed
-    @param kind: one of the MBOX_* constants defining the type of message box.
-        These constants are defined in uidrivers._base.UIdriver
+    @param kind: 'Question', 'Info', 'Warning', or 'Error'
     @param cancel: Boolean flag indicating wether a cancel button will be
         included or not.
-    @return: one of the RESPONSE_* constans from the base-UIdriver
+    @return: True for <Yes> or <Ok> button, False for <No> button, None for
+        <Cancel> button.
     """
     return self._instance.displayMessageBox (message, kind, cancel, '', title)