##############################################################################
# 
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
# 
# Copyright (c) Digital Creations.  All rights reserved.
# 
# This license has been certified as Open Source(tm).
# 
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
# 
# 1. Redistributions in source code must retain the above copyright
#    notice, this list of conditions, and the following disclaimer.
# 
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions, and the following disclaimer in
#    the documentation and/or other materials provided with the
#    distribution.
# 
# 3. Digital Creations requests that attribution be given to Zope
#    in any manner possible. Zope includes a "Powered by Zope"
#    button that is installed by default. While it is not a license
#    violation to remove this button, it is requested that the
#    attribution remain. A significant investment has been put
#    into Zope, and this effort will continue if the Zope community
#    continues to grow. This is one way to assure that growth.
# 
# 4. All advertising materials and documentation mentioning
#    features derived from or use of this software must display
#    the following acknowledgement:
# 
#      "This product includes software developed by Digital Creations
#      for use in the Z Object Publishing Environment
#      (http://www.zope.org/)."
# 
#    In the event that the product being advertised includes an
#    intact Zope distribution (with copyright and license included)
#    then this clause is waived.
# 
# 5. Names associated with Zope or Digital Creations must not be used to
#    endorse or promote products derived from this software without
#    prior written permission from Digital Creations.
# 
# 6. Modified redistributions of any form whatsoever must retain
#    the following acknowledgment:
# 
#      "This product includes software developed by Digital Creations
#      for use in the Z Object Publishing Environment
#      (http://www.zope.org/)."
# 
#    Intact (re-)distributions of any official Zope release do not
#    require an external acknowledgement.
# 
# 7. Modifications are encouraged but must be packaged separately as
#    patches to official Zope releases.  Distributions that do not
#    clearly separate the patches from the original work must be clearly
#    labeled as unofficial distributions.  Modifications which do not
#    carry the name Zope may be packaged in any form, as long as they
#    conform to all of the clauses above.
# 
# 
# Disclaimer
# 
#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
#   SUCH DAMAGE.
# 
# 
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations.  Specific
# attributions are listed in the accompanying credits file.
# 
##############################################################################

"""
DOM proxying classes which provide Zope support.
"""

class DOMPublishable:
    "Mixin class for DOM classes to provide Zope publishability."
    
    def tpURL(self):
        """
        Return a string used for an URL relative to parent.  Used by
        the dtml-tree tag.
        """

    def tpValues(self):
        "Return a list of immediate subobjects.  Used by the dtml-tree tag."

    def tpId(self):
        "Return a value to be used as an id in tree state."

    def __getitem__(self, key):
        ""
    
    def manage_FTPget(self):
        """Returns the source content of an object. For example, the
        source text of a Document, or the data of a file."""

class DOMIO:
    "Mixin class for DOM classes to provide parsing, writing."

    def writeStream(self, stream = None, encoding = None):
        "Write the XML representation of this object to stream."
    
    def __str__(self):
        "Return the XML representation of this object."

    def get_size(self):
        "Size of this tree or subtree in bytes."

    def index_html(self, REQUEST, RESPONSE):
        "Returns publishable raw XML source"

    def parseXML(self, file):
        "Parse file as XML, replace myself with the resulting tree."

class DOMManageable:
    "Mixin class for DOM classes to provide Zope management interfaces."

    def manage_edit(self, data, title = '', SUBMIT = 'Change',
                    dtpref_cols = '50', dtpref_rows = '20', REQUEST = None):
        """
        If SUBMIT is a size pref variable, handle a textarea size change.
        Otherwise parse the given text and handle the result.
        """

    def manage_upload(self, file, REQUEST=None):
        "Parse the given file and handle the result."

class ManageableWrapper:
    """
    Mixin class to go alongside ManageableNode classes.
    Provides the wrapDOMObj function to create ManageableNode classes.
    """

    def wrapDOMObj(self, node):
        "Return the appropriate manageable class wrapped around the Node."

class ManageableDOMImplementation:
    """
    A proxy of a DOMImplementation node that defines createDocument
    to return a ManageableDocument.
    """

class ManageableNode:
    "A wrapper around a DOM Node."

class ManageableNodeList:
    "A wrapper around a DOM NodeList."

class ManageableNamedNodeMap:
    "A wrapper around a DOM NamedNodeMap."
    
class ManageableDocumentFragment:
    "A wrapper around a DOM DocumentFragment."
    
class ManageableElement:
    "A wrapper around a DOM Element."

class ManageableCharacterData:
    "A wrapper around a DOM CharacterData."

class ManageableCDATASection:
    "A wrapper around a DOM CDATASection."

class ManageableText:
    "A wrapper around a DOM Text."

class ManageableComment:
    "A wrapper around a DOM Comment."

class ManageableProcessingInstruction:
    "A wrapper around a DOM ProcessingInstruction."

class ManageableAttr:
    "A wrapper around a DOM Attr."

class ManageableDocument:
    "A wrapper around a DOM Document."

class ManageableEntityReference:
    "A wrapper around a DOM EntityReference."

class ManageableEntity:
    "A wrapper around a DOM Entity."

class ManageableNotation:
    "A wrapper around a DOM Notation."

class ManageableDocumentType:
    "A wrapper around a DOM DocumentType."
