twisted.xish.domish.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.xish.domish</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.xish.html">Package xish</a> ::
Module domish
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.xish.domish.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.xish.domish</h2>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish._ListSerializer.html"><code>_ListSerializer</code></a></b></td>
<td>Internal class which serializes an Element tree into a buffer</td></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish._Serializer.html"><code>_Serializer</code></a></b></td>
<td>Internal class which serializes an Element tree into a buffer</td></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish.Element.html"><code>Element</code></a></b></td>
<td>Object representing a container (a.k.a.</td></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish.ExpatElementStream.html"><code>ExpatElementStream</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish.Namespace.html"><code>Namespace</code></a></b></td>
<td>Convenience object for tracking namespace declarations</td></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish.SerializedXML.html"><code>SerializedXML</code></a></b></td>
<td>Marker class for pre-serialized XML in the DOM</td></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish._Serializer.html"><code>SerializerClass</code></a></b></td>
<td>Internal class which serializes an Element tree into a buffer</td></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish.SuxElementStream.html"><code>SuxElementStream</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
<b><a href="twisted.xish.domish.ParserError.html"><code>ParserError</code></a></b></td>
<td>Exception thrown when a parsing error occurs</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.html#_splitPrefix" class="summary-sig-name"><code>_splitPrefix</code></a>(<span class=summary-sig-arg>name</span>)</span></code>
<br />
Internal method for splitting a prefixed Element name into its
respective parts</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.html#elementStream" class="summary-sig-name"><code>elementStream</code></a>()</span></code>
<br />
Preferred method to construct an ElementStream</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.html#escapeToXml" class="summary-sig-name"><code>escapeToXml</code></a>(<span class=summary-sig-arg>text</span>,
<span class=summary-sig-arg>isattrib</span>)</span></code>
<br />
Escape text to proper XML form, per section 2.3 in the XML
specification.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.html#generateElementsNamed" class="summary-sig-name"><code>generateElementsNamed</code></a>(<span class=summary-sig-arg>list</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Filters Element items in a list with matching name, regardless of
URI</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.html#generateElementsQNamed" class="summary-sig-name"><code>generateElementsQNamed</code></a>(<span class=summary-sig-arg>list</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>uri</span>)</span></code>
<br />
Filters Element items in a list with matching name and URI</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.html#generateOnlyKlass" class="summary-sig-name"><code>generateOnlyKlass</code></a>(<span class=summary-sig-arg>list</span>,
<span class=summary-sig-arg>klass</span>)</span></code>
<br />
Filters items in a list by class</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="unescapeFromXml"></a><span class="summary-sig"><span class="summary-sig-name">unescapeFromXml</span>(<span class=summary-sig-arg>text</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="_splitPrefix"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_splitPrefix</span>(<span class=sig-arg>name</span>)</span>
</h3>
Internal method for splitting a prefixed Element name into its
respective parts
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="elementStream"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">elementStream</span>()</span>
</h3>
<p>Preferred method to construct an ElementStream</p>
Uses Expat-based stream if available, and falls back to Sux if
necessary.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="escapeToXml"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">escapeToXml</span>(<span class=sig-arg>text</span>,
<span class=sig-arg>isattrib</span>=<span class=sig-default>0</span>)</span>
</h3>
Escape text to proper XML form, per section 2.3 in the XML
specification.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>text</b></code> -
Text to escape
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>isattrib</b></code> -
Triggers escaping of characters necessary for use as attribute
values
<br /><i>
(type=<code>Boolean</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="generateElementsNamed"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">generateElementsNamed</span>(<span class=sig-arg>list</span>,
<span class=sig-arg>name</span>)</span>
</h3>
Filters Element items in a list with matching name, regardless of
URI
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="generateElementsQNamed"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">generateElementsQNamed</span>(<span class=sig-arg>list</span>,
<span class=sig-arg>name</span>,
<span class=sig-arg>uri</span>)</span>
</h3>
Filters Element items in a list with matching name and URI
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="generateOnlyKlass"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">generateOnlyKlass</span>(<span class=sig-arg>list</span>,
<span class=sig-arg>klass</span>)</span>
</h3>
Filters items in a list by class
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:07 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>