DOM::Entity Class Reference

#include <dom_xml.h>

Inheritance diagram for DOM::Entity:

Public Member Functions
	Entity ()
	Entity (const Entity &other)
	Entity (const Node &other)
	~Entity ()
DOMString	notationName () const
Entity &	operator= (const Node &other)
Entity &	operator= (const Entity &other)
DOMString	publicId () const
DOMString	systemId () const
Public Member Functions inherited from DOM::Node
	Node ()
	Node (const Node &other)
	Node (NodeImpl *_impl)
virtual	~Node ()
void	addEventListener (const DOMString &type, EventListener *listener, const bool useCapture)
Node	appendChild (const Node &newChild)
void	applyChanges ()
NamedNodeMap	attributes () const
NodeList	childNodes () const
Node	cloneNode (bool deep)
unsigned	compareDocumentPosition (const DOM::Node &other)
bool	dispatchEvent (const Event &evt)
quint32	elementId () const
Node	firstChild () const
void	getCursor (int offset, int &_x, int &_y, int &height)
QRect	getRect ()
NodeImpl *	handle () const
bool	hasAttributes ()
bool	hasChildNodes ()
unsigned long	index () const
Node	insertBefore (const Node &newChild, const Node &refChild)
bool	isNull () const
bool	isSupported (const DOMString &feature, const DOMString &version) const
Node	lastChild () const
DOMString	localName () const
DOMString	namespaceURI () const
Node	nextSibling () const
DOMString	nodeName () const
unsigned short	nodeType () const
DOMString	nodeValue () const
void	normalize ()
bool	operator!= (const Node &other) const
Node &	operator= (const Node &other)
bool	operator== (const Node &other) const
Document	ownerDocument () const
Node	parentNode () const
DOMString	prefix () const
Node	previousSibling () const
Node	removeChild (const Node &oldChild)
void	removeEventListener (const DOMString &type, EventListener *listener, bool useCapture)
Node	replaceChild (const Node &newChild, const Node &oldChild)
void	setNodeValue (const DOMString &)
void	setPrefix (const DOMString &prefix)
void	setTextContent (const DOMString &text)
DOMString	textContent () const
QString	toHTML ()

Protected Member Functions
	Entity (EntityImpl *i)

Additional Inherited Members
Public Types inherited from DOM::Node
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 }
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 }
Protected Attributes inherited from DOM::Node
NodeImpl *	impl

Detailed Description

This interface represents an entity, either parsed or unparsed, in an XML document.

Note that this models the entity itself not the entity declaration. Entity declaration modeling has been left for a later Level of the DOM specification.

The nodeName attribute that is inherited from Node contains the name of the entity.

An XML processor may choose to completely expand entities before the structure model is passed to the DOM; in this case there will be no EntityReference nodes in the document tree.

XML does not mandate that a non-validating XML processor read and process entity declarations made in the external subset or declared in external parameter entities. This means that parsed entities declared in the external subset need not be expanded by some classes of applications, and that the replacement value of the entity may not be available. When the replacement value is available, the corresponding Entity node's child list represents the structure of that replacement text. Otherwise, the child list is empty.

The resolution of the children of the Entity (the replacement value) may be lazily evaluated; actions by the user (such as calling the childNodes method on the Entity Node) are assumed to trigger the evaluation.

The DOM Level 1 does not support editing Entity nodes; if a user wants to make changes to the contents of an Entity , every related EntityReference node has to be replaced in the structure model by a clone of the Entity 's contents, and then the desired changes must be made to each of those clones instead. All the descendants of an Entity node are readonly.

An Entity node does not have any parent.

Definition at line 124 of file dom_xml.h.

Constructor & Destructor Documentation

Entity::Entity

(

)

Definition at line 68 of file dom_xml.cpp.

Entity::Entity

(

const Entity &

other

)

Definition at line 72 of file dom_xml.cpp.

DOM::Entity::Entity ( const Node &  other )

inline

Definition at line 129 of file dom_xml.h.

Entity::~Entity

(

)

Definition at line 96 of file dom_xml.cpp.

Entity::Entity ( EntityImpl *  i )

protected

Definition at line 124 of file dom_xml.cpp.

Member Function Documentation

DOMString Entity::notationName

(

)

const

For unparsed entities, the name of the notation for the entity.

For parsed entities, this is null .

Definition at line 116 of file dom_xml.cpp.

Entity & Entity::operator=

(

const Node &

other

)

Definition at line 76 of file dom_xml.cpp.

Entity & Entity::operator=

(

const Entity &

other

)

Definition at line 90 of file dom_xml.cpp.

DOMString Entity::publicId

(

)

const

The public identifier associated with the entity, if specified.

If the public identifier was not specified, this is null .

Definition at line 100 of file dom_xml.cpp.

DOMString Entity::systemId

(

)

const

The system identifier associated with the entity, if specified.

If the system identifier was not specified, this is null .

Definition at line 108 of file dom_xml.cpp.

---

The documentation for this class was generated from the following files:

• dom_xml.h
• dom_xml.cpp