doc/api/python/log2xml.ContentWriter-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>log2xml.ContentWriter</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="log2xml-module.html">Module&nbsp;log2xml</a> ::
       
    38         Class&nbsp;ContentWriter
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="log2xml.ContentWriter-class.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Class ContentWriter</h1><span class="codelink"><a href="log2xml-pysrc.html#ContentWriter">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57 xml.sax.handler.ContentHandler --+
       
    58                                  |
       
    59                                 <strong class="uidshort">ContentWriter</strong>
       
    60 </pre>
       
    61 
       
    62 <hr />
       
    63 SAX Content writer. Parse and write an XML file.<br /><br />
       
    64 
       
    65 <!-- ==================== INSTANCE METHODS ==================== -->
       
    66 <a name="section-InstanceMethods"></a>
       
    67 <table class="summary" border="1" cellpadding="3"
       
    68        cellspacing="0" width="100%" bgcolor="white">
       
    69 <tr bgcolor="#70b0f0" class="table-header">
       
    70   <td colspan="2" class="table-header">
       
    71     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    72       <tr valign="top">
       
    73         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    74         <td align="right" valign="top"
       
    75          ><span class="options">[<a href="#section-InstanceMethods"
       
    76          class="privatelink" onclick="toggle_private();"
       
    77          >hide private</a>]</span></td>
       
    78       </tr>
       
    79     </table>
       
    80   </td>
       
    81 </tr>
       
    82 <tr>
       
    83     <td width="15%" align="right" valign="top" class="summary">
       
    84       <span class="summary-type">&nbsp;</span>
       
    85     </td><td class="summary">
       
    86       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    87         <tr>
       
    88           <td><span class="summary-sig"><a href="log2xml.ContentWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    89         <span class="summary-sig-arg">os</span>,
       
    90         <span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span></td>
       
    91           <td align="right" valign="top">
       
    92             <span class="codelink"><a href="log2xml-pysrc.html#ContentWriter.__init__">source&nbsp;code</a></span>
       
    93             
       
    94           </td>
       
    95         </tr>
       
    96       </table>
       
    97       
       
    98     </td>
       
    99   </tr>
       
   100 <tr>
       
   101     <td width="15%" align="right" valign="top" class="summary">
       
   102       <span class="summary-type">&nbsp;</span>
       
   103     </td><td class="summary">
       
   104       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   105         <tr>
       
   106           <td><span class="summary-sig"><a href="log2xml.ContentWriter-class.html#startElement" class="summary-sig-name">startElement</a>(<span class="summary-sig-arg">self</span>,
       
   107         <span class="summary-sig-arg">name</span>,
       
   108         <span class="summary-sig-arg">attrs</span>)</span><br />
       
   109       Signals the start of an element in non-namespace mode.</td>
       
   110           <td align="right" valign="top">
       
   111             <span class="codelink"><a href="log2xml-pysrc.html#ContentWriter.startElement">source&nbsp;code</a></span>
       
   112             
       
   113           </td>
       
   114         </tr>
       
   115       </table>
       
   116       
       
   117     </td>
       
   118   </tr>
       
   119 <tr>
       
   120     <td width="15%" align="right" valign="top" class="summary">
       
   121       <span class="summary-type">&nbsp;</span>
       
   122     </td><td class="summary">
       
   123       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   124         <tr>
       
   125           <td><span class="summary-sig"><a href="log2xml.ContentWriter-class.html#endElement" class="summary-sig-name">endElement</a>(<span class="summary-sig-arg">self</span>,
       
   126         <span class="summary-sig-arg">name</span>)</span><br />
       
   127       Signals the end of an element in non-namespace mode.</td>
       
   128           <td align="right" valign="top">
       
   129             <span class="codelink"><a href="log2xml-pysrc.html#ContentWriter.endElement">source&nbsp;code</a></span>
       
   130             
       
   131           </td>
       
   132         </tr>
       
   133       </table>
       
   134       
       
   135     </td>
       
   136   </tr>
       
   137 <tr>
       
   138     <td width="15%" align="right" valign="top" class="summary">
       
   139       <span class="summary-type">&nbsp;</span>
       
   140     </td><td class="summary">
       
   141       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   142         <tr>
       
   143           <td><span class="summary-sig"><a href="log2xml.ContentWriter-class.html#characters" class="summary-sig-name">characters</a>(<span class="summary-sig-arg">self</span>,
       
   144         <span class="summary-sig-arg">content</span>)</span><br />
       
   145       Receive notification of character data.</td>
       
   146           <td align="right" valign="top">
       
   147             <span class="codelink"><a href="log2xml-pysrc.html#ContentWriter.characters">source&nbsp;code</a></span>
       
   148             
       
   149           </td>
       
   150         </tr>
       
   151       </table>
       
   152       
       
   153     </td>
       
   154   </tr>
       
   155   <tr>
       
   156     <td colspan="2" class="summary">
       
   157     <p class="indent-wrapped-lines"><b>Inherited from <code>xml.sax.handler.ContentHandler</code></b>:
       
   158       <code>endDocument</code>,
       
   159       <code>endElementNS</code>,
       
   160       <code>endPrefixMapping</code>,
       
   161       <code>ignorableWhitespace</code>,
       
   162       <code>processingInstruction</code>,
       
   163       <code>setDocumentLocator</code>,
       
   164       <code>skippedEntity</code>,
       
   165       <code>startDocument</code>,
       
   166       <code>startElementNS</code>,
       
   167       <code>startPrefixMapping</code>
       
   168       </p>
       
   169     </td>
       
   170   </tr>
       
   171 </table>
       
   172 <!-- ==================== METHOD DETAILS ==================== -->
       
   173 <a name="section-MethodDetails"></a>
       
   174 <table class="details" border="1" cellpadding="3"
       
   175        cellspacing="0" width="100%" bgcolor="white">
       
   176 <tr bgcolor="#70b0f0" class="table-header">
       
   177   <td colspan="2" class="table-header">
       
   178     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   179       <tr valign="top">
       
   180         <td align="left"><span class="table-header">Method Details</span></td>
       
   181         <td align="right" valign="top"
       
   182          ><span class="options">[<a href="#section-MethodDetails"
       
   183          class="privatelink" onclick="toggle_private();"
       
   184          >hide private</a>]</span></td>
       
   185       </tr>
       
   186     </table>
       
   187   </td>
       
   188 </tr>
       
   189 </table>
       
   190 <a name="__init__"></a>
       
   191 <div>
       
   192 <table class="details" border="1" cellpadding="3"
       
   193        cellspacing="0" width="100%" bgcolor="white">
       
   194 <tr><td>
       
   195   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   196   <tr valign="top"><td>
       
   197   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   198         <span class="sig-arg">os</span>,
       
   199         <span class="sig-arg">indent</span>=<span class="sig-default">&quot;&quot;</span>)</span>
       
   200     <br /><em class="fname">(Constructor)</em>
       
   201   </h3>
       
   202   </td><td align="right" valign="top"
       
   203     ><span class="codelink"><a href="log2xml-pysrc.html#ContentWriter.__init__">source&nbsp;code</a></span>&nbsp;
       
   204     </td>
       
   205   </table>
       
   206   
       
   207   
       
   208   <dl class="fields">
       
   209     <dt>Overrides:
       
   210       xml.sax.handler.ContentHandler.__init__
       
   211     </dt>
       
   212   </dl>
       
   213 </td></tr></table>
       
   214 </div>
       
   215 <a name="startElement"></a>
       
   216 <div>
       
   217 <table class="details" border="1" cellpadding="3"
       
   218        cellspacing="0" width="100%" bgcolor="white">
       
   219 <tr><td>
       
   220   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   221   <tr valign="top"><td>
       
   222   <h3 class="epydoc"><span class="sig"><span class="sig-name">startElement</span>(<span class="sig-arg">self</span>,
       
   223         <span class="sig-arg">name</span>,
       
   224         <span class="sig-arg">attrs</span>)</span>
       
   225   </h3>
       
   226   </td><td align="right" valign="top"
       
   227     ><span class="codelink"><a href="log2xml-pysrc.html#ContentWriter.startElement">source&nbsp;code</a></span>&nbsp;
       
   228     </td>
       
   229   </table>
       
   230   
       
   231   <p>Signals the start of an element in non-namespace mode.</p>
       
   232 <p>The name parameter contains the raw XML 1.0 name of the
       
   233 element type as a string and the attrs parameter holds an
       
   234 instance of the Attributes class containing the attributes of
       
   235 the element.</p>
       
   236   <dl class="fields">
       
   237     <dt>Overrides:
       
   238       xml.sax.handler.ContentHandler.startElement
       
   239         <dd><em class="note">(inherited documentation)</em></dd>
       
   240     </dt>
       
   241   </dl>
       
   242 </td></tr></table>
       
   243 </div>
       
   244 <a name="endElement"></a>
       
   245 <div>
       
   246 <table class="details" border="1" cellpadding="3"
       
   247        cellspacing="0" width="100%" bgcolor="white">
       
   248 <tr><td>
       
   249   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   250   <tr valign="top"><td>
       
   251   <h3 class="epydoc"><span class="sig"><span class="sig-name">endElement</span>(<span class="sig-arg">self</span>,
       
   252         <span class="sig-arg">name</span>)</span>
       
   253   </h3>
       
   254   </td><td align="right" valign="top"
       
   255     ><span class="codelink"><a href="log2xml-pysrc.html#ContentWriter.endElement">source&nbsp;code</a></span>&nbsp;
       
   256     </td>
       
   257   </table>
       
   258   
       
   259   <p>Signals the end of an element in non-namespace mode.</p>
       
   260 <p>The name parameter contains the name of the element type, just
       
   261 as with the startElement event.</p>
       
   262   <dl class="fields">
       
   263     <dt>Overrides:
       
   264       xml.sax.handler.ContentHandler.endElement
       
   265         <dd><em class="note">(inherited documentation)</em></dd>
       
   266     </dt>
       
   267   </dl>
       
   268 </td></tr></table>
       
   269 </div>
       
   270 <a name="characters"></a>
       
   271 <div>
       
   272 <table class="details" border="1" cellpadding="3"
       
   273        cellspacing="0" width="100%" bgcolor="white">
       
   274 <tr><td>
       
   275   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   276   <tr valign="top"><td>
       
   277   <h3 class="epydoc"><span class="sig"><span class="sig-name">characters</span>(<span class="sig-arg">self</span>,
       
   278         <span class="sig-arg">content</span>)</span>
       
   279   </h3>
       
   280   </td><td align="right" valign="top"
       
   281     ><span class="codelink"><a href="log2xml-pysrc.html#ContentWriter.characters">source&nbsp;code</a></span>&nbsp;
       
   282     </td>
       
   283   </table>
       
   284   
       
   285   <p>Receive notification of character data.</p>
       
   286 <p>The Parser will call this method to report each chunk of
       
   287 character data. SAX parsers may return all contiguous
       
   288 character data in a single chunk, or they may split it into
       
   289 several chunks; however, all of the characters in any single
       
   290 event must come from the same external entity so that the
       
   291 Locator provides useful information.</p>
       
   292   <dl class="fields">
       
   293     <dt>Overrides:
       
   294       xml.sax.handler.ContentHandler.characters
       
   295         <dd><em class="note">(inherited documentation)</em></dd>
       
   296     </dt>
       
   297   </dl>
       
   298 </td></tr></table>
       
   299 </div>
       
   300 <br />
       
   301 <!-- ==================== NAVIGATION BAR ==================== -->
       
   302 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   303        bgcolor="#a0c0ff" cellspacing="0">
       
   304   <tr valign="middle">
       
   305 
       
   306   <!-- Tree link -->
       
   307       <th>&nbsp;&nbsp;&nbsp;<a
       
   308         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   309 
       
   310   <!-- Index link -->
       
   311       <th>&nbsp;&nbsp;&nbsp;<a
       
   312         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   313 
       
   314   <!-- Help link -->
       
   315       <th>&nbsp;&nbsp;&nbsp;<a
       
   316         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   317 
       
   318       <th class="navbar" width="100%"></th>
       
   319   </tr>
       
   320 </table>
       
   321 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   322   <tr>
       
   323     <td align="left" class="footer">
       
   324     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:19 2009
       
   325     </td>
       
   326     <td align="right" class="footer">
       
   327       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   328     </td>
       
   329   </tr>
       
   330 </table>
       
   331 
       
   332 <script type="text/javascript">
       
   333   <!--
       
   334   // Private objects are initially displayed (because if
       
   335   // javascript is turned off then we want them to be
       
   336   // visible); but by default, we want to hide them.  So hide
       
   337   // them unless we have a cookie that says to show them.
       
   338   checkCookie()
       
   339   // -->
       
   340 </script>
       
   341   
       
   342 </body>
       
   343 </html>