<!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::XMLWriter</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 XMLWriter</h1> </div> <div class="body"> <p> <b>Library:</b> XML<br /> <b>Package:</b> XML<br /> <b>Header:</b> Poco/XML/XMLWriter.h</p> <h2>Description</h2> <div class="description"> <p>This class serializes SAX2 <a href="Poco.XML.ContentHandler.html" title="class Poco::XML::ContentHandler">ContentHandler</a>, <a href="Poco.XML.LexicalHandler.html" title="class Poco::XML::LexicalHandler">LexicalHandler</a> and <a href="Poco.XML.DTDHandler.html" title="class Poco::XML::DTDHandler">DTDHandler</a> events back into a stream. </p> <p>Various consistency checks are performed on the written data (i.e. there must be exactly one root element and every <a href="Poco.XML.XMLWriter.html#19874" title="Poco::XML::XMLWriter::startElement()">startElement</a>() must have a matching <a href="Poco.XML.XMLWriter.html#19883" title="Poco::XML::XMLWriter::endElement()">endElement</a>()). </p> <p>The <a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a> supports optional pretty-printing of the serialized <a href="Poco.XML.html" title="namespace Poco::XML">XML</a>. Note, however, that pretty-printing <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> data alters the information set of the document being written, since in <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> all whitespace is potentially relevant to an application. </p> <p>The writer contains extensive support for <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> Namespaces, so that a client application does not have to keep track of prefixes and supply xmlns attributes. </p> <p>If the client does not provide namespace prefixes (either by specifying them as part of the qualified name given to <a href="Poco.XML.XMLWriter.html#19874" title="Poco::XML::XMLWriter::startElement()">startElement</a>(), or by calling <a href="Poco.XML.XMLWriter.html#19911" title="Poco::XML::XMLWriter::startPrefixMapping()">startPrefixMapping</a>()), the <a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a> automatically generates namespace prefixes in the form ns1, ns2, etc. </p> </div> <h2>Inheritance</h2> <p><b>Direct Base Classes: </b><a href="Poco.XML.ContentHandler.html" title="class Poco::XML::ContentHandler">ContentHandler</a>, <a href="Poco.XML.LexicalHandler.html" title="class Poco::XML::LexicalHandler">LexicalHandler</a>, <a href="Poco.XML.DTDHandler.html" title="class Poco::XML::DTDHandler">DTDHandler</a></p> <p><b>All Base Classes: </b><a href="Poco.XML.ContentHandler.html" title="class Poco::XML::ContentHandler">ContentHandler</a>, <a href="Poco.XML.DTDHandler.html" title="class Poco::XML::DTDHandler">DTDHandler</a>, <a href="Poco.XML.LexicalHandler.html" title="class Poco::XML::LexicalHandler">LexicalHandler</a></p> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.XML.XMLWriter.html#19984" title="Poco::XML::XMLWriter::addAttributes()">addAttributes</a>, <a href="Poco.XML.XMLWriter.html#19982" title="Poco::XML::XMLWriter::addNamespaceAttributes()">addNamespaceAttributes</a>, <a href="Poco.XML.XMLWriter.html#19896" title="Poco::XML::XMLWriter::characters()">characters</a>, <a href="Poco.XML.XMLWriter.html#19979" title="Poco::XML::XMLWriter::closeStartTag()">closeStartTag</a>, <a href="Poco.XML.XMLWriter.html#19931" title="Poco::XML::XMLWriter::comment()">comment</a>, <a href="Poco.XML.XMLWriter.html#19918" title="Poco::XML::XMLWriter::dataElement()">dataElement</a>, <a href="Poco.XML.XMLWriter.html#19980" title="Poco::XML::XMLWriter::declareAttributeNamespaces()">declareAttributeNamespaces</a>, <a href="Poco.XML.XMLWriter.html#19887" title="Poco::XML::XMLWriter::emptyElement()">emptyElement</a>, <a href="Poco.XML.XMLWriter.html#19930" title="Poco::XML::XMLWriter::endCDATA()">endCDATA</a>, <a href="Poco.XML.XMLWriter.html#19939" title="Poco::XML::XMLWriter::endDTD()">endDTD</a>, <a href="Poco.XML.XMLWriter.html#19871" title="Poco::XML::XMLWriter::endDocument()">endDocument</a>, <a href="Poco.XML.XMLWriter.html#19883" title="Poco::XML::XMLWriter::endElement()">endElement</a>, <a href="Poco.XML.XMLWriter.html#19942" title="Poco::XML::XMLWriter::endEntity()">endEntity</a>, <a href="Poco.XML.XMLWriter.html#19873" title="Poco::XML::XMLWriter::endFragment()">endFragment</a>, <a href="Poco.XML.XMLWriter.html#19914" title="Poco::XML::XMLWriter::endPrefixMapping()">endPrefixMapping</a>, <a href="Poco.XML.XMLWriter.html#19867" title="Poco::XML::XMLWriter::getNewLine()">getNewLine</a>, <a href="Poco.XML.XMLWriter.html#19904" title="Poco::XML::XMLWriter::ignorableWhitespace()">ignorableWhitespace</a>, <a href="Poco.XML.XMLWriter.html#19992" title="Poco::XML::XMLWriter::nameToString()">nameToString</a>, <a href="Poco.XML.XMLWriter.html#19991" title="Poco::XML::XMLWriter::newPrefix()">newPrefix</a>, <a href="Poco.XML.XMLWriter.html#19944" title="Poco::XML::XMLWriter::notationDecl()">notationDecl</a>, <a href="Poco.XML.XMLWriter.html#19990" title="Poco::XML::XMLWriter::prettyPrint()">prettyPrint</a>, <a href="Poco.XML.XMLWriter.html#19908" title="Poco::XML::XMLWriter::processingInstruction()">processingInstruction</a>, <a href="Poco.XML.XMLWriter.html#19902" title="Poco::XML::XMLWriter::rawCharacters()">rawCharacters</a>, <a href="Poco.XML.XMLWriter.html#19868" title="Poco::XML::XMLWriter::setDocumentLocator()">setDocumentLocator</a>, <a href="Poco.XML.XMLWriter.html#19865" title="Poco::XML::XMLWriter::setNewLine()">setNewLine</a>, <a href="Poco.XML.XMLWriter.html#19916" title="Poco::XML::XMLWriter::skippedEntity()">skippedEntity</a>, <a href="Poco.XML.XMLWriter.html#19929" title="Poco::XML::XMLWriter::startCDATA()">startCDATA</a>, <a href="Poco.XML.XMLWriter.html#19935" title="Poco::XML::XMLWriter::startDTD()">startDTD</a>, <a href="Poco.XML.XMLWriter.html#19870" title="Poco::XML::XMLWriter::startDocument()">startDocument</a>, <a href="Poco.XML.XMLWriter.html#19874" title="Poco::XML::XMLWriter::startElement()">startElement</a>, <a href="Poco.XML.XMLWriter.html#19940" title="Poco::XML::XMLWriter::startEntity()">startEntity</a>, <a href="Poco.XML.XMLWriter.html#19872" title="Poco::XML::XMLWriter::startFragment()">startFragment</a>, <a href="Poco.XML.XMLWriter.html#19911" title="Poco::XML::XMLWriter::startPrefixMapping()">startPrefixMapping</a>, <a href="Poco.XML.XMLWriter.html#19948" title="Poco::XML::XMLWriter::unparsedEntityDecl()">unparsedEntityDecl</a>, <a href="Poco.XML.XMLWriter.html#19988" title="Poco::XML::XMLWriter::writeAttributes()">writeAttributes</a>, <a href="Poco.XML.XMLWriter.html#19963" title="Poco::XML::XMLWriter::writeEndElement()">writeEndElement</a>, <a href="Poco.XML.XMLWriter.html#19974" title="Poco::XML::XMLWriter::writeIndent()">writeIndent</a>, <a href="Poco.XML.XMLWriter.html#19967" title="Poco::XML::XMLWriter::writeMarkup()">writeMarkup</a>, <a href="Poco.XML.XMLWriter.html#19975" title="Poco::XML::XMLWriter::writeName()">writeName</a>, <a href="Poco.XML.XMLWriter.html#19973" title="Poco::XML::XMLWriter::writeNewLine()">writeNewLine</a>, <a href="Poco.XML.XMLWriter.html#19958" title="Poco::XML::XMLWriter::writeStartElement()">writeStartElement</a>, <a href="Poco.XML.XMLWriter.html#19969" title="Poco::XML::XMLWriter::writeXML()">writeXML</a>, <a href="Poco.XML.XMLWriter.html#19978" title="Poco::XML::XMLWriter::writeXMLDeclaration()">writeXMLDeclaration</a></p> <p><b>Inherited Functions: </b><a href="Poco.XML.ContentHandler.html#18865" title="Poco::XML::ContentHandler::characters()">characters</a>, <a href="Poco.XML.LexicalHandler.html#19037" title="Poco::XML::LexicalHandler::comment()">comment</a>, <a href="Poco.XML.LexicalHandler.html#19036" title="Poco::XML::LexicalHandler::endCDATA()">endCDATA</a>, <a href="Poco.XML.LexicalHandler.html#19030" title="Poco::XML::LexicalHandler::endDTD()">endDTD</a>, <a href="Poco.XML.ContentHandler.html#18855" title="Poco::XML::ContentHandler::endDocument()">endDocument</a>, <a href="Poco.XML.ContentHandler.html#18861" title="Poco::XML::ContentHandler::endElement()">endElement</a>, <a href="Poco.XML.LexicalHandler.html#19033" title="Poco::XML::LexicalHandler::endEntity()">endEntity</a>, <a href="Poco.XML.ContentHandler.html#18879" title="Poco::XML::ContentHandler::endPrefixMapping()">endPrefixMapping</a>, <a href="Poco.XML.ContentHandler.html#18869" title="Poco::XML::ContentHandler::ignorableWhitespace()">ignorableWhitespace</a>, <a href="Poco.XML.DTDHandler.html#18885" title="Poco::XML::DTDHandler::notationDecl()">notationDecl</a>, <a href="Poco.XML.ContentHandler.html#18873" title="Poco::XML::ContentHandler::processingInstruction()">processingInstruction</a>, <a href="Poco.XML.ContentHandler.html#18852" title="Poco::XML::ContentHandler::setDocumentLocator()">setDocumentLocator</a>, <a href="Poco.XML.ContentHandler.html#18881" title="Poco::XML::ContentHandler::skippedEntity()">skippedEntity</a>, <a href="Poco.XML.LexicalHandler.html#19035" title="Poco::XML::LexicalHandler::startCDATA()">startCDATA</a>, <a href="Poco.XML.LexicalHandler.html#19026" title="Poco::XML::LexicalHandler::startDTD()">startDTD</a>, <a href="Poco.XML.ContentHandler.html#18854" title="Poco::XML::ContentHandler::startDocument()">startDocument</a>, <a href="Poco.XML.ContentHandler.html#18856" title="Poco::XML::ContentHandler::startElement()">startElement</a>, <a href="Poco.XML.LexicalHandler.html#19031" title="Poco::XML::LexicalHandler::startEntity()">startEntity</a>, <a href="Poco.XML.ContentHandler.html#18876" title="Poco::XML::ContentHandler::startPrefixMapping()">startPrefixMapping</a>, <a href="Poco.XML.DTDHandler.html#18889" title="Poco::XML::DTDHandler::unparsedEntityDecl()">unparsedEntityDecl</a></p> <h2>Types</h2> <h3><a name="19957">AttributeMap</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef std::map < <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a>, <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> > <a href="Poco.XML.XMLWriter.html#19957" title="Poco::XML::XMLWriter::AttributeMap">AttributeMap</a>;</p> <div class="description"> <p></p> </div> <h2>Enumerations</h2> <h3><a name="19847">Options</a></h3> <div class="description"> <p></p> </div> <p class="decl"><a name="19848">CANONICAL</a> = 0x00</p> <div class="description"> <p>do not write an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> declaration </p> </div> <p class="decl"><a name="19849">WRITE_XML_DECLARATION</a> = 0x01</p> <div class="description"> <p>write an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> declaration </p> </div> <p class="decl"><a name="19850">PRETTY_PRINT</a> = 0x02</p> <div class="description"> <p>pretty-print <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> markup </p> </div> <h2>Constructors</h2> <h3><a name="19851">XMLWriter</a></h3> <p class="decl"><a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a>(<br /> <a href="Poco.XML.html#19837" title="Poco::XML::XMLByteOutputStream">XMLByteOutputStream</a> & str,<br /> int options<br />);</p> <div class="description"> <p>Creates the <a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a> and sets the specified options. </p> <p>The resulting stream will be UTF-8 encoded. </p> </div> <h3><a name="19854">XMLWriter</a></h3> <p class="decl"><a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a>(<br /> <a href="Poco.XML.html#19837" title="Poco::XML::XMLByteOutputStream">XMLByteOutputStream</a> & str,<br /> int options,<br /> const std::string & encodingName,<br /> <a href="Poco.TextEncoding.html" title="class Poco::TextEncoding">Poco::TextEncoding</a> & textEncoding<br />);</p> <div class="description"> <p>Creates the <a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a> and sets the specified options. </p> <p>The encoding is reflected in the <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> declaration. The caller is responsible for that the given encodingName matches with the given textEncoding. </p> </div> <h3><a name="19859">XMLWriter</a></h3> <p class="decl"><a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a>(<br /> <a href="Poco.XML.html#19837" title="Poco::XML::XMLByteOutputStream">XMLByteOutputStream</a> & str,<br /> int options,<br /> const std::string & encodingName,<br /> <a href="Poco.TextEncoding.html" title="class Poco::TextEncoding">Poco::TextEncoding</a> * pTextEncoding<br />);</p> <div class="description"> <p>Creates the <a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a> and sets the specified options. </p> <p>The encoding is reflected in the <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> declaration. The caller is responsible for that the given encodingName matches with the given textEncoding. If pTextEncoding is null, the given encodingName is ignored and the default UTF-8 encoding is used. </p> </div> <h2>Destructor</h2> <h3><a name="19864">~XMLWriter</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">~<a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a>();</p> <div class="description"> <p>Destroys the <a href="Poco.XML.XMLWriter.html" title="class Poco::XML::XMLWriter">XMLWriter</a>. </p> </div> <h2>Member Functions</h2> <h3><a name="19896">characters</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void characters(<br /> const <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> ch[],<br /> int start,<br /> int length<br />);</p> <div class="description"> <p>Writes <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> character data. Quotes, ampersand's, less-than and greater-than signs are escaped, unless a CDATA section has been opened by calling <a href="Poco.XML.XMLWriter.html#19929" title="Poco::XML::XMLWriter::startCDATA()">startCDATA</a>(). </p> <p>The characters must be encoded in UTF-8 (if <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> is char) or UTF-16 (if <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> is wchar_t). </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18865" title="Poco::XML::ContentHandler::characters()">Poco::XML::ContentHandler::characters()</a></p></div> <h3><a name="19900">characters</a></h3> <p class="decl">void characters(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & str<br />);</p> <div class="description"> <p>Writes <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> character data. Quotes, ampersand's, less-than and greater-than signs are escaped, unless a CDATA section has been opened by calling <a href="Poco.XML.XMLWriter.html#19929" title="Poco::XML::XMLWriter::startCDATA()">startCDATA</a>(). </p> <p>The characters must be encoded in UTF-8 (if <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> is char) or UTF-16 (if <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> is wchar_t). </p> </div> <h3><a name="19931">comment</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void comment(<br /> const <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> ch[],<br /> int start,<br /> int length<br />);</p> <div class="description"> <p>Writes a comment. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.LexicalHandler.html#19037" title="Poco::XML::LexicalHandler::comment()">Poco::XML::LexicalHandler::comment()</a></p></div> <h3><a name="19918">dataElement</a></h3> <p class="decl">void dataElement(<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 <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & data,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & attr1 = XMLString (),<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & value1 = XMLString (),<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & attr2 = XMLString (),<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & value2 = XMLString (),<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & attr3 = XMLString (),<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & value3 = XMLString ()<br />);</p> <div class="description"> <p>Writes a data element in the form <name attr1="value1"...>data</name>. </p> </div> <h3><a name="19887">emptyElement</a></h3> <p class="decl">void emptyElement(<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 <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname<br />);</p> <div class="description"> <p>Writes an empty <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> element tag (<elem/>). </p> </div> <h3><a name="19891">emptyElement</a></h3> <p class="decl">void emptyElement(<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 <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname,<br /> const <a href="Poco.XML.Attributes.html" title="class Poco::XML::Attributes">Attributes</a> & attributes<br />);</p> <div class="description"> <p>Writes an empty <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> element tag with the given attributes (<elem attr1="value1"... />). </p> </div> <h3><a name="19930">endCDATA</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void endCDATA();</p> <div class="description"> <p>Writes the ]</tt> string that ends a CDATA section. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.LexicalHandler.html#19036" title="Poco::XML::LexicalHandler::endCDATA()">Poco::XML::LexicalHandler::endCDATA()</a></p></div> <h3><a name="19939">endDTD</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void endDTD();</p> <div class="description"> <p>Writes the closing characters of a DTD declaration. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.LexicalHandler.html#19030" title="Poco::XML::LexicalHandler::endDTD()">Poco::XML::LexicalHandler::endDTD()</a></p></div> <h3><a name="19871">endDocument</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void endDocument();</p> <div class="description"> <p>Checks that all elements are closed and prints a final newline. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18855" title="Poco::XML::ContentHandler::endDocument()">Poco::XML::ContentHandler::endDocument()</a></p></div> <h3><a name="19883">endElement</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void endElement(<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 <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname<br />);</p> <div class="description"> <p>Writes an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> end element tag. </p> <p>Throws an exception if the name of doesn't match the one of the most recent <a href="Poco.XML.XMLWriter.html#19874" title="Poco::XML::XMLWriter::startElement()">startElement</a>(). </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18861" title="Poco::XML::ContentHandler::endElement()">Poco::XML::ContentHandler::endElement()</a></p></div> <h3><a name="19942">endEntity</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void endEntity(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name<br />);</p> <div class="description"> <p>Does nothing. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.LexicalHandler.html#19033" title="Poco::XML::LexicalHandler::endEntity()">Poco::XML::LexicalHandler::endEntity()</a></p></div> <h3><a name="19873">endFragment</a></h3> <p class="decl">void endFragment();</p> <div class="description"> <p>Checks that all elements are closed and prints a final newline. </p> </div> <h3><a name="19914">endPrefixMapping</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void endPrefixMapping(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & prefix<br />);</p> <div class="description"> <p>End the scope of a prefix-<a href="Poco.URI.html" title="class Poco::URI">URI</a> mapping. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18879" title="Poco::XML::ContentHandler::endPrefixMapping()">Poco::XML::ContentHandler::endPrefixMapping()</a></p></div> <h3><a name="19867">getNewLine</a></h3> <p class="decl">const std::string & getNewLine() const;</p> <div class="description"> <p>Returns the line ending currently in use. </p> </div> <h3><a name="19904">ignorableWhitespace</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void ignorableWhitespace(<br /> const <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> ch[],<br /> int start,<br /> int length<br />);</p> <div class="description"> <p>Writes whitespace characters by simply passing them to <a href="Poco.XML.XMLWriter.html#19896" title="Poco::XML::XMLWriter::characters()">characters</a>(). </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18869" title="Poco::XML::ContentHandler::ignorableWhitespace()">Poco::XML::ContentHandler::ignorableWhitespace()</a></p></div> <h3><a name="19944">notationDecl</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void notationDecl(<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 />);</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.DTDHandler.html#18885" title="Poco::XML::DTDHandler::notationDecl()">Poco::XML::DTDHandler::notationDecl()</a></p></div> <h3><a name="19908">processingInstruction</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void processingInstruction(<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 />);</p> <div class="description"> <p>Writes a processing instruction. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18873" title="Poco::XML::ContentHandler::processingInstruction()">Poco::XML::ContentHandler::processingInstruction()</a></p></div> <h3><a name="19902">rawCharacters</a></h3> <p class="decl">void rawCharacters(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & str<br />);</p> <div class="description"> <p>Writes the characters in the given string as they are. The caller is responsible for escaping characters as necessary to produce valid <a href="Poco.XML.html" title="namespace Poco::XML">XML</a>. </p> <p>The characters must be encoded in UTF-8 (if <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> is char) or UTF-16 (if <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> is wchar_t). </p> </div> <h3><a name="19868">setDocumentLocator</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setDocumentLocator(<br /> const <a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a> * loc<br />);</p> <div class="description"> <p>Currently unused. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18852" title="Poco::XML::ContentHandler::setDocumentLocator()">Poco::XML::ContentHandler::setDocumentLocator()</a></p></div> <h3><a name="19865">setNewLine</a></h3> <p class="decl">void setNewLine(<br /> const std::string & newLineCharacters<br />);</p> <div class="description"> <p>Sets the line ending for the resulting <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> file. </p> <p>Possible values are: </p> <ul> <li><a href="Poco.XML.XMLWriter.html#19953" title="Poco::XML::XMLWriter::NEWLINE_DEFAULT">NEWLINE_DEFAULT</a> (whatever is appropriate for the current platform) </li> <li><a href="Poco.XML.XMLWriter.html#19955" title="Poco::XML::XMLWriter::NEWLINE_CRLF">NEWLINE_CRLF</a> (Windows), </li> <li><a href="Poco.XML.XMLWriter.html#19956" title="Poco::XML::XMLWriter::NEWLINE_LF">NEWLINE_LF</a> (Unix), </li> <li><a href="Poco.XML.XMLWriter.html#19954" title="Poco::XML::XMLWriter::NEWLINE_CR">NEWLINE_CR</a> (Macintosh) </li> </ul> </div> <h3><a name="19916">skippedEntity</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void skippedEntity(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name<br />);</p> <div class="description"> <p>Does nothing. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18881" title="Poco::XML::ContentHandler::skippedEntity()">Poco::XML::ContentHandler::skippedEntity()</a></p></div> <h3><a name="19929">startCDATA</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void startCDATA();</p> <div class="description"> <p>Writes the <b>[CDATA[ string that begins a CDATA section. Use <a href="Poco.XML.XMLWriter.html#19896" title="Poco::XML::XMLWriter::characters()">characters</a>() to write the actual character data. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.LexicalHandler.html#19035" title="Poco::XML::LexicalHandler::startCDATA()">Poco::XML::LexicalHandler::startCDATA()</a></p></div> <h3><a name="19935">startDTD</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void startDTD(<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 />);</p> <div class="description"> <p>Writes a DTD declaration. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.LexicalHandler.html#19026" title="Poco::XML::LexicalHandler::startDTD()">Poco::XML::LexicalHandler::startDTD()</a></p></div> <h3><a name="19870">startDocument</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void startDocument();</p> <div class="description"> <p>Writes a generic <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> declaration to the stream. If a document type has been set (see SetDocumentType), a DOCTYPE declaration is also written. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18854" title="Poco::XML::ContentHandler::startDocument()">Poco::XML::ContentHandler::startDocument()</a></p></div> <h3><a name="19874">startElement</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void startElement(<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 <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname,<br /> const <a href="Poco.XML.Attributes.html" title="class Poco::XML::Attributes">Attributes</a> & attributes<br />);</p> <div class="description"> <p>Writes an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> start element tag. </p> <p>Namespaces are handled as follows. </p> <ol> <li>If a qname, but no namespaceURI and localName are given, the qname is taken as element name. </li> <li>If a namespaceURI and a localName, but no qname is given, and the given namespaceURI has been declared earlier, the namespace prefix for the given namespaceURI together with the localName is taken as element name. If the namespace has not been declared, a prefix in the form "ns1", "ns2", etc. is generated and the namespace is declared with the generated prefix. </li> <li>If all three are given, and the namespace given in namespaceURI has not been declared, it is declared now. Otherwise, see 2. </li> </ol> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18856" title="Poco::XML::ContentHandler::startElement()">Poco::XML::ContentHandler::startElement()</a></p></div> <h3><a name="19879">startElement</a></h3> <p class="decl">void startElement(<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 <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname<br />);</p> <div class="description"> <p>Writes an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> start element tag with no attributes. See the other <a href="Poco.XML.XMLWriter.html#19874" title="Poco::XML::XMLWriter::startElement()">startElement</a>() method for more information. </p> </div> <h3><a name="19940">startEntity</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void startEntity(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name<br />);</p> <div class="description"> <p>Does nothing. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.LexicalHandler.html#19031" title="Poco::XML::LexicalHandler::startEntity()">Poco::XML::LexicalHandler::startEntity()</a></p></div> <h3><a name="19872">startFragment</a></h3> <p class="decl">void startFragment();</p> <div class="description"> <p>Use this instead of StartDocument() if you want to write a fragment rather than a document (no <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> declaration and more than one "root" element allowed). </p> </div> <h3><a name="19911">startPrefixMapping</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void startPrefixMapping(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & prefix,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & namespaceURI<br />);</p> <div class="description"> <p>Begin the scope of a prefix-<a href="Poco.URI.html" title="class Poco::URI">URI</a> <a href="Poco.XML.XMLWriter.Namespace.html" title="struct Poco::XML::XMLWriter::Namespace">Namespace</a> mapping. A namespace declaration is written with the next element. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.ContentHandler.html#18876" title="Poco::XML::ContentHandler::startPrefixMapping()">Poco::XML::ContentHandler::startPrefixMapping()</a></p></div> <h3><a name="19948">unparsedEntityDecl</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void unparsedEntityDecl(<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 />);</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.DTDHandler.html#18889" title="Poco::XML::DTDHandler::unparsedEntityDecl()">Poco::XML::DTDHandler::unparsedEntityDecl()</a></p></div> <h3><a name="19984">addAttributes</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void addAttributes(<br /> <a href="Poco.XML.XMLWriter.html#19957" title="Poco::XML::XMLWriter::AttributeMap">AttributeMap</a> & attributeMap,<br /> const <a href="Poco.XML.Attributes.html" title="class Poco::XML::Attributes">Attributes</a> & attributes,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & elementNamespaceURI<br />);</p> <div class="description"> <p></p> </div> <h3><a name="19982">addNamespaceAttributes</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void addNamespaceAttributes(<br /> <a href="Poco.XML.XMLWriter.html#19957" title="Poco::XML::XMLWriter::AttributeMap">AttributeMap</a> & attributeMap<br />);</p> <div class="description"> <p></p> </div> <h3><a name="19979">closeStartTag</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void closeStartTag();</p> <div class="description"> <p></p> </div> <h3><a name="19980">declareAttributeNamespaces</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void declareAttributeNamespaces(<br /> const <a href="Poco.XML.Attributes.html" title="class Poco::XML::Attributes">Attributes</a> & attributes<br />);</p> <div class="description"> <p></p> </div> <h3><a name="19992">nameToString</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">static std::string nameToString(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & localName,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname<br />);</p> <div class="description"> <p></p> </div> <h3><a name="19991">newPrefix</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> newPrefix();</p> <div class="description"> <p></p> </div> <h3><a name="19990">prettyPrint</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prettyPrint() const;</p> <div class="description"> <p></p> </div> <h3><a name="19988">writeAttributes</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeAttributes(<br /> const <a href="Poco.XML.XMLWriter.html#19957" title="Poco::XML::XMLWriter::AttributeMap">AttributeMap</a> & attributeMap<br />);</p> <div class="description"> <p></p> </div> <h3><a name="19963">writeEndElement</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeEndElement(<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 <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname<br />);</p> <div class="description"> <p></p> </div> <h3><a name="19974">writeIndent</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeIndent() const;</p> <div class="description"> <p></p> </div> <h3><a name="19967">writeMarkup</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeMarkup(<br /> const std::string & str<br />) const;</p> <div class="description"> <p></p> </div> <h3><a name="19975">writeName</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeName(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & prefix,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & localName<br />);</p> <div class="description"> <p></p> </div> <h3><a name="19973">writeNewLine</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeNewLine() const;</p> <div class="description"> <p></p> </div> <h3><a name="19958">writeStartElement</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeStartElement(<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 <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & qname,<br /> const <a href="Poco.XML.Attributes.html" title="class Poco::XML::Attributes">Attributes</a> & attributes<br />);</p> <div class="description"> <p></p> </div> <h3><a name="19969">writeXML</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeXML(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & str<br />) const;</p> <div class="description"> <p></p> </div> <h3><a name="19971">writeXML</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeXML(<br /> <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> ch<br />) const;</p> <div class="description"> <p></p> </div> <h3><a name="19978">writeXMLDeclaration</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void writeXMLDeclaration();</p> <div class="description"> <p></p> </div> <h2>Variables</h2> <h3><a name="19954">NEWLINE_CR</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">static const std::string <a href="Poco.XML.XMLWriter.html#19954" title="Poco::XML::XMLWriter::NEWLINE_CR">NEWLINE_CR</a>;</p> <div class="description"> <p></p> </div> <h3><a name="19955">NEWLINE_CRLF</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">static const std::string <a href="Poco.XML.XMLWriter.html#19955" title="Poco::XML::XMLWriter::NEWLINE_CRLF">NEWLINE_CRLF</a>;</p> <div class="description"> <p></p> </div> <h3><a name="19953">NEWLINE_DEFAULT</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">static const std::string <a href="Poco.XML.XMLWriter.html#19953" title="Poco::XML::XMLWriter::NEWLINE_DEFAULT">NEWLINE_DEFAULT</a>;</p> <div class="description"> <p></p> </div> <h3><a name="19956">NEWLINE_LF</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">static const std::string <a href="Poco.XML.XMLWriter.html#19956" title="Poco::XML::XMLWriter::NEWLINE_LF">NEWLINE_LF</a>;</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>
