QXmlFormatter

Synopsis

Functions

• def indentationDepth ()
• def setIndentationDepth (depth)
• def startFormattingContent ()

Detailed Description

The PySide.QtXmlPatterns.QXmlFormatter class is an implementation of PySide.QtXmlPatterns.QXmlSerializer for transforming XQuery output into formatted XML.

PySide.QtXmlPatterns.QXmlFormatter is a subclass of PySide.QtXmlPatterns.QXmlSerializer that formats the XML output to make it easier for humans to read.

PySide.QtXmlPatterns.QXmlSerializer outputs XML without adding unnecessary whitespace. In particular, it does not add newlines and indentation. To make the XML output easier to read, PySide.QtXmlPatterns.QXmlFormatter adds newlines and indentation by adding, removing, and modifying sequence nodes that only consist of whitespace. It also modifies whitespace in other places where it is not significant; e.g., between attributes and in the document prologue.

For example, where the base class PySide.QtXmlPatterns.QXmlSerializer would output this:

<a><b/><c/><p>Some Text</p></a>

PySide.QtXmlPatterns.QXmlFormatter outputs this:

<a>
   <b/>
   <c/>
   <p>Some Text</p>
</a>

If you just want to serialize your XML in a human-readable format, use PySide.QtXmlPatterns.QXmlFormatter as it is. The default indentation level is 4 spaces, but you can set your own indentation value PySide.QtXmlPatterns.QXmlFormatter.setIndentationDepth() .

The newlines and indentation added by PySide.QtXmlPatterns.QXmlFormatter are suitable for common formats, such as XHTML, SVG, or Docbook, where whitespace is not significant. However, if your XML will be used as input where whitespace is significant, then you must write your own subclass of PySide.QtXmlPatterns.QXmlSerializer or PySide.QtXmlPatterns.QAbstractXmlReceiver .

Note that using PySide.QtXmlPatterns.QXmlFormatter instead of PySide.QtXmlPatterns.QXmlSerializer will increase computational overhead and document storage size due to the insertion of whitespace.

Note also that the indentation style used by PySide.QtXmlPatterns.QXmlFormatter remains loosely defined and may change in future versions of Qt. If a specific indentation style is required then either use the base class PySide.QtXmlPatterns.QXmlSerializer directly, or write your own subclass of PySide.QtXmlPatterns.QXmlSerializer or PySide.QtXmlPatterns.QAbstractXmlReceiver . Alternatively, you can subclass PySide.QtXmlPatterns.QXmlFormatter and reimplement the callbacks there.

QXmlQuery query;
query.setQuery("doc('index.html')/html/body/p[1]");

QXmlFormatter formatter(query, myOutputDevice);
formatter.setIndentationDepth(2);
query.evaluateTo(&formatter);

class PySide.QtXmlPatterns.QXmlFormatter(query, outputDevice)

Parameters:

• query – PySide.QtXmlPatterns.QXmlQuery
• outputDevice – PySide.QtCore.QIODevice

Constructs a formatter that uses the name pool and message handler in query , and writes the result to outputDevice as formatted XML.

outputDevice is passed directly to PySide.QtXmlPatterns.QXmlSerializer ‘s constructor.

See also

PySide.QtXmlPatterns.QXmlSerializer

PySide.QtXmlPatterns.QXmlFormatter.indentationDepth()

Return type:PySide.QtCore.int

Returns the number of spaces PySide.QtXmlPatterns.QXmlFormatter will output for each indentation level. The default is four.

See also

PySide.QtXmlPatterns.QXmlFormatter.setIndentationDepth()

PySide.QtXmlPatterns.QXmlFormatter.setIndentationDepth(depth)

Parameters:depth – PySide.QtCore.int

Sets depth to be the number of spaces PySide.QtXmlPatterns.QXmlFormatter will output for level of indentation. The default is four.

See also

PySide.QtXmlPatterns.QXmlFormatter.indentationDepth()

PySide.QtXmlPatterns.QXmlFormatter.startFormattingContent()