diff options
Diffstat (limited to 'tdehtml/xml/dom2_traversalimpl.h')
| -rw-r--r-- | tdehtml/xml/dom2_traversalimpl.h | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/tdehtml/xml/dom2_traversalimpl.h b/tdehtml/xml/dom2_traversalimpl.h new file mode 100644 index 000000000..43800c4aa --- /dev/null +++ b/tdehtml/xml/dom2_traversalimpl.h @@ -0,0 +1,196 @@ +/* + * This file is part of the DOM implementation for KDE. + * + * (C) 1999 Lars Knoll (knoll@kde.org) + * (C) 2000 Frederik Holljen (frederik.holljen@hig.no) + * (C) 2001 Peter Kelly (pmk@post.com) + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this library; see the file COPYING.LIB. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + * + */ + +#ifndef _DOM2_TraversalImpl_h_ +#define _DOM2_TraversalImpl_h_ + +#include "dom/dom_node.h" +#include "dom/dom_misc.h" +#include "misc/shared.h" +#include "dom/dom2_traversal.h" + +namespace DOM { + +class NodeImpl; +class DocumentImpl; + +class NodeIteratorImpl : public tdehtml::Shared<NodeIteratorImpl> +{ +public: + NodeIteratorImpl(NodeImpl *_root, unsigned long _whatToShow, NodeFilter _filter, bool _entityReferenceExpansion); + ~NodeIteratorImpl(); + + + NodeImpl *root(); + unsigned long whatToShow(); + NodeFilter filter(); + bool expandEntityReferences(); + + NodeImpl *nextNode(int &exceptioncode); + NodeImpl *previousNode(int &exceptioncode); + void detach(int &exceptioncode); + + + /** + * This function has to be called if you delete a node from the + * document tree and you want the Iterator to react if there + * are any changes concerning it. + */ + void notifyBeforeNodeRemoval(NodeImpl *removed); + + short isAccepted(NodeImpl *n); + NodeImpl *getNextNode(NodeImpl *n); + NodeImpl *getPreviousNode(NodeImpl *n); +protected: + NodeImpl *m_root; + long m_whatToShow; + NodeFilter m_filter; + bool m_expandEntityReferences; + + bool m_inFront; + NodeImpl *m_referenceNode; + bool m_detached; + DocumentImpl *m_doc; +}; + +class NodeFilterImpl : public tdehtml::Shared<NodeFilterImpl> +{ +public: + NodeFilterImpl(); + ~NodeFilterImpl(); + + short acceptNode(const Node &n); + + void setCustomNodeFilter(CustomNodeFilter *custom); + CustomNodeFilter *customNodeFilter(); +protected: + CustomNodeFilter *m_customNodeFilter; + +}; + +class TreeWalkerImpl : public tdehtml::Shared<TreeWalkerImpl> +{ +public: + TreeWalkerImpl(); + TreeWalkerImpl(const TreeWalkerImpl &other); + TreeWalkerImpl(NodeImpl *n, NodeFilter f); + TreeWalkerImpl(NodeImpl *n, long _whatToShow, NodeFilterImpl *f, + bool entityReferenceExpansion); + TreeWalkerImpl & operator = (const TreeWalkerImpl &other); + + + ~TreeWalkerImpl(); + + NodeImpl *getRoot() const; + + unsigned long getWhatToShow() const; + + NodeFilterImpl *getFilter() const; + + bool getExpandEntityReferences() const; + + NodeImpl *getCurrentNode() const; + + void setCurrentNode( NodeImpl *_currentNode); + + NodeImpl *parentNode(); + + NodeImpl *firstChild(); + + NodeImpl *lastChild (); + + NodeImpl *previousSibling (); + + NodeImpl *nextSibling(); + + NodeImpl *previousNode(); + + NodeImpl *nextNode(); + + + /** + * Sets which node types are to be presented via the TreeWalker + */ + void setWhatToShow(long _whatToShow); + void setFilter(NodeFilterImpl *_filter); + void setExpandEntityReferences(bool value); + + NodeImpl *getParentNode(NodeImpl *n); + NodeImpl *getFirstChild(NodeImpl *n); + NodeImpl *getLastChild(NodeImpl *n); + NodeImpl *getPreviousSibling(NodeImpl *n); + NodeImpl *getNextSibling(NodeImpl *n); + + short isAccepted(NodeImpl *n); + +protected: + /** + * This attribute determines which node types are presented via + * the TreeWalker. + * + */ + long m_whatToShow; + + /** + * The filter used to screen nodes. + * + */ + NodeFilterImpl *m_filter; + + /** + * The value of this flag determines whether entity reference + * nodes are expanded. To produce a view of the document that has + * entity references expanded and does not expose the entity + * reference node itself, use the whatToShow flags to hide the + * entity reference node and set expandEntityReferences to true + * when creating the iterator. To produce a view of the document + * that has entity reference nodes but no entity expansion, use + * the whatToShow flags to show the entity reference node and set + * expandEntityReferences to true. + * + * This is not implemented (always true) + */ + bool m_expandEntityReferences; + + /** + * The current node. + * + * The value must not be null. Attempting to set it to null will + * raise a NOT_SUPPORTED_ERR exception. When setting a node, the + * whatToShow flags and any Filter associated with the TreeWalker + * are not checked. The currentNode may be set to any Node of any + * type. + * + */ + NodeImpl *m_currentNode; + + NodeImpl *m_rootNode; + DocumentImpl *m_doc; +}; + + +} // namespace + +#endif + |