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