dom_node.h

Go to the documentation of this file.

/*
 * This file is part of the DOM implementation for KDE.
 *
 * Copyright 1999 Lars Knoll (knoll@kde.org)
 *
 * 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.
 *
 * This file includes excerpts from the Document Object Model (DOM)
 * Level 1 Specification (Recommendation)
 * http://www.w3.org/TR/REC-DOM-Level-1/
 * Copyright © World Wide Web Consortium , (Massachusetts Institute of
 * Technology , Institut National de Recherche en Informatique et en
 * Automatique , Keio University ). All Rights Reserved.
 *
 */
#ifndef _DOM_Node_h_
#define _DOM_Node_h_

#include <khtml_export.h>
#include <QtCore/QString>

class QRect;

namespace KJS {
    class HTMLDocument;
    class Window;
}
namespace DOM {

class Node;
class DOMString;
class NodeImpl;
class NamedNodeMapImpl;
class EventListener;
class Event;

class KHTML_EXPORT NamedNodeMap
{
public:
    NamedNodeMap();
    NamedNodeMap(const NamedNodeMap &other);

    NamedNodeMap & operator = (const NamedNodeMap &other);

    ~NamedNodeMap();

    unsigned long length() const;

    Node getNamedItem ( const DOMString &name ) const;

    Node setNamedItem ( const Node &arg );

    Node removeNamedItem ( const DOMString &name );

    Node item ( unsigned long index ) const;

    Node getNamedItemNS( const DOMString &namespaceURI,
                         const DOMString &localName ) const;

    Node setNamedItemNS( const Node &arg );

    Node removeNamedItemNS( const DOMString &namespaceURI,
                            const DOMString &localName );

    NamedNodeMapImpl *handle() const { return impl; }
    bool isNull() const { return !impl; }

protected:
    NamedNodeMap( NamedNodeMapImpl *i);
    NamedNodeMapImpl *impl;

    friend class Node;
    friend class DocumentType;
    friend class NodeImpl;
};

class NamedNodeMap;
class NodeList;
class Document;
class DOMString;
class StyleSheet;

class NodeImpl;

class KHTML_EXPORT Node
{
    friend class NamedNodeMap;
    friend class NodeList;
    friend class HTMLCollection;
    friend class StyleSheet;

public:
    Node() : impl(0) {}
    Node(const Node &other);

    Node( NodeImpl *_impl);

    Node & operator = (const Node &other);

    bool operator == (const Node &other) const;

    bool operator != (const Node &other) const;

    virtual ~Node();
    enum NodeType {
        ELEMENT_NODE = 1,
        ATTRIBUTE_NODE = 2,
        TEXT_NODE = 3,
        CDATA_SECTION_NODE = 4,
        ENTITY_REFERENCE_NODE = 5,
        ENTITY_NODE = 6,
        PROCESSING_INSTRUCTION_NODE = 7,
        COMMENT_NODE = 8,
        DOCUMENT_NODE = 9,
        DOCUMENT_TYPE_NODE = 10,
        DOCUMENT_FRAGMENT_NODE = 11,
        NOTATION_NODE = 12,
        XPATH_NAMESPACE_NODE = 13 //< Part of DOM L3 XPath, @since 4.5
    };

    DOMString nodeName() const;

    DOMString nodeValue() const;

    void setNodeValue( const DOMString & );

    unsigned short nodeType() const;

    Node parentNode() const;

    NodeList childNodes() const;

    Node firstChild() const;

    Node lastChild() const;

    Node previousSibling() const;

    Node nextSibling() const;

    NamedNodeMap attributes() const;

    Document ownerDocument() const;

    Node insertBefore ( const Node &newChild, const Node &refChild );

    Node replaceChild ( const Node &newChild, const Node &oldChild );

    Node removeChild ( const Node &oldChild );

    Node appendChild ( const Node &newChild );

    bool hasChildNodes (  );

    Node cloneNode ( bool deep );

    void normalize (  );

    bool isSupported( const DOMString &feature,
                      const DOMString &version ) const;

    DOMString namespaceURI(  ) const;

    DOMString prefix(  ) const;

    void setPrefix(const DOMString &prefix );

    DOMString localName(  ) const;

    bool hasAttributes (  );

    void addEventListener(const DOMString &type,
              EventListener *listener,
              const bool useCapture);

    void removeEventListener(const DOMString &type,
                 EventListener *listener,
                 bool useCapture);

    bool dispatchEvent(const Event &evt);

    DOMString textContent() const;

    void setTextContent(const DOMString& text);

    enum DocumentPosition {
    DOCUMENT_POSITION_DISCONNECTED = 0x01,
    DOCUMENT_POSITION_PRECEDING    = 0x02,
    DOCUMENT_POSITION_FOLLOWING    = 0x04,
    DOCUMENT_POSITION_CONTAINS     = 0x08,
    DOCUMENT_POSITION_CONTAINED_BY = 0x10,
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20
    };

    unsigned compareDocumentPosition(const DOM::Node& other);

    quint32 elementId() const;

    bool isNull() const { return !impl; }

    NodeImpl *handle() const { return impl; }

    unsigned long index() const;
#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QString toHTML();
#endif
    void applyChanges();
#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void getCursor(int offset, int &_x, int &_y, int &height);
#endif

    QRect getRect();

protected:
    NodeImpl *impl;
};


class NodeListImpl;

class KHTML_EXPORT NodeList
{
    friend class Element;
    friend class Node;
    friend class Document;
    friend class DocumentFragment;
    friend class HTMLDocument;
    friend class KJS::HTMLDocument;
    friend class KJS::Window;

public:
    NodeList();
    NodeList(const NodeList &other);

    NodeList & operator = (const NodeList &other);

    ~NodeList();

    unsigned long length() const;

    Node item ( unsigned long index ) const;

    NodeListImpl *handle() const { return impl; }
    bool isNull() const { return !impl; }

protected:
    NodeList(const NodeListImpl *i);
    NodeListImpl *impl;
};



typedef unsigned long long DOMTimeStamp;


} //namespace
#endif