<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Class Poco::XML::Document</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="language" content="en"/> <meta name="date" content="2009-11-24"/> <meta name="generator" content="PocoDoc"/> <link rel="stylesheet" href="css/styles.css" type="text/css"/> </head> <body bgcolor="#ffffff" leftmargin="0" topmargin="0"> <div class="header"> <h1 class="namespace"><a href="Poco.XML.html" class="namespace">Poco::XML</a></h1> <h1 class="symbol">class Document</h1> </div> <div class="body"> <p> <b>Library:</b> XML<br /> <b>Package:</b> DOM<br /> <b>Header:</b> Poco/DOM/Document.h</p> <h2>Description</h2> <div class="description"> <p>The <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> interface represents the entire HTML or <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data. </p> <p>Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a>, the <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> interface also contains the factory methods needed to create these objects. The <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> objects created have a ownerDocument attribute which associates them with the <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> within whose context they were created. </p> </div> <h2>Inheritance</h2> <p><b>Direct Base Classes: </b><a href="Poco.XML.AbstractContainerNode.html" title="class Poco::XML::AbstractContainerNode">AbstractContainerNode</a>, <a href="Poco.XML.DocumentEvent.html" title="class Poco::XML::DocumentEvent">DocumentEvent</a></p> <p><b>All Base Classes: </b><a href="Poco.XML.AbstractContainerNode.html" title="class Poco::XML::AbstractContainerNode">AbstractContainerNode</a>, <a href="Poco.XML.AbstractNode.html" title="class Poco::XML::AbstractNode">AbstractNode</a>, <a href="Poco.XML.DOMObject.html" title="class Poco::XML::DOMObject">DOMObject</a>, <a href="Poco.XML.DocumentEvent.html" title="class Poco::XML::DocumentEvent">DocumentEvent</a>, <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a>, <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a></p> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.XML.Document.html#18046" title="Poco::XML::Document::autoReleasePool()">autoReleasePool</a>, <a href="Poco.XML.Document.html#18047" title="Poco::XML::Document::collectGarbage()">collectGarbage</a>, <a href="Poco.XML.Document.html#18110" title="Poco::XML::Document::copyNode()">copyNode</a>, <a href="Poco.XML.Document.html#18067" title="Poco::XML::Document::createAttribute()">createAttribute</a>, <a href="Poco.XML.Document.html#18079" title="Poco::XML::Document::createAttributeNS()">createAttributeNS</a>, <a href="Poco.XML.Document.html#18062" title="Poco::XML::Document::createCDATASection()">createCDATASection</a>, <a href="Poco.XML.Document.html#18060" title="Poco::XML::Document::createComment()">createComment</a>, <a href="Poco.XML.Document.html#18057" title="Poco::XML::Document::createDocumentFragment()">createDocumentFragment</a>, <a href="Poco.XML.Document.html#18055" title="Poco::XML::Document::createElement()">createElement</a>, <a href="Poco.XML.Document.html#18076" title="Poco::XML::Document::createElementNS()">createElementNS</a>, <a href="Poco.XML.Document.html#18093" title="Poco::XML::Document::createEntity()">createEntity</a>, <a href="Poco.XML.Document.html#18069" title="Poco::XML::Document::createEntityReference()">createEntityReference</a>, <a href="Poco.XML.Document.html#18087" title="Poco::XML::Document::createEvent()">createEvent</a>, <a href="Poco.XML.Document.html#18098" title="Poco::XML::Document::createNotation()">createNotation</a>, <a href="Poco.XML.Document.html#18064" title="Poco::XML::Document::createProcessingInstruction()">createProcessingInstruction</a>, <a href="Poco.XML.Document.html#18058" title="Poco::XML::Document::createTextNode()">createTextNode</a>, <a href="Poco.XML.Document.html#18091" title="Poco::XML::Document::dispatchEvent()">dispatchEvent</a>, <a href="Poco.XML.Document.html#18052" title="Poco::XML::Document::doctype()">doctype</a>, <a href="Poco.XML.Document.html#18054" title="Poco::XML::Document::documentElement()">documentElement</a>, <a href="Poco.XML.Document.html#18051" title="Poco::XML::Document::events()">events</a>, <a href="Poco.XML.Document.html#18050" title="Poco::XML::Document::eventsSuspended()">eventsSuspended</a>, <a href="Poco.XML.Document.html#18113" title="Poco::XML::Document::getDoctype()">getDoctype</a>, <a href="Poco.XML.Document.html#18085" title="Poco::XML::Document::getElementById()">getElementById</a>, <a href="Poco.XML.Document.html#18105" title="Poco::XML::Document::getElementByIdNS()">getElementByIdNS</a>, <a href="Poco.XML.Document.html#18071" title="Poco::XML::Document::getElementsByTagName()">getElementsByTagName</a>, <a href="Poco.XML.Document.html#18082" title="Poco::XML::Document::getElementsByTagNameNS()">getElementsByTagNameNS</a>, <a href="Poco.XML.Document.html#18053" title="Poco::XML::Document::implementation()">implementation</a>, <a href="Poco.XML.Document.html#18073" title="Poco::XML::Document::importNode()">importNode</a>, <a href="Poco.XML.Document.html#18045" title="Poco::XML::Document::namePool()">namePool</a>, <a href="Poco.XML.Document.html#18089" title="Poco::XML::Document::nodeName()">nodeName</a>, <a href="Poco.XML.Document.html#18090" title="Poco::XML::Document::nodeType()">nodeType</a>, <a href="Poco.XML.Document.html#18049" title="Poco::XML::Document::resumeEvents()">resumeEvents</a>, <a href="Poco.XML.Document.html#18114" title="Poco::XML::Document::setDoctype()">setDoctype</a>, <a href="Poco.XML.Document.html#18048" title="Poco::XML::Document::suspendEvents()">suspendEvents</a></p> <p><b>Inherited Functions: </b><a href="Poco.XML.AbstractNode.html#17561" title="Poco::XML::AbstractNode::addEventListener()">addEventListener</a>, <a href="Poco.XML.AbstractContainerNode.html#17514" title="Poco::XML::AbstractContainerNode::appendChild()">appendChild</a>, <a href="Poco.XML.AbstractNode.html#17538" title="Poco::XML::AbstractNode::attributes()">attributes</a>, <a href="Poco.XML.AbstractNode.html#17572" title="Poco::XML::AbstractNode::autoRelease()">autoRelease</a>, <a href="Poco.XML.AbstractNode.html#17586" title="Poco::XML::AbstractNode::bubbleEvent()">bubbleEvent</a>, <a href="Poco.XML.AbstractNode.html#17584" title="Poco::XML::AbstractNode::captureEvent()">captureEvent</a>, <a href="Poco.XML.AbstractNode.html#17533" title="Poco::XML::AbstractNode::childNodes()">childNodes</a>, <a href="Poco.XML.AbstractNode.html#17551" title="Poco::XML::AbstractNode::cloneNode()">cloneNode</a>, <a href="Poco.XML.AbstractNode.html#17579" title="Poco::XML::AbstractNode::copyNode()">copyNode</a>, <a href="Poco.XML.DocumentEvent.html#18122" title="Poco::XML::DocumentEvent::createEvent()">createEvent</a>, <a href="Poco.XML.AbstractNode.html#17593" title="Poco::XML::AbstractNode::dispatchAttrModified()">dispatchAttrModified</a>, <a href="Poco.XML.AbstractNode.html#17598" title="Poco::XML::AbstractNode::dispatchCharacterDataModified()">dispatchCharacterDataModified</a>, <a href="Poco.XML.AbstractNode.html#17569" title="Poco::XML::AbstractNode::dispatchEvent()">dispatchEvent</a>, <a href="Poco.XML.AbstractNode.html#17589" title="Poco::XML::AbstractNode::dispatchNodeInserted()">dispatchNodeInserted</a>, <a href="Poco.XML.AbstractContainerNode.html#17525" title="Poco::XML::AbstractContainerNode::dispatchNodeInsertedIntoDocument()">dispatchNodeInsertedIntoDocument</a>, <a href="Poco.XML.AbstractNode.html#17590" title="Poco::XML::AbstractNode::dispatchNodeRemoved()">dispatchNodeRemoved</a>, <a href="Poco.XML.AbstractContainerNode.html#17524" title="Poco::XML::AbstractContainerNode::dispatchNodeRemovedFromDocument()">dispatchNodeRemovedFromDocument</a>, <a href="Poco.XML.AbstractNode.html#17588" title="Poco::XML::AbstractNode::dispatchSubtreeModified()">dispatchSubtreeModified</a>, <a href="Poco.XML.DOMObject.html#17881" title="Poco::XML::DOMObject::duplicate()">duplicate</a>, <a href="Poco.XML.AbstractNode.html#17582" title="Poco::XML::AbstractNode::events()">events</a>, <a href="Poco.XML.AbstractNode.html#17583" title="Poco::XML::AbstractNode::eventsSuspended()">eventsSuspended</a>, <a href="Poco.XML.AbstractContainerNode.html#17504" title="Poco::XML::AbstractContainerNode::firstChild()">firstChild</a>, <a href="Poco.XML.AbstractNode.html#17529" title="Poco::XML::AbstractNode::getNodeValue()">getNodeValue</a>, <a href="Poco.XML.AbstractContainerNode.html#17517" title="Poco::XML::AbstractContainerNode::hasAttributes()">hasAttributes</a>, <a href="Poco.XML.AbstractContainerNode.html#17516" title="Poco::XML::AbstractContainerNode::hasChildNodes()">hasChildNodes</a>, <a href="Poco.XML.AbstractNode.html#17571" title="Poco::XML::AbstractNode::innerText()">innerText</a>, <a href="Poco.XML.AbstractContainerNode.html#17506" title="Poco::XML::AbstractContainerNode::insertBefore()">insertBefore</a>, <a href="Poco.XML.AbstractNode.html#17554" title="Poco::XML::AbstractNode::isSupported()">isSupported</a>, <a href="Poco.XML.AbstractContainerNode.html#17505" title="Poco::XML::AbstractContainerNode::lastChild()">lastChild</a>, <a href="Poco.XML.AbstractNode.html#17559" title="Poco::XML::AbstractNode::localName()">localName</a>, <a href="Poco.XML.AbstractNode.html#17557" title="Poco::XML::AbstractNode::namespaceURI()">namespaceURI</a>, <a href="Poco.XML.AbstractNode.html#17537" title="Poco::XML::AbstractNode::nextSibling()">nextSibling</a>, <a href="Poco.XML.AbstractNode.html#17528" title="Poco::XML::AbstractNode::nodeName()">nodeName</a>, <a href="Poco.XML.Node.html#18504" title="Poco::XML::Node::nodeType()">nodeType</a>, <a href="Poco.XML.Node.html#18500" title="Poco::XML::Node::nodeValue()">nodeValue</a>, <a href="Poco.XML.AbstractNode.html#17553" title="Poco::XML::AbstractNode::normalize()">normalize</a>, <a href="Poco.XML.AbstractNode.html#17539" title="Poco::XML::AbstractNode::ownerDocument()">ownerDocument</a>, <a href="Poco.XML.AbstractNode.html#17532" title="Poco::XML::AbstractNode::parentNode()">parentNode</a>, <a href="Poco.XML.AbstractNode.html#17558" title="Poco::XML::AbstractNode::prefix()">prefix</a>, <a href="Poco.XML.AbstractNode.html#17536" title="Poco::XML::AbstractNode::previousSibling()">previousSibling</a>, <a href="Poco.XML.DOMObject.html#17882" title="Poco::XML::DOMObject::release()">release</a>, <a href="Poco.XML.AbstractContainerNode.html#17512" title="Poco::XML::AbstractContainerNode::removeChild()">removeChild</a>, <a href="Poco.XML.AbstractNode.html#17565" title="Poco::XML::AbstractNode::removeEventListener()">removeEventListener</a>, <a href="Poco.XML.AbstractContainerNode.html#17509" title="Poco::XML::AbstractContainerNode::replaceChild()">replaceChild</a>, <a href="Poco.XML.AbstractNode.html#17530" title="Poco::XML::AbstractNode::setNodeValue()">setNodeValue</a>, <a href="Poco.XML.AbstractNode.html#17601" title="Poco::XML::AbstractNode::setOwnerDocument()">setOwnerDocument</a></p> <h2>Types</h2> <h3><a name="18039">AutoReleasePool</a></h3> <p class="decl">typedef <a href="Poco.AutoReleasePool.html" title="class Poco::AutoReleasePool">Poco::AutoReleasePool</a> < <a href="Poco.XML.DOMObject.html" title="class Poco::XML::DOMObject">DOMObject</a> > <a href="Poco.XML.Document.html#18039" title="Poco::XML::Document::AutoReleasePool">AutoReleasePool</a>;</p> <div class="description"> <p></p> </div> <h2>Constructors</h2> <h3><a name="18040">Document</a></h3> <p class="decl"><a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a>(<br /> <a href="Poco.XML.NamePool.html" title="class Poco::XML::NamePool">NamePool</a> * pNamePool = 0<br />);</p> <div class="description"> <p>Creates a new document. If pNamePool == 0, the document creates its own name pool, otherwise it uses the given name pool. Sharing a name pool makes sense for documents containing instances of the same schema, thus reducing memory usage. </p> </div> <h3><a name="18042">Document</a></h3> <p class="decl"><a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a>(<br /> <a href="Poco.XML.DocumentType.html" title="class Poco::XML::DocumentType">DocumentType</a> * pDocumentType,<br /> <a href="Poco.XML.NamePool.html" title="class Poco::XML::NamePool">NamePool</a> * pNamePool = 0<br />);</p> <div class="description"> <p>Creates a new document. If pNamePool == 0, the document creates its own name pool, otherwise it uses the given name pool. Sharing a name pool makes sense for documents containing instances of the same schema, thus reducing memory usage. </p> </div> <h2>Destructor</h2> <h3><a name="18109">~Document</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">~<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a>();</p> <div class="description"> <p></p> </div> <h2>Member Functions</h2> <h3><a name="18046">autoReleasePool</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.Document.html#18039" title="Poco::XML::Document::AutoReleasePool">AutoReleasePool</a> & autoReleasePool();</p> <div class="description"> <p>Returns a pointer to the documents Auto Release Pool. </p> </div> <h3><a name="18047">collectGarbage</a></h3> <p class="decl">void collectGarbage();</p> <div class="description"> <p>Releases all objects in the Auto Release Pool. </p> </div> <h3><a name="18067">createAttribute</a></h3> <p class="decl"><a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> * createAttribute(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name<br />) const;</p> <div class="description"> <p>Creates an <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> of the given name. Note that the <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> instance can then be set on an <a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> using the setAttributeNode method. </p> </div> <h3><a name="18079">createAttributeNS</a></h3> <p class="decl"><a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> * createAttributeNS(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & namespaceURI,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qualifiedName<br />) const;</p> <div class="description"> <p>Creates an attribute of the given qualified name and namespace <a href="Poco.URI.html" title="class Poco::URI">URI</a>. </p> </div> <h3><a name="18062">createCDATASection</a></h3> <p class="decl"><a href="Poco.XML.CDATASection.html" title="class Poco::XML::CDATASection">CDATASection</a> * createCDATASection(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & data<br />) const;</p> <div class="description"> <p>Creates a <a href="Poco.XML.CDATASection.html" title="class Poco::XML::CDATASection">CDATASection</a> node whose value is the specified string. </p> </div> <h3><a name="18060">createComment</a></h3> <p class="decl"><a href="Poco.XML.Comment.html" title="class Poco::XML::Comment">Comment</a> * createComment(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & data<br />) const;</p> <div class="description"> <p>Creates a comment node given the specified string. </p> </div> <h3><a name="18057">createDocumentFragment</a></h3> <p class="decl"><a href="Poco.XML.DocumentFragment.html" title="class Poco::XML::DocumentFragment">DocumentFragment</a> * createDocumentFragment() const;</p> <div class="description"> <p>Creates an empty <a href="Poco.XML.DocumentFragment.html" title="class Poco::XML::DocumentFragment">DocumentFragment</a> object. </p> </div> <h3><a name="18055">createElement</a></h3> <p class="decl"><a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> * createElement(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & tagName<br />) const;</p> <div class="description"> <p>Creates an element of the type specified. Note that the instance returned implements the <a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> interface, so attributes can be specified directly on the returned object. </p> <p>In addition, if there are known attributes with default values, <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> nodes representing them are automatically created and attached to the element. </p> </div> <h3><a name="18076">createElementNS</a></h3> <p class="decl"><a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> * createElementNS(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & namespaceURI,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qualifiedName<br />) const;</p> <div class="description"> <p>Creates an element of the given qualified name and namespace <a href="Poco.URI.html" title="class Poco::URI">URI</a>. </p> </div> <h3><a name="18093">createEntity</a></h3> <p class="decl"><a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> * createEntity(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & publicId,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & systemId,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & notationName<br />) const;</p> <div class="description"> <p>Creates an <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> with the given name, publicId, systemId and notationName. </p> <p>This method is not part of the W3C <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> Object Model. </p> </div> <h3><a name="18069">createEntityReference</a></h3> <p class="decl"><a href="Poco.XML.EntityReference.html" title="class Poco::XML::EntityReference">EntityReference</a> * createEntityReference(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name<br />) const;</p> <div class="description"> <p>Creates an <a href="Poco.XML.EntityReference.html" title="class Poco::XML::EntityReference">EntityReference</a> object. In addition, if the referenced entity is known, the child list of the <a href="Poco.XML.EntityReference.html" title="class Poco::XML::EntityReference">EntityReference</a> node is made the same as that of the corresponding <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a> node. </p> </div> <h3><a name="18087">createEvent</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> * createEvent(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & eventType<br />) const;</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.DocumentEvent.html#18122" title="Poco::XML::DocumentEvent::createEvent()">Poco::XML::DocumentEvent::createEvent()</a></p></div> <h3><a name="18098">createNotation</a></h3> <p class="decl"><a href="Poco.XML.Notation.html" title="class Poco::XML::Notation">Notation</a> * createNotation(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & publicId,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & systemId<br />) const;</p> <div class="description"> <p>Creates a <a href="Poco.XML.Notation.html" title="class Poco::XML::Notation">Notation</a> with the given name, publicId and systemId. </p> <p>This method is not part of the W3C <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> Object Model. </p> </div> <h3><a name="18064">createProcessingInstruction</a></h3> <p class="decl"><a href="Poco.XML.ProcessingInstruction.html" title="class Poco::XML::ProcessingInstruction">ProcessingInstruction</a> * createProcessingInstruction(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & target,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & data<br />) const;</p> <div class="description"> <p>Creates a <a href="Poco.XML.ProcessingInstruction.html" title="class Poco::XML::ProcessingInstruction">ProcessingInstruction</a> node given the specified target and data strings. </p> </div> <h3><a name="18058">createTextNode</a></h3> <p class="decl"><a href="Poco.XML.Text.html" title="class Poco::XML::Text">Text</a> * createTextNode(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & data<br />) const;</p> <div class="description"> <p>Creates a text node given the specified string. </p> </div> <h3><a name="18091">dispatchEvent</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool dispatchEvent(<br /> <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> * evt<br />);</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17569" title="Poco::XML::AbstractNode::dispatchEvent()">Poco::XML::AbstractNode::dispatchEvent()</a></p></div> <h3><a name="18052">doctype</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">const <a href="Poco.XML.DocumentType.html" title="class Poco::XML::DocumentType">DocumentType</a> * doctype() const;</p> <div class="description"> <p>The <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> Type Declaration (see <a href="Poco.XML.DocumentType.html" title="class Poco::XML::DocumentType">DocumentType</a>) associated with this document. For HTML documents as well as <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> documents without a document type declaration this returns null. The DOM Level 1 does not support editing the <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> Type Declaration. docType cannot be altered in any way, including through the use of methods inherited from the <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> interface, such as insertNode or removeNode. </p> </div> <h3><a name="18054">documentElement</a></h3> <p class="decl"><a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> * documentElement() const;</p> <div class="description"> <p>This is a convenience attribute that allows direct access to the child node that is the root element of the document. For HTML documents, this is the element with the tagName "HTML". </p> </div> <h3><a name="18051">events</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool events() const;</p> <div class="description"> <p>Returns true if events are not suspeded. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17582" title="Poco::XML::AbstractNode::events()">Poco::XML::AbstractNode::events()</a></p></div> <h3><a name="18050">eventsSuspended</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool eventsSuspended() const;</p> <div class="description"> <p>Returns true if events are suspeded. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17583" title="Poco::XML::AbstractNode::eventsSuspended()">Poco::XML::AbstractNode::eventsSuspended()</a></p></div> <h3><a name="18085">getElementById</a></h3> <p class="decl"><a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> * getElementById(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & elementId<br />) const;</p> <div class="description"> <p>Returns the <a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> whose ID is given by elementId. If no such element exists, returns null. Behavior is not defined if more than one element has this ID. </p> <p>Note: The DOM implementation must have information that says which attributes are of type ID. <a href="Poco.XML.Attributes.html" title="class Poco::XML::Attributes">Attributes</a> with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null. This implementation therefore returns null. </p> <p>See also the non-standard two argument variant of <a href="Poco.XML.Document.html#18085" title="Poco::XML::Document::getElementById()">getElementById</a>() and <a href="Poco.XML.Document.html#18105" title="Poco::XML::Document::getElementByIdNS()">getElementByIdNS</a>(). </p> </div> <h3><a name="18102">getElementById</a></h3> <p class="decl"><a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> * getElementById(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & elementId,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & idAttribute<br />) const;</p> <div class="description"> <p>Returns the first <a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> whose ID attribute (given in idAttribute) has the given elementId. If no such element exists, returns null. </p> <p>This method is an extension to the W3C <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> Object Model. </p> </div> <h3><a name="18105">getElementByIdNS</a></h3> <p class="decl"><a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> * getElementByIdNS(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & elementId,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & idAttributeURI,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & idAttributeLocalName<br />) const;</p> <div class="description"> <p>Returns the first <a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a> whose ID attribute (given in idAttributeURI and idAttributeLocalName) has the given elementId. If no such element exists, returns null. </p> <p>This method is an extension to the W3C <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> Object Model. </p> </div> <h3><a name="18071">getElementsByTagName</a></h3> <p class="decl"><a href="Poco.XML.NodeList.html" title="class Poco::XML::NodeList">NodeList</a> * getElementsByTagName(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name<br />) const;</p> <div class="description"> <p>Returns a <a href="Poco.XML.NodeList.html" title="class Poco::XML::NodeList">NodeList</a> of all Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the document tree. </p> <p>The returned <a href="Poco.XML.NodeList.html" title="class Poco::XML::NodeList">NodeList</a> must be released with a call to release() when no longer needed. </p> </div> <h3><a name="18082">getElementsByTagNameNS</a></h3> <p class="decl"><a href="Poco.XML.NodeList.html" title="class Poco::XML::NodeList">NodeList</a> * getElementsByTagNameNS(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & namespaceURI,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & localName<br />) const;</p> <div class="description"> <p>Returns a <a href="Poco.XML.NodeList.html" title="class Poco::XML::NodeList">NodeList</a> of all the Elements with a given local name and namespace <a href="Poco.URI.html" title="class Poco::URI">URI</a> in the order in which they are encountered in a preorder traversal of the <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> tree. </p> </div> <h3><a name="18053">implementation</a></h3> <p class="decl">const <a href="Poco.XML.DOMImplementation.html" title="class Poco::XML::DOMImplementation">DOMImplementation</a> & implementation() const;</p> <div class="description"> <p>The <a href="Poco.XML.DOMImplementation.html" title="class Poco::XML::DOMImplementation">DOMImplementation</a> object that handles this document. A DOM application may use objects from multiple implementations. </p> </div> <h3><a name="18073">importNode</a></h3> <p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * importNode(<br /> <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * importedNode,<br /> bool deep<br />);</p> <div class="description"> <p>Imports a node from another document to this document. The returned node has no parent; (parentNode is null). The source node is not altered or removed from the original document; this method creates a new copy of the source node. For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's nodeName and nodeType, plus the attributes related to namespaces (prefix, localName, and namespaceURI). As in the cloneNode operation on a <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a>, the source node is not altered. Additional information is copied as appropriate to the nodeType, attempting to mirror the behavior expected if a fragment of <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> case. </p> </div> <h3><a name="18045">namePool</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.NamePool.html" title="class Poco::XML::NamePool">NamePool</a> & namePool();</p> <div class="description"> <p>Returns a pointer to the documents <a href="Poco.XML.Name.html" title="class Poco::XML::Name">Name</a> Pool. </p> </div> <h3><a name="18089">nodeName</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & nodeName() const;</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17528" title="Poco::XML::AbstractNode::nodeName()">Poco::XML::AbstractNode::nodeName()</a></p></div> <h3><a name="18090">nodeType</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">unsigned short nodeType() const;</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.Node.html#18504" title="Poco::XML::Node::nodeType()">Poco::XML::Node::nodeType()</a></p></div> <h3><a name="18049">resumeEvents</a></h3> <p class="decl">void resumeEvents();</p> <div class="description"> <p>Resumes all events suspended with suspendEvent(); </p> </div> <h3><a name="18048">suspendEvents</a></h3> <p class="decl">void suspendEvents();</p> <div class="description"> <p>Suspends all events until <a href="Poco.XML.Document.html#18049" title="Poco::XML::Document::resumeEvents()">resumeEvents</a>() is called. </p> </div> <h3><a name="18110">copyNode</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * copyNode(<br /> bool deep,<br /> <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument<br />) const;</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17579" title="Poco::XML::AbstractNode::copyNode()">Poco::XML::AbstractNode::copyNode()</a></p></div> <h3><a name="18113">getDoctype</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.DocumentType.html" title="class Poco::XML::DocumentType">DocumentType</a> * getDoctype();</p> <div class="description"> <p></p> </div> <h3><a name="18114">setDoctype</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setDoctype(<br /> <a href="Poco.XML.DocumentType.html" title="class Poco::XML::DocumentType">DocumentType</a> * pDoctype<br />);</p> <div class="description"> <p></p> </div> <p class="footer">POCO C++ Libraries 1.3.6-all<br /> Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
