[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces/browser - form.py:1.8.2.3

Fred L. Drake, Jr. fred@zope.com
Mon, 19 May 2003 13:43:39 -0400


Update of /cvs-repository/Zope3/src/zope/app/interfaces/browser
In directory cvs.zope.org:/tmp/cvs-serv17132

Modified Files:
      Tag: schema-vocabulary-branch
	form.py 
Log Message:
- performAction() added
- clarified and extended docstring for setName()


=== Zope3/src/zope/app/interfaces/browser/form.py 1.8.2.2 => 1.8.2.3 ===
--- Zope3/src/zope/app/interfaces/browser/form.py:1.8.2.2	Fri May 16 15:51:57 2003
+++ Zope3/src/zope/app/interfaces/browser/form.py	Mon May 19 13:43:38 2003
@@ -167,8 +167,28 @@
     def setName(name):
         """Set the name used to compute the form field names.
 
-        Element names should be the given name, or add additional name
-        components separated by dots.
+        Form field names should be the given name, or additional name
+        components separated by dots may be appended if multiple form
+        fields are needed.
+
+        This will be called immediately after the IVocabularyQueryView
+        has been created; form values may be extracted as a result of
+        calling this method.
+        """
+
+    def performAction(value):
+        """Perform any action indicated by any submit buttons in the
+        sub-widget.
+
+        'value' is the current value of the field.  Submit actions may
+        cause the value to be modified.  If so, the new value should
+        be returned; otherwise the old value should be returned.
+
+        Actions should only be performed if a submit button provided
+        by the view was selected.
+
+        This method will be called after setName() and before
+        renderInput() or renderResults().
         """
 
     def renderInput():