doc/api/python/buildtools.Delete-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.Delete</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;Delete
       
    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.Delete-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 Delete</h1><span class="codelink"><a href="buildtools-pysrc.html#Delete">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57 object --+        
       
    58          |        
       
    59       <a href="buildtools.Task-class.html">Task</a> --+    
       
    60              |    
       
    61        <a href="buildtools.AntTask-class.html">AntTask</a> --+
       
    62                  |
       
    63 object --+       |
       
    64          |       |
       
    65       <a href="buildtools.Task-class.html">Task</a> --+   |
       
    66              |   |
       
    67        <a href="buildtools.Command-class.html">Command</a> --+
       
    68                  |
       
    69                 <strong class="uidshort">Delete</strong>
       
    70 </pre>
       
    71 
       
    72 <hr />
       
    73 Implements file/directory deleletion mechanism.<br /><br />
       
    74 
       
    75 <!-- ==================== INSTANCE METHODS ==================== -->
       
    76 <a name="section-InstanceMethods"></a>
       
    77 <table class="summary" border="1" cellpadding="3"
       
    78        cellspacing="0" width="100%" bgcolor="white">
       
    79 <tr bgcolor="#70b0f0" class="table-header">
       
    80   <td colspan="2" class="table-header">
       
    81     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    82       <tr valign="top">
       
    83         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    84         <td align="right" valign="top"
       
    85          ><span class="options">[<a href="#section-InstanceMethods"
       
    86          class="privatelink" onclick="toggle_private();"
       
    87          >hide private</a>]</span></td>
       
    88       </tr>
       
    89     </table>
       
    90   </td>
       
    91 </tr>
       
    92 <tr>
       
    93     <td width="15%" align="right" valign="top" class="summary">
       
    94       <span class="summary-type">&nbsp;</span>
       
    95     </td><td class="summary">
       
    96       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    97         <tr>
       
    98           <td><span class="summary-sig"><a href="buildtools.Delete-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    99         <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
       
   100         <span class="summary-sig-arg">dirname</span>=<span class="summary-sig-default">None</span>)</span><br />
       
   101       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
       
   102           <td align="right" valign="top">
       
   103             <span class="codelink"><a href="buildtools-pysrc.html#Delete.__init__">source&nbsp;code</a></span>
       
   104             
       
   105           </td>
       
   106         </tr>
       
   107       </table>
       
   108       
       
   109     </td>
       
   110   </tr>
       
   111 <tr>
       
   112     <td width="15%" align="right" valign="top" class="summary">
       
   113       <span class="summary-type">&nbsp;</span>
       
   114     </td><td class="summary">
       
   115       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   116         <tr>
       
   117           <td><span class="summary-sig"><a href="buildtools.Delete-class.html#toAntTask" class="summary-sig-name">toAntTask</a>(<span class="summary-sig-arg">self</span>,
       
   118         <span class="summary-sig-arg">doc</span>)</span><br />
       
   119       Render the delete as an Ant task.</td>
       
   120           <td align="right" valign="top">
       
   121             <span class="codelink"><a href="buildtools-pysrc.html#Delete.toAntTask">source&nbsp;code</a></span>
       
   122             
       
   123           </td>
       
   124         </tr>
       
   125       </table>
       
   126       
       
   127     </td>
       
   128   </tr>
       
   129   <tr>
       
   130     <td colspan="2" class="summary">
       
   131     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="buildtools.Command-class.html">Command</a></code></b>:
       
   132       <code><a href="buildtools.Command-class.html#__repr__">__repr__</a></code>,
       
   133       <code><a href="buildtools.Command-class.html#addArg">addArg</a></code>,
       
   134       <code><a href="buildtools.Command-class.html#cmd">cmd</a></code>,
       
   135       <code><a href="buildtools.Command-class.html#executable">executable</a></code>,
       
   136       <code><a href="buildtools.Command-class.html#jobId">jobId</a></code>,
       
   137       <code><a href="buildtools.Command-class.html#name">name</a></code>,
       
   138       <code><a href="buildtools.Command-class.html#path">path</a></code>,
       
   139       <code><a href="buildtools.Command-class.html#setJobId">setJobId</a></code>,
       
   140       <code><a href="buildtools.Command-class.html#setStage">setStage</a></code>,
       
   141       <code><a href="buildtools.Command-class.html#stage">stage</a></code>
       
   142       </p>
       
   143     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   144       <code>__delattr__</code>,
       
   145       <code>__getattribute__</code>,
       
   146       <code>__hash__</code>,
       
   147       <code>__new__</code>,
       
   148       <code>__reduce__</code>,
       
   149       <code>__reduce_ex__</code>,
       
   150       <code>__setattr__</code>,
       
   151       <code>__str__</code>
       
   152       </p>
       
   153     </td>
       
   154   </tr>
       
   155 </table>
       
   156 <!-- ==================== PROPERTIES ==================== -->
       
   157 <a name="section-Properties"></a>
       
   158 <table class="summary" border="1" cellpadding="3"
       
   159        cellspacing="0" width="100%" bgcolor="white">
       
   160 <tr bgcolor="#70b0f0" class="table-header">
       
   161   <td colspan="2" class="table-header">
       
   162     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   163       <tr valign="top">
       
   164         <td align="left"><span class="table-header">Properties</span></td>
       
   165         <td align="right" valign="top"
       
   166          ><span class="options">[<a href="#section-Properties"
       
   167          class="privatelink" onclick="toggle_private();"
       
   168          >hide private</a>]</span></td>
       
   169       </tr>
       
   170     </table>
       
   171   </td>
       
   172 </tr>
       
   173   <tr>
       
   174     <td colspan="2" class="summary">
       
   175     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   176       <code>__class__</code>
       
   177       </p>
       
   178     </td>
       
   179   </tr>
       
   180 </table>
       
   181 <!-- ==================== METHOD DETAILS ==================== -->
       
   182 <a name="section-MethodDetails"></a>
       
   183 <table class="details" border="1" cellpadding="3"
       
   184        cellspacing="0" width="100%" bgcolor="white">
       
   185 <tr bgcolor="#70b0f0" class="table-header">
       
   186   <td colspan="2" class="table-header">
       
   187     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   188       <tr valign="top">
       
   189         <td align="left"><span class="table-header">Method Details</span></td>
       
   190         <td align="right" valign="top"
       
   191          ><span class="options">[<a href="#section-MethodDetails"
       
   192          class="privatelink" onclick="toggle_private();"
       
   193          >hide private</a>]</span></td>
       
   194       </tr>
       
   195     </table>
       
   196   </td>
       
   197 </tr>
       
   198 </table>
       
   199 <a name="__init__"></a>
       
   200 <div>
       
   201 <table class="details" border="1" cellpadding="3"
       
   202        cellspacing="0" width="100%" bgcolor="white">
       
   203 <tr><td>
       
   204   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   205   <tr valign="top"><td>
       
   206   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   207         <span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
       
   208         <span class="sig-arg">dirname</span>=<span class="sig-default">None</span>)</span>
       
   209     <br /><em class="fname">(Constructor)</em>
       
   210   </h3>
       
   211   </td><td align="right" valign="top"
       
   212     ><span class="codelink"><a href="buildtools-pysrc.html#Delete.__init__">source&nbsp;code</a></span>&nbsp;
       
   213     </td>
       
   214   </table>
       
   215   
       
   216   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
       
   217   <dl class="fields">
       
   218     <dt>Overrides:
       
   219       <a href="buildtools.Command-class.html#__init__">Command.__init__</a>
       
   220     </dt>
       
   221   </dl>
       
   222 </td></tr></table>
       
   223 </div>
       
   224 <a name="toAntTask"></a>
       
   225 <div>
       
   226 <table class="details" border="1" cellpadding="3"
       
   227        cellspacing="0" width="100%" bgcolor="white">
       
   228 <tr><td>
       
   229   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   230   <tr valign="top"><td>
       
   231   <h3 class="epydoc"><span class="sig"><span class="sig-name">toAntTask</span>(<span class="sig-arg">self</span>,
       
   232         <span class="sig-arg">doc</span>)</span>
       
   233   </h3>
       
   234   </td><td align="right" valign="top"
       
   235     ><span class="codelink"><a href="buildtools-pysrc.html#Delete.toAntTask">source&nbsp;code</a></span>&nbsp;
       
   236     </td>
       
   237   </table>
       
   238   
       
   239   Render the delete as an Ant task.
       
   240   <dl class="fields">
       
   241     <dt>Overrides:
       
   242       <a href="buildtools.AntTask-class.html#toAntTask">AntTask.toAntTask</a>
       
   243     </dt>
       
   244   </dl>
       
   245 </td></tr></table>
       
   246 </div>
       
   247 <br />
       
   248 <!-- ==================== NAVIGATION BAR ==================== -->
       
   249 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   250        bgcolor="#a0c0ff" cellspacing="0">
       
   251   <tr valign="middle">
       
   252 
       
   253   <!-- Tree link -->
       
   254       <th>&nbsp;&nbsp;&nbsp;<a
       
   255         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   256 
       
   257   <!-- Index link -->
       
   258       <th>&nbsp;&nbsp;&nbsp;<a
       
   259         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   260 
       
   261   <!-- Help link -->
       
   262       <th>&nbsp;&nbsp;&nbsp;<a
       
   263         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   264 
       
   265       <th class="navbar" width="100%"></th>
       
   266   </tr>
       
   267 </table>
       
   268 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   269   <tr>
       
   270     <td align="left" class="footer">
       
   271     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   272     </td>
       
   273     <td align="right" class="footer">
       
   274       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   275     </td>
       
   276   </tr>
       
   277 </table>
       
   278 
       
   279 <script type="text/javascript">
       
   280   <!--
       
   281   // Private objects are initially displayed (because if
       
   282   // javascript is turned off then we want them to be
       
   283   // visible); but by default, we want to hide them.  So hide
       
   284   // them unless we have a cookie that says to show them.
       
   285   checkCookie()
       
   286   // -->
       
   287 </script>
       
   288   
       
   289 </body>
       
   290 </html>