[Zope3-checkins] CVS: Zope3/src/zope/publisher/interfaces - http.py:1.17

[Jim Fulton]

Update of /cvs-repository/Zope3/src/zope/publisher/interfaces
In directory cvs.zope.org:/tmp/cvs-serv5737/src/zope/publisher/interfaces

Modified Files:
	http.py 
Log Message:
Merged setApplicationNames into setVirtualHostRoot. Added
documentation of the effect on the path computations.

Added the shiftNameToApplication method, which allows side-effect path
elements (e.g. ++skin++ZopeTop) to be moved into the "application"
part of the url, so that we son't have to keep track of them in
context wrappers.

Reformatted some doc strings to conform to the style guide.


=== Zope3/src/zope/publisher/interfaces/http.py 1.16 => 1.17 ===
--- Zope3/src/zope/publisher/interfaces/http.py:1.16	Tue Jul 22 05:33:37 2003
+++ Zope3/src/zope/publisher/interfaces/http.py	Fri Aug  8 14:08:14 2003
@@ -54,28 +54,37 @@
     methods.
     """
 
-    def setVirtualHostRoot():
-        """Marks the currently traversed object as the root of a
-        virtual host.
+    def setVirtualHostRoot(names):
+        """Marks the currently traversed object as the root of a virtual host.
 
-        Should be called during traversal."""
+        Any path elements traversed up to that 
 
-    def getVirtualHostRoot():
-        """Returns the object which is the virtual host root for this request,
-        or None if setVirtualHostRoot hasn't been called.
-        """
+        Set the names which compose the application path.
+        These are the path elements that appear in the beginning of
+        the generated URLs.
 
-    def setApplicationNames(names):
-        """Set the names which compose the application path.
+        Should be called during traversal.
+        """
 
-        These are the path elements that appear in the beginning of
-        the generated URLs."""
+    def getVirtualHostRoot():
+        """Returns the object which is the virtual host root for this request
+        
+        Return None if setVirtualHostRoot hasn't been called.
+        """
 
     def setApplicationServer(host, proto='http', port=None):
         """Override the host, protocol and port parts of generated URLs.
 
         This affects automatically inserted <base> tags and URL getters
         in the request, but not things like @@absolute_url views.
+        """
+
+    def shiftNameToApplication():
+        """Add the name being traversed to the application name
+
+        This is only allowed in the case where the name is the first name.
+
+        A Value error is raised if the shift can't be performed.
         """