class Poco::XML::DOMWriter

Overview

The DOMWriter uses a DOMSerializer with an XMLWriter to serialize a DOM document into textual XML. More…

#include <DOMWriter.h>

class DOMWriter
{
public:
    // methods

    void
    setEncoding(
        const std::string& encodingName,
        Poco::TextEncoding& textEncoding
        );

    const std::string&
    getEncoding() const;

    void
    setOptions(int options);

    int
    getOptions() const;

    void
    setNewLine(const std::string& newLine);

    const std::string&
    getNewLine() const;

    void
    setIndent(const std::string& indent);

    const std::string&
    getIndent() const;

    void
    writeNode(
        XMLByteOutputStream& ostr,
        const Node* pNode
        );

    void
    writeNode(
        const std::string& systemId,
        const Node* pNode
        );
};

Detailed Documentation

The DOMWriter uses a DOMSerializer with an XMLWriter to serialize a DOM document into textual XML.

Construction

~DOMWriter()

Destroys a DOMWriter.

Methods

void
setEncoding(
    const std::string& encodingName,
    Poco::TextEncoding& textEncoding
    )

Sets the encoding, which will be reflected in the written XML declaration.

const std::string&
getEncoding() const

Returns the encoding name set with setEncoding.

void
setOptions(int options)

Sets options for the internal XMLWriter.

See class XMLWriter for available options.

int
getOptions() const

Returns the options for the internal XMLWriter.

void
setNewLine(const std::string& newLine)

Sets the line ending characters for the internal XMLWriter.

See XMLWriter::setNewLine() for a list of supported values.

const std::string&
getNewLine() const

Returns the line ending characters used by the internal XMLWriter.

void
setIndent(const std::string& indent)

Sets the string used for one indentation step.

The default is a single TAB character. The given string should only contain TAB or SPACE characters (e.g., a single TAB character, or two to four SPACE characters).

const std::string&
getIndent() const

Returns the string used for one indentation step.

void
writeNode(
    XMLByteOutputStream& ostr,
    const Node* pNode
    )

Writes the XML for the given node to the specified stream.

void
writeNode(
    const std::string& systemId,
    const Node* pNode
    )

Writes the XML for the given node to the file specified in systemId, using a standard file output stream (Poco::FileOutputStream).