r13372 - /branches/gui_testing/gui/user_functions/base.py -- July 01, 2011 - 16:40

Author: bugman
Date: Fri Jul  1 16:40:36 2011
New Revision: 13372

URL: http://svn.gna.org/viewcvs/relax?rev=13372&view=rev
Log:
If uf_path is set in the user function window classes, then the main text 
will come from the docstring.


Modified:
    branches/gui_testing/gui/user_functions/base.py

Modified: branches/gui_testing/gui/user_functions/base.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/user_functions/base.py?rev=13372&r1=13371&r2=13372&view=diff
==============================================================================
--- branches/gui_testing/gui/user_functions/base.py (original)
+++ branches/gui_testing/gui/user_functions/base.py Fri Jul  1 16:40:36 2011
@@ -22,6 +22,9 @@
 
 # Module docstring.
 """Base class module for the user function GUI elements."""
+
+# relax module imports.
+from prompt.base_class import _format_text
 
 # relax GUI imports.
 from gui.wizard import Wiz_page
@@ -48,6 +51,9 @@
 class UF_page(Wiz_page):
     """User function specific pages for the wizards."""
 
+    # The path to the user function.
+    uf_path = None
+
     def __init__(self, parent, gui, interpreter):
         """Set up the window.
 
@@ -63,5 +69,24 @@
         self.gui = gui
         self.interpreter = interpreter
 
+        # User function path is supplied, so set the main text to the 
docstring.
+        if self.uf_path != None:
+            # Get the user function class (or function).
+            uf_class = getattr(self.interpreter, self.uf_path[0])
+
+            # Get the user function.
+            if len(self.uf_path) == 1:
+                uf = uf_class
+            else:
+                uf = getattr(uf_class, self.uf_path[1])
+
+            # Set the main text to the description doc.
+            if hasattr(uf, '_doc_desc'):
+                self.main_text = _format_text(uf._doc_desc)
+
+                # Remove trailing newlines.
+                if self.main_text[-1] == '\n':
+                    self.main_text = self.main_text[:-1]
+
         # Execute the base class method.
         super(UF_page, self).__init__(parent)