PageRenderTime 52ms CodeModel.GetById 19ms RepoModel.GetById 1ms app.codeStats 0ms

/PyQt-x11-gpl-4.9.4/doc/html/qxmlformatter.html

#
HTML | 108 lines | 80 code | 28 blank | 0 comment | 0 complexity | 03e3bee9b309ff1269b4f99c8d5fa230 MD5 | raw file
Possible License(s): GPL-2.0, GPL-3.0 
    

  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
    3. 

  3. <html><head><title>QXmlFormatter Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
    4. 

  4. a:link { color: #004faf; text-decoration: none }
    5. 

  5. a:visited { color: #672967; text-decoration: none }
    6. 

  6. td.postheader { font-family: sans-serif }
    7. 

  7. tr.address { font-family: sans-serif }
    8. 

  8. body { background: #ffffff; color: black; }
    9. 

  9. </style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">&#160;&#160;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QXmlFormatter Class Reference<br /><sup><sup>[<a href="qtxmlpatterns.html">QtXmlPatterns</a> module]</sup></sup></h1><p>The QXmlFormatter class is an implementation of <a href="qxmlserializer.html">QXmlSerializer</a> for transforming <a href="xmlprocessing.html">XQuery</a> output into formatted XML. <a href="#details">More...</a></p>
    10. 

  10. 

  11. <p>Inherits <a href="qxmlserializer.html">QXmlSerializer</a>.</p><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qxmlformatter.html#QXmlFormatter">__init__</a></b> (<i>self</i>, QXmlQuery&#160;<i>query</i>, QIODevice&#160;<i>outputDevice</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#atomicValue">atomicValue</a></b> (<i>self</i>, QVariant&#160;<i>value</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#attribute">attribute</a></b> (<i>self</i>, QXmlName&#160;<i>name</i>, QStringRef&#160;<i>value</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#characters">characters</a></b> (<i>self</i>, QStringRef&#160;<i>value</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#comment">comment</a></b> (<i>self</i>, QString&#160;<i>value</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#endDocument">endDocument</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#endElement">endElement</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#endOfSequence">endOfSequence</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qxmlformatter.html#indentationDepth">indentationDepth</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#processingInstruction">processingInstruction</a></b> (<i>self</i>, QXmlName&#160;<i>name</i>, QString&#160;<i>value</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#setIndentationDepth">setIndentationDepth</a></b> (<i>self</i>, int&#160;<i>depth</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#startDocument">startDocument</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#startElement">startElement</a></b> (<i>self</i>, QXmlName&#160;<i>name</i>)</li><li><div class="fn" /><b><a href="qxmlformatter.html#startOfSequence">startOfSequence</a></b> (<i>self</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QXmlFormatter class is an implementation of <a href="qxmlserializer.html">QXmlSerializer</a> for transforming <a href="xmlprocessing.html">XQuery</a> output into formatted XML.</p>
    12. 

  12. <p>QXmlFormatter is a subclass of <a href="qxmlserializer.html">QXmlSerializer</a> that formats the XML
    13. 

  13. output to make it easier for humans to read.</p>
    14. 

  14. <p><a href="qxmlserializer.html">QXmlSerializer</a> outputs XML
    15. 

  15. without adding unnecessary whitespace. In particular, it does not
    16. 

  16. add <i>newlines</i> and indentation. To make the XML output easier
    17. 

  17. to read, QXmlFormatter adds <i>newlines</i> and indentation by
    18. 

  18. adding, removing, and modifying <a href="qabstractxmlreceiver.html#xquery-sequence">sequence nodes</a> that
    19. 

  19. only consist of whitespace. It also modifies whitespace in other
    20. 

  20. places where it is not significant; e.g., between attributes and in
    21. 

  21. the document prologue.</p>
    22. 

  22. <p>For example, where the base class <a href="qxmlserializer.html">QXmlSerializer</a> would output this:</p>
    23. 

  23. <pre class="cpp">
    24. 

  24.  &lt;a&gt;&lt;b/&gt;&lt;c/&gt;&lt;p&gt;Some Text&lt;/p&gt;&lt;/a&gt;
    25. 

  25. </pre>
    26. 

  26. <p>QXmlFormatter outputs this:</p>
    27. 

  27. <pre class="cpp">
    28. 

  28.  &lt;a&gt;
    29. 

  29.     &lt;b/&gt;
    30. 

  30.     &lt;c/&gt;
    31. 

  31.     &lt;p&gt;Some Text&lt;/p&gt;
    32. 

  32.  &lt;/a&gt;
    33. 

  33. </pre>
    34. 

  34. <p>If you just want to serialize your XML in a human-readable
    35. 

  35. format, use QXmlFormatter as it is. The default indentation level
    36. 

  36. is 4 spaces, but you can set your own indentation value <a href="qxmlformatter.html#setIndentationDepth">setIndentationDepth</a>().</p>
    37. 

  37. <p>The <i>newlines</i> and indentation added by QXmlFormatter are
    38. 

  38. suitable for common formats, such as XHTML, SVG, or Docbook, where
    39. 

  39. whitespace is not significant. However, if your XML will be used as
    40. 

  40. input where whitespace is significant, then you must write your own
    41. 

  41. subclass of <a href="qxmlserializer.html">QXmlSerializer</a> or
    42. 

  42. <a href="qabstractxmlreceiver.html">QAbstractXmlReceiver</a>.</p>
    43. 

  43. <p>Note that using QXmlFormatter instead of <a href="qxmlserializer.html">QXmlSerializer</a> will increase
    44. 

  44. computational overhead and document storage size due to the
    45. 

  45. insertion of whitespace.</p>
    46. 

  46. <p>Note also that the indentation style used by QXmlFormatter
    47. 

  47. remains loosely defined and may change in future versions of Qt. If
    48. 

  48. a specific indentation style is required then either use the base
    49. 

  49. class <a href="qxmlserializer.html">QXmlSerializer</a> directly, or
    50. 

  50. write your own subclass of <a href="qxmlserializer.html">QXmlSerializer</a> or <a href="qabstractxmlreceiver.html">QAbstractXmlReceiver</a>.
    51. 

  51. Alternatively, you can subclass QXmlFormatter and reimplement the
    52. 

  52. callbacks there.</p>
    53. 

  53. <pre class="cpp">
    54. 

  54.  <span class="type"><a href="qxmlquery.html">QXmlQuery</a></span> query;
    55. 

  55.  query<span class="operator">.</span>setQuery(<span class="string">"doc('index.html')/html/body/p[1]"</span>);
    56. 

  56. 

  57.  <span class="type">QXmlFormatter</span> formatter(query<span class="operator">,</span> myOutputDevice);
    58. 

  58.  formatter<span class="operator">.</span><a href="qxmlformatter.html#setIndentationDepth">setIndentationDepth</a>(<span class="number">2</span>);
    59. 

  59.  query<span class="operator">.</span>evaluateTo(<span class="operator">&amp;</span>formatter);
    60. 

  60. </pre><hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QXmlFormatter" />QXmlFormatter.__init__ (<i>self</i>, <a href="qxmlquery.html">QXmlQuery</a>&#160;<i>query</i>, <a href="qiodevice.html">QIODevice</a>&#160;<i>outputDevice</i>)</h3><p>Constructs a formatter that uses the name pool and message
    61. 

  61. handler in <i>query</i>, and writes the result to
    62. 

  62. <i>outputDevice</i> as formatted XML.</p>
    63. 

  63. <p><i>outputDevice</i> is passed directly to <a href="qxmlserializer.html">QXmlSerializer</a>'s constructor.</p>
    64. 

  64. <p><b>See also</b> <a href="qxmlserializer.html">QXmlSerializer</a>.</p>
    65. 

  65. 

  66. 

  67. <h3 class="fn"><a name="atomicValue" />QXmlFormatter.atomicValue (<i>self</i>, QVariant&#160;<i>value</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#atomicValue">QAbstractXmlReceiver.atomicValue</a>().</p>
    68. 

  68. 

  69. 

  70. <h3 class="fn"><a name="attribute" />QXmlFormatter.attribute (<i>self</i>, <a href="qxmlname.html">QXmlName</a>&#160;<i>name</i>, QStringRef&#160;<i>value</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#attribute">QAbstractXmlReceiver.attribute</a>().</p>
    71. 

  71. 

  72. 

  73. <h3 class="fn"><a name="characters" />QXmlFormatter.characters (<i>self</i>, QStringRef&#160;<i>value</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#characters">QAbstractXmlReceiver.characters</a>().</p>
    74. 

  74. 

  75. 

  76. <h3 class="fn"><a name="comment" />QXmlFormatter.comment (<i>self</i>, QString&#160;<i>value</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#comment">QAbstractXmlReceiver.comment</a>().</p>
    77. 

  77. 

  78. 

  79. <h3 class="fn"><a name="endDocument" />QXmlFormatter.endDocument (<i>self</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#endDocument">QAbstractXmlReceiver.endDocument</a>().</p>
    80. 

  80. 

  81. 

  82. <h3 class="fn"><a name="endElement" />QXmlFormatter.endElement (<i>self</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#endElement">QAbstractXmlReceiver.endElement</a>().</p>
    83. 

  83. 

  84. 

  85. <h3 class="fn"><a name="endOfSequence" />QXmlFormatter.endOfSequence (<i>self</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#endOfSequence">QAbstractXmlReceiver.endOfSequence</a>().</p>
    86. 

  86. 

  87. 

  88. <h3 class="fn"><a name="indentationDepth" />int QXmlFormatter.indentationDepth (<i>self</i>)</h3><p>Returns the number of spaces <a href="qxmlformatter.html">QXmlFormatter</a> will output for each
    89. 

  89. indentation level. The default is four.</p>
    90. 

  90. <p><b>See also</b> <a href="qxmlformatter.html#setIndentationDepth">setIndentationDepth</a>().</p>
    91. 

  91. 

  92. 

  93. <h3 class="fn"><a name="processingInstruction" />QXmlFormatter.processingInstruction (<i>self</i>, <a href="qxmlname.html">QXmlName</a>&#160;<i>name</i>, QString&#160;<i>value</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#processingInstruction">QAbstractXmlReceiver.processingInstruction</a>().</p>
    94. 

  94. 

  95. 

  96. <h3 class="fn"><a name="setIndentationDepth" />QXmlFormatter.setIndentationDepth (<i>self</i>, int&#160;<i>depth</i>)</h3><p>Sets <i>depth</i> to be the number of spaces <a href="qxmlformatter.html">QXmlFormatter</a> will output for level of
    97. 

  97. indentation. The default is four.</p>
    98. 

  98. <p><b>See also</b> <a href="qxmlformatter.html#indentationDepth">indentationDepth</a>().</p>
    99. 

  99. 

  100. 

  101. <h3 class="fn"><a name="startDocument" />QXmlFormatter.startDocument (<i>self</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#startDocument">QAbstractXmlReceiver.startDocument</a>().</p>
    102. 

  102. 

  103. 

  104. <h3 class="fn"><a name="startElement" />QXmlFormatter.startElement (<i>self</i>, <a href="qxmlname.html">QXmlName</a>&#160;<i>name</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#startElement">QAbstractXmlReceiver.startElement</a>().</p>
    105. 

  105. 

  106. 

  107. <h3 class="fn"><a name="startOfSequence" />QXmlFormatter.startOfSequence (<i>self</i>)</h3><p>Reimplemented from <a href="qabstractxmlreceiver.html#startOfSequence">QAbstractXmlReceiver.startOfSequence</a>().</p>
    108. 

  108. <address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;4.9.4 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2012</td><td align="right" width="25%">Qt&#160;4.8.2</td></tr></table></div></address></body></html>
    109.