dom_doc.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_Document_h_
#define _DOM_Document_h_

#include <dom/dom_node.h>
#include <dom/css_stylesheet.h>

class KHTMLView;
class KHTMLPart;

namespace DOM {

class DOMString;
class DocumentType;
class NodeList;
class CDATASection;
class Comment;
class DocumentFragment;
class Text;
class DOMImplementation;
class Element;
class Attr;
class EntityReference;
class ProcessingInstruction;
class DocumentImpl;
class Range;
class NodeIterator;
class TreeWalker;
class NodeFilter;
class DOMImplementationImpl;
class DocumentTypeImpl;
class Event;
class AbstractView;
class CSSStyleDeclaration;
class HTMLElementImpl;
class HTMLFrameElement;
class HTMLElementImpl;
class HTMLIFrameElement;
class HTMLObjectElement;
class HTMLDocument;

class KHTML_EXPORT DOMImplementation
{
   friend class Document;
public:
    DOMImplementation();
    DOMImplementation(const DOMImplementation &other);

    DOMImplementation & operator = (const DOMImplementation &other);
    ~DOMImplementation();

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

    DocumentType createDocumentType ( const DOMString &qualifiedName,
                                      const DOMString &publicId,
                                      const DOMString &systemId );

    Document createDocument ( const DOMString &namespaceURI,
                              const DOMString &qualifiedName,
                              const DocumentType &doctype );

    DOMImplementation getInterface(const DOMString &feature) const;

    CSSStyleSheet createCSSStyleSheet(const DOMString &title, const DOMString &media);

    HTMLDocument createHTMLDocument(const DOMString& title);

    DOMImplementationImpl *handle() const;
    bool isNull() const;

protected:
    DOMImplementation(DOMImplementationImpl *i);
    DOMImplementationImpl *impl;
};

class KHTML_EXPORT Document : public Node
{
    friend class ::KHTMLView;
    friend class ::KHTMLPart;
    friend class AbstractView;
    friend class DOMImplementation;
    friend class HTMLFrameElement;
    friend class HTMLIFrameElement;
    friend class HTMLObjectElement;

public:
    Document();
    Document(bool);
    Document(const Document &other);
    Document(const Node &other) : Node()
         {(*this)=other;}

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

    ~Document();

    DocumentType doctype() const;

    DOMImplementation implementation() const;

    Element documentElement() const;

    Element createElement ( const DOMString &tagName );

    Element createElementNS( const DOMString &namespaceURI,
                             const DOMString &qualifiedName );

    DocumentFragment createDocumentFragment (  );

    Text createTextNode ( const DOMString &data );

    Comment createComment ( const DOMString &data );

    CDATASection createCDATASection ( const DOMString &data );

    ProcessingInstruction createProcessingInstruction ( const DOMString &target,
                                                        const DOMString &data );

    Attr createAttribute ( const DOMString &name );

    Attr createAttributeNS( const DOMString &namespaceURI,
                            const DOMString &qualifiedName );

    EntityReference createEntityReference ( const DOMString &name );

    Element getElementById ( const DOMString &elementId ) const;

    NodeList getElementsByTagName ( const DOMString &tagname );

    NodeList getElementsByTagNameNS( const DOMString &namespaceURI,
                                     const DOMString &localName );

    NodeList getElementsByClassName ( const DOMString &className );

    Node importNode( const Node & importedNode, bool deep );

    bool isHTMLDocument() const;

    Range createRange();

    NodeIterator createNodeIterator(Node root, unsigned long whatToShow,
                                    NodeFilter filter,
                                    bool entityReferenceExpansion);

    TreeWalker createTreeWalker(Node root, unsigned long whatToShow,
                                NodeFilter filter,
                                bool entityReferenceExpansion);

    Event createEvent(const DOMString &eventType);

    AbstractView defaultView() const;

    StyleSheetList styleSheets() const;

    DOMString preferredStylesheetSet();
    DOMString selectedStylesheetSet();
    void setSelectedStylesheetSet(const DOMString& aString);

    void addStyleSheet(const StyleSheet &sheet);
    
    void removeStyleSheet(const StyleSheet &sheet);
    
    KHTMLView *view() const;

    CSSStyleDeclaration getOverrideStyle(const Element &elt,
                                         const DOMString &pseudoElt);

    bool async() const;

    void setAsync( bool );


    void abort();

    void load( const DOMString &uri );

    void loadXML( const DOMString &source );

    Element querySelector(const DOMString& query) const;

    NodeList querySelectorAll(const DOMString& query) const;

    bool designMode() const;

    void setDesignMode(bool enable);

    DOMString completeURL(const DOMString& url);

    DOMString toString() const;
    

    bool execCommand(const DOMString &command, bool userInterface, const DOMString &value);
    bool queryCommandEnabled(const DOMString &command);
    bool queryCommandIndeterm(const DOMString &command);
    bool queryCommandState(const DOMString &command);
    bool queryCommandSupported(const DOMString &command);
    DOMString queryCommandValue(const DOMString &command);
    
    void updateRendering();

    Document( DocumentImpl *i);
protected:

    friend class Node;
};

class DocumentFragmentImpl;

class KHTML_EXPORT DocumentFragment : public Node
{
    friend class Document;
    friend class HTMLElementImpl;
    friend class Range;

public:
    DocumentFragment();
    DocumentFragment(const DocumentFragment &other);
    DocumentFragment(const Node &other) : Node()
         {(*this)=other;}

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

    ~DocumentFragment();

    Element querySelector(const DOMString& query) const;

    NodeList querySelectorAll(const DOMString& query) const;
protected:
    DocumentFragment(DocumentFragmentImpl *i);
};

class NamedNodeMap;
class DOMString;

class KHTML_EXPORT DocumentType : public Node
{
    friend class Document;
    friend class DOMImplementation;
public:
    DocumentType();
    DocumentType(const DocumentType &other);

    DocumentType(const Node &other) : Node()
         {(*this)=other;}
    DocumentType & operator = (const Node &other);
    DocumentType & operator = (const DocumentType &other);

    ~DocumentType();

    DOMString name() const;

    NamedNodeMap entities() const;

    NamedNodeMap notations() const;

    DOMString publicId() const;

    DOMString systemId() const;

    DOMString internalSubset() const;

protected:
    DocumentType(DocumentTypeImpl *impl);
};

} //namespace
#endif