diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.E4XML.XMLHandlerBase.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.E4XML.XMLHandlerBase.html Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,338 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.E4XML.XMLHandlerBase</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.E4XML.XMLHandlerBase</h1>
+<p>
+Module implementing a base class for all of eric4s XML handlers.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#XMLHandlerBase">XMLHandlerBase</a></td>
+<td>Class implementing the base class for al of eric4s XML handlers.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="XMLHandlerBase" ID="XMLHandlerBase"></a>
+<h2>XMLHandlerBase</h2>
+<p>
+ Class implementing the base class for al of eric4s XML handlers.
+</p>
+<h3>Derived from</h3>
+ContentHandler
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#XMLHandlerBase.__init__">XMLHandlerBase</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase._prepareBasics">_prepareBasics</a></td>
+<td>Protected method to prepare the parsing of XML for basic python types.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.characters">characters</a></td>
+<td>Handler called for ordinary text.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.decodedNewLines">decodedNewLines</a></td>
+<td>Public method to decode newlines and paragraph breaks.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.defaultEndElement">defaultEndElement</a></td>
+<td>Handler method for the common end tags.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.defaultStartElement">defaultStartElement</a></td>
+<td>Handler method for common start tags.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endBool">endBool</a></td>
+<td>Handler method for the "bool" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endComplex">endComplex</a></td>
+<td>Handler method for the "complex" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endDictionary">endDictionary</a></td>
+<td>Handler method for the "dictionary" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endElement">endElement</a></td>
+<td>Handler called, when an ending tag is found.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endFloat">endFloat</a></td>
+<td>Handler method for the "float" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endInt">endInt</a></td>
+<td>Handler method for the "int" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endList">endList</a></td>
+<td>Handler method for the "list" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endLong">endLong</a></td>
+<td>Handler method for the "long" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endNone">endNone</a></td>
+<td>Handler method for the "none" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endPickle">endPickle</a></td>
+<td>Handler method for the "pickle" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endString">endString</a></td>
+<td>Handler method for the "string" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endTuple">endTuple</a></td>
+<td>Handler method for the "tuple" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.endUnicode">endUnicode</a></td>
+<td>Handler method for the "unicode" end tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.startDictionary">startDictionary</a></td>
+<td>Handler method for the "dictionary" start tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.startDocument">startDocument</a></td>
+<td>Handler called, when the document parsing is started.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.startElement">startElement</a></td>
+<td>Handler called, when a starting tag is found.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.startList">startList</a></td>
+<td>Handler method for the "list" start tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.startPickle">startPickle</a></td>
+<td>Handler method for the "pickle" start tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.startTuple">startTuple</a></td>
+<td>Handler method for the "tuple" start tag.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.unescape">unescape</a></td>
+<td>Public method used to unescape certain characters.</td>
+</tr><tr>
+<td><a href="#XMLHandlerBase.utf8_to_code">utf8_to_code</a></td>
+<td>Public method to convert a string to unicode and encode it for XML.</td>
+</tr>
+</table>
+<a NAME="XMLHandlerBase.__init__" ID="XMLHandlerBase.__init__"></a>
+<h4>XMLHandlerBase (Constructor)</h4>
+<b>XMLHandlerBase</b>(<i></i>)
+<p>
+ Constructor
+</p><a NAME="XMLHandlerBase._prepareBasics" ID="XMLHandlerBase._prepareBasics"></a>
+<h4>XMLHandlerBase._prepareBasics</h4>
+<b>_prepareBasics</b>(<i></i>)
+<p>
+ Protected method to prepare the parsing of XML for basic python types.
+</p><a NAME="XMLHandlerBase.characters" ID="XMLHandlerBase.characters"></a>
+<h4>XMLHandlerBase.characters</h4>
+<b>characters</b>(<i>chars</i>)
+<p>
+ Handler called for ordinary text.
+</p><dl>
+<dt><i>chars</i></dt>
+<dd>
+the scanned text (string)
+</dd>
+</dl><a NAME="XMLHandlerBase.decodedNewLines" ID="XMLHandlerBase.decodedNewLines"></a>
+<h4>XMLHandlerBase.decodedNewLines</h4>
+<b>decodedNewLines</b>(<i>text</i>)
+<p>
+ Public method to decode newlines and paragraph breaks.
+</p><dl>
+<dt><i>text</i></dt>
+<dd>
+text to decode (string or QString)
+</dd>
+</dl><a NAME="XMLHandlerBase.defaultEndElement" ID="XMLHandlerBase.defaultEndElement"></a>
+<h4>XMLHandlerBase.defaultEndElement</h4>
+<b>defaultEndElement</b>(<i></i>)
+<p>
+ Handler method for the common end tags.
+</p><a NAME="XMLHandlerBase.defaultStartElement" ID="XMLHandlerBase.defaultStartElement"></a>
+<h4>XMLHandlerBase.defaultStartElement</h4>
+<b>defaultStartElement</b>(<i>attrs</i>)
+<p>
+ Handler method for common start tags.
+</p><dl>
+<dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl><a NAME="XMLHandlerBase.endBool" ID="XMLHandlerBase.endBool"></a>
+<h4>XMLHandlerBase.endBool</h4>
+<b>endBool</b>(<i></i>)
+<p>
+ Handler method for the "bool" end tag.
+</p><a NAME="XMLHandlerBase.endComplex" ID="XMLHandlerBase.endComplex"></a>
+<h4>XMLHandlerBase.endComplex</h4>
+<b>endComplex</b>(<i></i>)
+<p>
+ Handler method for the "complex" end tag.
+</p><a NAME="XMLHandlerBase.endDictionary" ID="XMLHandlerBase.endDictionary"></a>
+<h4>XMLHandlerBase.endDictionary</h4>
+<b>endDictionary</b>(<i></i>)
+<p>
+ Handler method for the "dictionary" end tag.
+</p><a NAME="XMLHandlerBase.endElement" ID="XMLHandlerBase.endElement"></a>
+<h4>XMLHandlerBase.endElement</h4>
+<b>endElement</b>(<i>name</i>)
+<p>
+ Handler called, when an ending tag is found.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the tag (string)
+</dd>
+</dl><a NAME="XMLHandlerBase.endFloat" ID="XMLHandlerBase.endFloat"></a>
+<h4>XMLHandlerBase.endFloat</h4>
+<b>endFloat</b>(<i></i>)
+<p>
+ Handler method for the "float" end tag.
+</p><a NAME="XMLHandlerBase.endInt" ID="XMLHandlerBase.endInt"></a>
+<h4>XMLHandlerBase.endInt</h4>
+<b>endInt</b>(<i></i>)
+<p>
+ Handler method for the "int" end tag.
+</p><a NAME="XMLHandlerBase.endList" ID="XMLHandlerBase.endList"></a>
+<h4>XMLHandlerBase.endList</h4>
+<b>endList</b>(<i></i>)
+<p>
+ Handler method for the "list" end tag.
+</p><a NAME="XMLHandlerBase.endLong" ID="XMLHandlerBase.endLong"></a>
+<h4>XMLHandlerBase.endLong</h4>
+<b>endLong</b>(<i></i>)
+<p>
+ Handler method for the "long" end tag.
+</p><a NAME="XMLHandlerBase.endNone" ID="XMLHandlerBase.endNone"></a>
+<h4>XMLHandlerBase.endNone</h4>
+<b>endNone</b>(<i></i>)
+<p>
+ Handler method for the "none" end tag.
+</p><a NAME="XMLHandlerBase.endPickle" ID="XMLHandlerBase.endPickle"></a>
+<h4>XMLHandlerBase.endPickle</h4>
+<b>endPickle</b>(<i></i>)
+<p>
+ Handler method for the "pickle" end tag.
+</p><a NAME="XMLHandlerBase.endString" ID="XMLHandlerBase.endString"></a>
+<h4>XMLHandlerBase.endString</h4>
+<b>endString</b>(<i></i>)
+<p>
+ Handler method for the "string" end tag.
+</p><a NAME="XMLHandlerBase.endTuple" ID="XMLHandlerBase.endTuple"></a>
+<h4>XMLHandlerBase.endTuple</h4>
+<b>endTuple</b>(<i></i>)
+<p>
+ Handler method for the "tuple" end tag.
+</p><a NAME="XMLHandlerBase.endUnicode" ID="XMLHandlerBase.endUnicode"></a>
+<h4>XMLHandlerBase.endUnicode</h4>
+<b>endUnicode</b>(<i></i>)
+<p>
+ Handler method for the "unicode" end tag.
+</p><a NAME="XMLHandlerBase.startDictionary" ID="XMLHandlerBase.startDictionary"></a>
+<h4>XMLHandlerBase.startDictionary</h4>
+<b>startDictionary</b>(<i>attrs</i>)
+<p>
+ Handler method for the "dictionary" start tag.
+</p><dl>
+<dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl><a NAME="XMLHandlerBase.startDocument" ID="XMLHandlerBase.startDocument"></a>
+<h4>XMLHandlerBase.startDocument</h4>
+<b>startDocument</b>(<i></i>)
+<p>
+ Handler called, when the document parsing is started.
+</p><a NAME="XMLHandlerBase.startElement" ID="XMLHandlerBase.startElement"></a>
+<h4>XMLHandlerBase.startElement</h4>
+<b>startElement</b>(<i>name, attrs</i>)
+<p>
+ Handler called, when a starting tag is found.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the tag (string)
+</dd><dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl><a NAME="XMLHandlerBase.startList" ID="XMLHandlerBase.startList"></a>
+<h4>XMLHandlerBase.startList</h4>
+<b>startList</b>(<i>attrs</i>)
+<p>
+ Handler method for the "list" start tag.
+</p><dl>
+<dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl><a NAME="XMLHandlerBase.startPickle" ID="XMLHandlerBase.startPickle"></a>
+<h4>XMLHandlerBase.startPickle</h4>
+<b>startPickle</b>(<i>attrs</i>)
+<p>
+ Handler method for the "pickle" start tag.
+</p><dl>
+<dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl><a NAME="XMLHandlerBase.startTuple" ID="XMLHandlerBase.startTuple"></a>
+<h4>XMLHandlerBase.startTuple</h4>
+<b>startTuple</b>(<i>attrs</i>)
+<p>
+ Handler method for the "tuple" start tag.
+</p><dl>
+<dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl><a NAME="XMLHandlerBase.unescape" ID="XMLHandlerBase.unescape"></a>
+<h4>XMLHandlerBase.unescape</h4>
+<b>unescape</b>(<i>text, attribute = False</i>)
+<p>
+ Public method used to unescape certain characters.
+</p><dl>
+<dt><i>text</i></dt>
+<dd>
+the text to unescape (string)
+</dd><dt><i>attribute</i></dt>
+<dd>
+flag indicating unescaping is done for an attribute
+</dd>
+</dl><a NAME="XMLHandlerBase.utf8_to_code" ID="XMLHandlerBase.utf8_to_code"></a>
+<h4>XMLHandlerBase.utf8_to_code</h4>
+<b>utf8_to_code</b>(<i>text</i>)
+<p>
+ Public method to convert a string to unicode and encode it for XML.
+</p><dl>
+<dt><i>text</i></dt>
+<dd>
+the text to encode (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
