eric6/Documentation/Source/eric6.E5XML.XMLStreamReaderBase.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.E5XML.XMLStreamReaderBase.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.E5XML.XMLStreamReaderBase.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,239 +18,317 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.E5XML.XMLStreamReaderBase</h1>
+
 <p>
 Module implementing a base class for all of eric6s XML stream writers.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#XMLStreamReaderBase">XMLStreamReaderBase</a></td>
 <td>Class implementing a base class for all of eric6s XML stream readers.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="XMLStreamReaderBase" ID="XMLStreamReaderBase"></a>
 <h2>XMLStreamReaderBase</h2>
+
 <p>
     Class implementing a base class for all of eric6s XML stream readers.
 </p>
 <h3>Derived from</h3>
 QXmlStreamReader
 <h3>Class Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+
 <table>
+
 <tr>
 <td><a href="#XMLStreamReaderBase.__init__">XMLStreamReaderBase</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.__readDict">__readDict</a></td>
 <td>Private method to read a Python dictionary.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.__readFrozenset">__readFrozenset</a></td>
 <td>Private method to read a Python set.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.__readList">__readList</a></td>
 <td>Private method to read a Python list.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.__readSet">__readSet</a></td>
 <td>Private method to read a Python set.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.__readTuple">__readTuple</a></td>
 <td>Private method to read a Python tuple.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase._readBasics">_readBasics</a></td>
 <td>Protected method to read an object of a basic Python type.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase._skipUnknownElement">_skipUnknownElement</a></td>
 <td>Protected method to skip over all unknown elements.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.attribute">attribute</a></td>
 <td>Public method to read the given attribute of the current tag.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.raiseBadValue">raiseBadValue</a></td>
 <td>Public method to raise an error for a bad value.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.raiseUnexpectedStartTag">raiseUnexpectedStartTag</a></td>
 <td>Public method to raise an error for an unexpected start tag.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.raiseUnsupportedFormatVersion">raiseUnsupportedFormatVersion</a></td>
 <td>Public method to raise an error for an unsupported file format version.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.readXML">readXML</a></td>
 <td>Public method to read and parse the XML document.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.showErrorMessage">showErrorMessage</a></td>
 <td>Public method to show an error message.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#XMLStreamReaderBase.toBool">toBool</a></td>
 <td>Public method to convert the given value to bool.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="XMLStreamReaderBase.__init__" ID="XMLStreamReaderBase.__init__"></a>
 <h4>XMLStreamReaderBase (Constructor)</h4>
 <b>XMLStreamReaderBase</b>(<i>device</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>device</i></dt>
 <dd>
 reference to the I/O device to read from (QIODevice)
 </dd>
-</dl><a NAME="XMLStreamReaderBase.__readDict" ID="XMLStreamReaderBase.__readDict"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.__readDict" ID="XMLStreamReaderBase.__readDict"></a>
 <h4>XMLStreamReaderBase.__readDict</h4>
 <b>__readDict</b>(<i></i>)
+
 <p>
         Private method to read a Python dictionary.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 Python dictionary
 </dd>
-</dl><a NAME="XMLStreamReaderBase.__readFrozenset" ID="XMLStreamReaderBase.__readFrozenset"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.__readFrozenset" ID="XMLStreamReaderBase.__readFrozenset"></a>
 <h4>XMLStreamReaderBase.__readFrozenset</h4>
 <b>__readFrozenset</b>(<i></i>)
+
 <p>
         Private method to read a Python set.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 Python set
 </dd>
-</dl><a NAME="XMLStreamReaderBase.__readList" ID="XMLStreamReaderBase.__readList"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.__readList" ID="XMLStreamReaderBase.__readList"></a>
 <h4>XMLStreamReaderBase.__readList</h4>
 <b>__readList</b>(<i></i>)
+
 <p>
         Private method to read a Python list.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 Python list
 </dd>
-</dl><a NAME="XMLStreamReaderBase.__readSet" ID="XMLStreamReaderBase.__readSet"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.__readSet" ID="XMLStreamReaderBase.__readSet"></a>
 <h4>XMLStreamReaderBase.__readSet</h4>
 <b>__readSet</b>(<i></i>)
+
 <p>
         Private method to read a Python set.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 Python set
 </dd>
-</dl><a NAME="XMLStreamReaderBase.__readTuple" ID="XMLStreamReaderBase.__readTuple"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.__readTuple" ID="XMLStreamReaderBase.__readTuple"></a>
 <h4>XMLStreamReaderBase.__readTuple</h4>
 <b>__readTuple</b>(<i></i>)
+
 <p>
         Private method to read a Python tuple.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 Python tuple
 </dd>
-</dl><a NAME="XMLStreamReaderBase._readBasics" ID="XMLStreamReaderBase._readBasics"></a>
+</dl>
+<a NAME="XMLStreamReaderBase._readBasics" ID="XMLStreamReaderBase._readBasics"></a>
 <h4>XMLStreamReaderBase._readBasics</h4>
 <b>_readBasics</b>(<i></i>)
+
 <p>
         Protected method to read an object of a basic Python type.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 Python object read
 </dd>
-</dl><a NAME="XMLStreamReaderBase._skipUnknownElement" ID="XMLStreamReaderBase._skipUnknownElement"></a>
+</dl>
+<a NAME="XMLStreamReaderBase._skipUnknownElement" ID="XMLStreamReaderBase._skipUnknownElement"></a>
 <h4>XMLStreamReaderBase._skipUnknownElement</h4>
 <b>_skipUnknownElement</b>(<i></i>)
+
 <p>
         Protected method to skip over all unknown elements.
-</p><a NAME="XMLStreamReaderBase.attribute" ID="XMLStreamReaderBase.attribute"></a>
+</p>
+<a NAME="XMLStreamReaderBase.attribute" ID="XMLStreamReaderBase.attribute"></a>
 <h4>XMLStreamReaderBase.attribute</h4>
 <b>attribute</b>(<i>name, default=""</i>)
+
 <p>
         Public method to read the given attribute of the current tag.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>name</i></dt>
 <dd>
 name of the attribute (string)
-</dd><dt><i>default</i></dt>
+</dd>
+<dt><i>default</i></dt>
 <dd>
 default value (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 value of the requested tag attribute (string)
 </dd>
-</dl><a NAME="XMLStreamReaderBase.raiseBadValue" ID="XMLStreamReaderBase.raiseBadValue"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.raiseBadValue" ID="XMLStreamReaderBase.raiseBadValue"></a>
 <h4>XMLStreamReaderBase.raiseBadValue</h4>
 <b>raiseBadValue</b>(<i>value</i>)
+
 <p>
         Public method to raise an error for a bad value.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>value</i></dt>
 <dd>
 bad value (string)
 </dd>
-</dl><a NAME="XMLStreamReaderBase.raiseUnexpectedStartTag" ID="XMLStreamReaderBase.raiseUnexpectedStartTag"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.raiseUnexpectedStartTag" ID="XMLStreamReaderBase.raiseUnexpectedStartTag"></a>
 <h4>XMLStreamReaderBase.raiseUnexpectedStartTag</h4>
 <b>raiseUnexpectedStartTag</b>(<i>tag</i>)
+
 <p>
         Public method to raise an error for an unexpected start tag.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>tag</i></dt>
 <dd>
 name of the unexpected tag (string)
 </dd>
-</dl><a NAME="XMLStreamReaderBase.raiseUnsupportedFormatVersion" ID="XMLStreamReaderBase.raiseUnsupportedFormatVersion"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.raiseUnsupportedFormatVersion" ID="XMLStreamReaderBase.raiseUnsupportedFormatVersion"></a>
 <h4>XMLStreamReaderBase.raiseUnsupportedFormatVersion</h4>
 <b>raiseUnsupportedFormatVersion</b>(<i>version</i>)
+
 <p>
         Public method to raise an error for an unsupported file format version.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>version</i></dt>
 <dd>
 unsupported version (string)
 </dd>
-</dl><a NAME="XMLStreamReaderBase.readXML" ID="XMLStreamReaderBase.readXML"></a>
+</dl>
+<a NAME="XMLStreamReaderBase.readXML" ID="XMLStreamReaderBase.readXML"></a>
 <h4>XMLStreamReaderBase.readXML</h4>
 <b>readXML</b>(<i></i>)
+
 <p>
         Public method to read and parse the XML document.
-</p><a NAME="XMLStreamReaderBase.showErrorMessage" ID="XMLStreamReaderBase.showErrorMessage"></a>
+</p>
+<a NAME="XMLStreamReaderBase.showErrorMessage" ID="XMLStreamReaderBase.showErrorMessage"></a>
 <h4>XMLStreamReaderBase.showErrorMessage</h4>
 <b>showErrorMessage</b>(<i></i>)
+
 <p>
         Public method to show an error message.
-</p><a NAME="XMLStreamReaderBase.toBool" ID="XMLStreamReaderBase.toBool"></a>
+</p>
+<a NAME="XMLStreamReaderBase.toBool" ID="XMLStreamReaderBase.toBool"></a>
 <h4>XMLStreamReaderBase.toBool</h4>
 <b>toBool</b>(<i>value</i>)
+
 <p>
         Public method to convert the given value to bool.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>value</i></dt>
 <dd>
 value to be converted ("True", "False", "1", "0")
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 converted value (boolean) or None in case of an error

eric ide

mercurial