r15978 - /branches/uf_redesign/user_functions/objects.py -- May 04, 2012 - 18:19

Author: bugman
Date: Fri May  4 18:19:27 2012
New Revision: 15978

URL: http://svn.gna.org/viewcvs/relax?rev=15978&view=rev
Log:
The list_titles arg is now accepted for the auto-generated user functions.

This is for a list of lists, and are the titles for the lists.


Modified:
    branches/uf_redesign/user_functions/objects.py

Modified: branches/uf_redesign/user_functions/objects.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/objects.py?rev=15978&r1=15977&r2=15978&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/objects.py (original)
+++ branches/uf_redesign/user_functions/objects.py Fri May  4 18:19:27 2012
@@ -159,7 +159,7 @@
         self.__dict__[name] = value
 
 
-    def add_keyarg(self, name=None, default=None, py_type=None, 
desc_short=None, desc=None, wiz_element_type='text', wiz_combo_choices=[], 
wiz_combo_data=None, wiz_combo_default=None, wiz_combo_iter=None, 
wiz_combo_list_size=None, wiz_read_only=False, can_be_none=False):
+    def add_keyarg(self, name=None, default=None, py_type=None, 
desc_short=None, desc=None, list_titles=None, wiz_element_type='text', 
wiz_combo_choices=[], wiz_combo_data=None, wiz_combo_default=None, 
wiz_combo_iter=None, wiz_combo_list_size=None, wiz_read_only=False, 
can_be_none=False):
         """Wrapper method for adding keyword argument information to the 
container.
 
         @keyword name:                  The name of the argument.
@@ -172,6 +172,8 @@
         @type desc_short:               str
         @keyword desc:                  The long human-readable description 
of the argument.
         @type desc:                     str
+        @keyword list_titles:           The titles of each of the elements 
of the fixed width second dimension.  This only applies to list of lists.
+        @type list_titles:              list of str
         @keyword wiz_element_type:      The type of GUI element to create.  
If set to 'text', a wx.TextCtrl element will be used.  If set to 'combo', a 
wx.ComboBox element will be used.
         @type wiz_element_type:         str
         @keyword wiz_combo_choices:     The list of choices to present to 
the user.  This is only used if the element_type is set to 'combo'.
@@ -210,6 +212,7 @@
         arg['py_type'] = py_type
         arg['desc'] = desc
         arg['desc_short'] = desc_short
+        arg['list_titles'] = list_titles
         arg['wiz_element_type'] = wiz_element_type
         arg['wiz_combo_choices'] = wiz_combo_choices
         arg['wiz_combo_data'] = wiz_combo_data