/*
* This file is part of the DOM implementation for KDE.
*
* (C) 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, 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.
*
* $Id: dom__node_h.html 132191 2002-01-17 21:32:13Z dfaure $
*/
#ifndef _DOM_Node_h_
#define _DOM_Node_h_
#include
class QRect;
namespace DOM {
class Node;
class DOMString;
class NodeImpl;
class NamedNodeMapImpl;
class EventListener;
class Event;
/**
* Objects implementing the NamedNodeMap interface are
* used to represent collections of nodes that can be accessed by
* name. Note that NamedNodeMap does not inherit from
* NodeList ; NamedNodeMap s are not
* maintained in any particular order. Objects contained in an object
* implementing NamedNodeMap may also be accessed by an
* ordinal index, but this is simply to allow convenient enumeration
* of the contents of a NamedNodeMap , and does not
* imply that the DOM specifies an order to these Nodes.
*
*/
class NamedNodeMap
{
public:
NamedNodeMap();
NamedNodeMap(const NamedNodeMap &other);
NamedNodeMap & operator = (const NamedNodeMap &other);
~NamedNodeMap();
/**
* The number of nodes in the map. The range of valid child node
* indices is 0 to length-1 inclusive.
*
*/
unsigned long length() const;
/**
* Retrieves a node specified by name.
*
* @param name Name of a node to retrieve.
*
* @return A Node (of any type) with the specified
* name, or null if the specified name did not
* identify any node in the map.
*
*/
Node getNamedItem ( const DOMString &name ) const;
/**
* Adds a node using its nodeName attribute.
*
* As the nodeName attribute is used to derive the
* name which the node must be stored under, multiple nodes of
* certain types (those that have a "special" string value) cannot
* be stored as the names would clash. This is seen as preferable
* to allowing nodes to be aliased.
*
* @param arg A node to store in a named node map. The node will
* later be accessible using the value of the nodeName
* attribute of the node. If a node with that name is
* already present in the map, it is replaced by the new one.
*
* @return If the new Node replaces an existing
* node with the same name the previously existing Node
* is returned, otherwise null is returned.
*
* @exception DOMException
* WRONG_DOCUMENT_ERR: Raised if arg was created
* from a different document than the one that created the
* NamedNodeMap .
*
* NO_MODIFICATION_ALLOWED_ERR: Raised if this
* NamedNodeMap is readonly.
*
* INUSE_ATTRIBUTE_ERR: Raised if arg is an
* Attr that is already an attribute of another
* Element object. The DOM user must explicitly clone
* Attr nodes to re-use them in other elements.
*
*/
Node setNamedItem ( const Node &arg );
/**
* Removes a node specified by name. If the removed node is an
* Attr with a default value it is immediately
* replaced.
*
* @param name The name of a node to remove.
*
* @return The node removed from the map or null if
* no node with such a name exists.
*
* @exception DOMException
* NOT_FOUND_ERR: Raised if there is no node named name
* in the map.
*
*/
Node removeNamedItem ( const DOMString &name );
/**
* Returns the index th item in the map. If
* index is greater than or equal to the number of nodes
* in the map, this returns null .
*
* @param index Index into the map.
*
* @return The node at the index th position in the
* NamedNodeMap , or null if that is
* not a valid index.
*
*/
Node item ( unsigned long index ) const;
/**
* @internal
* not part of the DOM
*/
NamedNodeMapImpl *handle() const;
bool isNull() const;
protected:
NamedNodeMap( NamedNodeMapImpl *i);
NamedNodeMapImpl *impl;
friend class Node;
friend class DocumentType;
};
class NamedNodeMap;
class NodeList;
class Document;
class DOMString;
class StyleSheet;
class NodeImpl;
/**
* The Node interface is the primary datatype for the
* entire Document Object Model. It represents a single node in the
* document tree. While all objects implementing the Node
* interface expose methods for dealing with children, not all
* objects implementing the Node interface may have
* children. For example, Text nodes may not have
* children, and adding children to such nodes results in a
* DOMException being raised.
*
* The attributes nodeName , nodeValue
* and attributes are included as a mechanism to get at
* node information without casting down to the specific derived
* interface. In cases where there is no obvious mapping of these
* attributes for a specific nodeType (e.g.,
* nodeValue for an Element or attributes for a
* Comment), this returns null . Note that the
* specialized interfaces may contain additional and more convenient
* mechanisms to get and set the relevant information.
*
*/
class Node
{
friend class NamedNodeMap;
friend class NodeList;
friend class HTMLCollection;
friend class StyleSheet;
public:
Node();
Node(const Node &other);
/**
* @internal
*/
Node( NodeImpl *_impl);
Node & operator = (const Node &other);
bool operator == (const Node &other);
bool operator != (const Node &other);
virtual ~Node();
/**
* An integer indicating which type of node this is.
*
*
* The values of nodeName, nodeValue,
* and attributes vary according to the node type as follows:
*
*
*
* |
* nodeName |
* nodeValue |
* attributes |
*
*
* | Element |
* tagName |
* null |
* NamedNodeMap |
*
*
* | Attr |
* name of attribute |
* value of attribute |
* null |
*
*
* | Text |
* #text |
* content of the text node |
* null |
*
*
* | CDATASection |
* #cdata-section |
* content of the CDATA Section |
* null |
*
*
* | EntityReference |
* name of entity referenced |
* null |
* null |
*
*
* | Entity |
* entity name |
* null |
* null |
*
*
* | ProcessingInstruction |
* target |
* entire content excluding the target |
* null |
*
*
* | Comment |
* #comment |
* content of the comment |
* null |
*
*
* | Document |
* #document |
* null |
* null |
*
*
* | DocumentType |
* document type name |
* null |
* null |
*
*
* | DocumentFragment |
* #document-fragment |
* null |
* null |
*
*
* | Notation |
* notation name |
* null |
* null |
*
*
*
*
*/
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
};
/**
* The name of this node, depending on its type; see the table
* above.
*
*/
DOMString nodeName() const;
/**
* The value of this node, depending on its type; see the table
* above.
*
* @exception DOMException
* DOMSTRING_SIZE_ERR: Raised when it would return more characters
* than fit in a DOMString variable on the
* implementation platform.
*
*/
DOMString nodeValue() const;
/**
* see @ref nodeValue
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
*
*/
void setNodeValue( const DOMString & );
/**
* A code representing the type of the underlying object, as
* defined above.
*
*/
unsigned short nodeType() const;
/**
* The parent of this node. All nodes, except Document
* , DocumentFragment , and Attr
* may have a parent. However, if a node has just been
* created and not yet added to the tree, or if it has been
* removed from the tree, this is null .
*
*/
Node parentNode() const;
/**
* A NodeList that contains all children of this
* node. If there are no children, this is a NodeList
* containing no nodes. The content of the returned
* NodeList is "live" in the sense that, for
* instance, changes to the children of the node object that it
* was created from are immediately reflected in the nodes
* returned by the NodeList accessors; it is not a
* static snapshot of the content of the node. This is true for
* every NodeList , including the ones returned by
* the getElementsByTagName method.
*
*/
NodeList childNodes() const;
/**
* The first child of this node. If there is no such node, this
* returns null .
*
*/
Node firstChild() const;
/**
* The last child of this node. If there is no such node, this
* returns null .
*
*/
Node lastChild() const;
/**
* The node immediately preceding this node. If there is no such
* node, this returns null .
*
*/
Node previousSibling() const;
/**
* The node immediately following this node. If there is no such
* node, this returns null .
*
*/
Node nextSibling() const;
/**
* A NamedNodeMap containing the attributes of this
* node (if it is an Element ) or null
* otherwise.
*
*/
NamedNodeMap attributes() const;
/**
* The Document object associated with this node.
* This is also the Document object used to create
* new nodes. When this node is a Document this is
* null .
*
*/
Document ownerDocument() const;
/**
* Inserts the node newChild before the existing
* child node refChild . If refChild
* is null , insert newChild at the
* end of the list of children.
*
* If newChild is a DocumentFragment
* object, all of its children are inserted, in the same
* order, before refChild . If the newChild
* is already in the tree, it is first removed.
*
* @param newChild The node to insert.
*
* @param refChild The reference node, i.e., the node before which
* the new node must be inserted.
*
* @return The node being inserted.
*
* @exception DOMException
* HIERARCHY_REQUEST_ERR: Raised if this node is of a type that
* does not allow children of the type of the newChild
* node, or if the node to insert is one of this node's
* ancestors.
*
* WRONG_DOCUMENT_ERR: Raised if newChild was
* created from a different document than the one that created
* this node.
*
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
* NOT_FOUND_ERR: Raised if refChild is not a
* child of this node.
*
*/
Node insertBefore ( const Node &newChild, const Node &refChild );
/**
* Replaces the child node oldChild with
* newChild in the list of children, and returns the
* oldChild node. If the newChild is
* already in the tree, it is first removed.
*
* @param newChild The new node to put in the child list.
*
* @param oldChild The node being replaced in the list.
*
* @return The node replaced.
*
* @exception DOMException
* HIERARCHY_REQUEST_ERR: Raised if this node is of a type that
* does not allow children of the type of the newChild
* node, or it the node to put in is one of this node's
* ancestors.
*
* WRONG_DOCUMENT_ERR: Raised if newChild was
* created from a different document than the one that created
* this node.
*
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
* NOT_FOUND_ERR: Raised if oldChild is not a
* child of this node.
*
*/
Node replaceChild ( const Node &newChild, const Node &oldChild );
/**
* Removes the child node indicated by oldChild
* from the list of children, and returns it.
*
* @param oldChild The node being removed.
*
* @return The node removed.
*
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
* NOT_FOUND_ERR: Raised if oldChild is not a
* child of this node.
*
*/
Node removeChild ( const Node &oldChild );
/**
* Adds the node newChild to the end of the list of
* children of this node. If the newChild is
* already in the tree, it is first removed.
*
* @param newChild The node to add.
*
* If it is a DocumentFragment object, the entire
* contents of the document fragment are moved into the child list
* of this node
*
* @return The node added.
*
* @exception DOMException
* HIERARCHY_REQUEST_ERR: Raised if this node is of a type that
* does not allow children of the type of the newChild
* node, or if the node to append is one of this node's
* ancestors.
*
* WRONG_DOCUMENT_ERR: Raised if newChild was
* created from a different document than the one that created
* this node.
*
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
*/
Node appendChild ( const Node &newChild );
/**
* This is a convenience method to allow easy determination of
* whether a node has any children.
*
* @return true if the node has any children,
* false if the node has no children.
*
*/
bool hasChildNodes ( );
/**
* Returns a duplicate of this node, i.e., serves as a generic
* copy constructor for nodes. The duplicate node has no parent (
* parentNode returns null .).
*
* Cloning an Element copies all attributes and
* their values, including those generated by the XML processor to
* represent defaulted attributes, but this method does not copy
* any text it contains unless it is a deep clone, since the text
* is contained in a child Text node. Cloning any
* other type of node simply returns a copy of this node.
*
* @param deep If true , recursively clone the
* subtree under the specified node; if false ,
* clone only the node itself (and its attributes, if it is an
* Element ).
*
* @return The duplicate node.
*
*/
Node cloneNode ( bool deep );
/**
* Introduced in DOM Level 2
* This method is from the EventTarget interface
*
* This method allows the registration of event listeners on the event
* target. If an EventListener is added to an EventTarget while it is
* processing an event, it will not be triggered by the current actions but
* may be triggered during a later stage of event flow, such as the
* bubbling phase.
*
* If multiple identical EventListeners are registered on the same
* EventTarget with the same parameters the duplicate instances are
* discarded. They do not cause the EventListener to be called twice and
* since they are discarded they do not need to be removed with the
* removeEventListener method. Parameters
*
* @param type The event type for which the user is registering
*
* @param listener The listener parameter takes an interface implemented by
* the user which contains the methods to be called when the event occurs.
*
* @param useCapture If true, useCapture indicates that the user wishes to
* initiate capture. After initiating capture, all events of the specified
* type will be dispatched to the registered EventListener before being
* dispatched to any EventTargets beneath them in the tree. Events which
* are bubbling upward through the tree will not trigger an EventListener
* designated to use capture.
*/
void addEventListener(const DOMString &type,
EventListener *listener,
const bool useCapture);
/**
* Introduced in DOM Level 2
* This method is from the EventTarget interface
*
* This method allows the removal of event listeners from the event target.
* If an EventListener is removed from an EventTarget while it is
* processing an event, it will not be triggered by the current actions.
*
* EventListeners can never be invoked after being removed.
*
* Calling removeEventListener with arguments which do not identify any
* currently registered EventListener on the EventTarget has no effect.
*
* @param type Specifies the event type of the EventListener being removed.
*
* @param listener The EventListener parameter indicates the EventListener
* to be removed.
*
* @param useCapture Specifies whether the EventListener being removed was
* registered as a capturing listener or not. If a listener was registered
* twice, one with capture and one without, each must be removed
* separately. Removal of a capturing listener does not affect a
* non-capturing version of the same listener, and vice versa.
*/
void removeEventListener(const DOMString &type,
EventListener *listener,
bool useCapture);
/**
* Introduced in DOM Level 2
* This method is from the EventTarget interface
*
* This method allows the dispatch of events into the implementations event
* model. Events dispatched in this manner will have the same capturing and
* bubbling behavior as events dispatched directly by the implementation.
* The target of the event is the EventTarget on which dispatchEvent is called.
*
* @param evt Specifies the event type, behavior, and contextual
* information to be used in processing the event.
*
* @return The return value of dispatchEvent indicates whether any of the
* listeners which handled the event called preventDefault. If
* preventDefault was called the value is false, else the value is true.Exceptions
*
* @exception EventException
* UNSPECIFIED_EVENT_TYPE_ERR: Raised if the Event's type was not specified
* by initializing the event before dispatchEvent was called. Specification
* of the Event's type as null or an empty string will also trigger this exception.
*/
bool dispatchEvent(const Event &evt);
/**
* @internal
* not part of the DOM.
* @returns the element id, in case this is an element, 0 otherwise
*/
unsigned short elementId() const;
/**
* tests if this Node is 0. Useful especially, if casting to a derived class:
*
*
* Node n = .....;
* // try to convert into an Element:
* Element e = n;
* if( e.isNull() )
* kdDebug(300) << "node isn't an element node" << endl;
*
*/
bool isNull() const;
/**
* @internal handle to the implementation object
*/
NodeImpl *handle() const;
/**
* @internal returns the index of a node
*/
unsigned long index() const;
QString toHTML();
void applyChanges();
void getCursor(int offset, int &_x, int &_y, int &height);
/**
* not part of the DOM.
* @returns the exact coordinates and size of this element.
*/
QRect getRect();
protected:
NodeImpl *impl;
};
class NodeListImpl;
/**
* The NodeList interface provides the abstraction of
* an ordered collection of nodes, without defining or constraining
* how this collection is implemented.
*
* The items in the NodeList are accessible via an
* integral index, starting from 0.
*
*/
class NodeList
{
friend class Element;
friend class Node;
friend class Document;
friend class HTMLDocument;
public:
NodeList();
NodeList(const NodeList &other);
NodeList & operator = (const NodeList &other);
~NodeList();
/**
* The number of nodes in the list. The range of valid child node
* indices is 0 to length-1 inclusive.
*
*/
unsigned long length() const;
/**
* Returns the index th item in the collection. If
* index is greater than or equal to the number of
* nodes in the list, this returns null .
*
* @param index Index into the collection.
*
* @return The node at the index th position in the
* NodeList , or null if that is not
* a valid index.
*
*/
Node item ( unsigned long index ) const;
/**
* @internal
* not part of the DOM
*/
NodeListImpl *handle() const;
bool isNull() const;
protected:
NodeList(const NodeListImpl *i);
NodeListImpl *impl;
};
/**
* A DOMTimeStamp represents a number of milliseconds.
*
*/
typedef unsigned long long DOMTimeStamp;
}; //namespace
#endif
| Generated by: dfaure on kde.faure.org on Thu Jan 17 22:18:15 2002, using kdoc 2.0a53. |