doc/api/python/buildtools.AbstractOutputWriter-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>buildtools.AbstractOutputWriter</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="buildtools-module.html">Module&nbsp;buildtools</a> ::
       
    38         Class&nbsp;AbstractOutputWriter
       
    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="buildtools.AbstractOutputWriter-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 AbstractOutputWriter</h1><span class="codelink"><a href="buildtools-pysrc.html#AbstractOutputWriter">source&nbsp;code</a></span><br /><br />
       
    56 <p>Base class which contains define an AbstractOutputWriter.</p>
       
    57 <p>The subclass must implement a convert method which compute a command list into
       
    58 some output file.</p><br /><br />
       
    59 
       
    60 <!-- ==================== INSTANCE METHODS ==================== -->
       
    61 <a name="section-InstanceMethods"></a>
       
    62 <table class="summary" border="1" cellpadding="3"
       
    63        cellspacing="0" width="100%" bgcolor="white">
       
    64 <tr bgcolor="#70b0f0" class="table-header">
       
    65   <td colspan="2" class="table-header">
       
    66     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    67       <tr valign="top">
       
    68         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    69         <td align="right" valign="top"
       
    70          ><span class="options">[<a href="#section-InstanceMethods"
       
    71          class="privatelink" onclick="toggle_private();"
       
    72          >hide private</a>]</span></td>
       
    73       </tr>
       
    74     </table>
       
    75   </td>
       
    76 </tr>
       
    77 <tr>
       
    78     <td width="15%" align="right" valign="top" class="summary">
       
    79       <span class="summary-type">&nbsp;</span>
       
    80     </td><td class="summary">
       
    81       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    82         <tr>
       
    83           <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
       
    84         <span class="summary-sig-arg">fileOut</span>)</span></td>
       
    85           <td align="right" valign="top">
       
    86             <span class="codelink"><a href="buildtools-pysrc.html#AbstractOutputWriter.__init__">source&nbsp;code</a></span>
       
    87             
       
    88           </td>
       
    89         </tr>
       
    90       </table>
       
    91       
       
    92     </td>
       
    93   </tr>
       
    94 <tr>
       
    95     <td width="15%" align="right" valign="top" class="summary">
       
    96       <span class="summary-type">&nbsp;</span>
       
    97     </td><td class="summary">
       
    98       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    99         <tr>
       
   100           <td><span class="summary-sig"><a name="write"></a><span class="summary-sig-name">write</span>(<span class="summary-sig-arg">self</span>,
       
   101         <span class="summary-sig-arg">cmdList</span>)</span><br />
       
   102       Method to override to implement format specific output.</td>
       
   103           <td align="right" valign="top">
       
   104             <span class="codelink"><a href="buildtools-pysrc.html#AbstractOutputWriter.write">source&nbsp;code</a></span>
       
   105             
       
   106           </td>
       
   107         </tr>
       
   108       </table>
       
   109       
       
   110     </td>
       
   111   </tr>
       
   112 <tr>
       
   113     <td width="15%" align="right" valign="top" class="summary">
       
   114       <span class="summary-type">&nbsp;</span>
       
   115     </td><td class="summary">
       
   116       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   117         <tr>
       
   118           <td><span class="summary-sig"><a name="writeTopLevel"></a><span class="summary-sig-name">writeTopLevel</span>(<span class="summary-sig-arg">self</span>,
       
   119         <span class="summary-sig-arg">config_list</span>,
       
   120         <span class="summary-sig-arg">spec_name</span>,
       
   121         <span class="summary-sig-arg">output_path</span>,
       
   122         <span class="summary-sig-arg">xml_file</span>)</span><br />
       
   123       Method to override to implement top level commands.</td>
       
   124           <td align="right" valign="top">
       
   125             <span class="codelink"><a href="buildtools-pysrc.html#AbstractOutputWriter.writeTopLevel">source&nbsp;code</a></span>
       
   126             
       
   127           </td>
       
   128         </tr>
       
   129       </table>
       
   130       
       
   131     </td>
       
   132   </tr>
       
   133 <tr>
       
   134     <td width="15%" align="right" valign="top" class="summary">
       
   135       <span class="summary-type">&nbsp;</span>
       
   136     </td><td class="summary">
       
   137       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   138         <tr>
       
   139           <td><span class="summary-sig"><a name="__call__"></a><span class="summary-sig-name">__call__</span>(<span class="summary-sig-arg">self</span>,
       
   140         <span class="summary-sig-arg">cmdList</span>)</span></td>
       
   141           <td align="right" valign="top">
       
   142             <span class="codelink"><a href="buildtools-pysrc.html#AbstractOutputWriter.__call__">source&nbsp;code</a></span>
       
   143             
       
   144           </td>
       
   145         </tr>
       
   146       </table>
       
   147       
       
   148     </td>
       
   149   </tr>
       
   150 <tr>
       
   151     <td width="15%" align="right" valign="top" class="summary">
       
   152       <span class="summary-type">&nbsp;</span>
       
   153     </td><td class="summary">
       
   154       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   155         <tr>
       
   156           <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   157       Close the output stream.</td>
       
   158           <td align="right" valign="top">
       
   159             <span class="codelink"><a href="buildtools-pysrc.html#AbstractOutputWriter.close">source&nbsp;code</a></span>
       
   160             
       
   161           </td>
       
   162         </tr>
       
   163       </table>
       
   164       
       
   165     </td>
       
   166   </tr>
       
   167 </table>
       
   168 <!-- ==================== NAVIGATION BAR ==================== -->
       
   169 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   170        bgcolor="#a0c0ff" cellspacing="0">
       
   171   <tr valign="middle">
       
   172 
       
   173   <!-- Tree link -->
       
   174       <th>&nbsp;&nbsp;&nbsp;<a
       
   175         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   176 
       
   177   <!-- Index link -->
       
   178       <th>&nbsp;&nbsp;&nbsp;<a
       
   179         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   180 
       
   181   <!-- Help link -->
       
   182       <th>&nbsp;&nbsp;&nbsp;<a
       
   183         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   184 
       
   185       <th class="navbar" width="100%"></th>
       
   186   </tr>
       
   187 </table>
       
   188 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   189   <tr>
       
   190     <td align="left" class="footer">
       
   191     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   192     </td>
       
   193     <td align="right" class="footer">
       
   194       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   195     </td>
       
   196   </tr>
       
   197 </table>
       
   198 
       
   199 <script type="text/javascript">
       
   200   <!--
       
   201   // Private objects are initially displayed (because if
       
   202   // javascript is turned off then we want them to be
       
   203   // visible); but by default, we want to hide them.  So hide
       
   204   // them unless we have a cookie that says to show them.
       
   205   checkCookie()
       
   206   // -->
       
   207 </script>
       
   208   
       
   209 </body>
       
   210 </html>