doc/api/python/imaker.api.IMakerConfigScanner-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>imaker.api.IMakerConfigScanner</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="imaker-module.html">Package&nbsp;imaker</a> ::
       
    38         <a href="imaker.api-module.html">Module&nbsp;api</a> ::
       
    39         Class&nbsp;IMakerConfigScanner
       
    40       </span>
       
    41     </td>
       
    42     <td>
       
    43       <table cellpadding="0" cellspacing="0">
       
    44         <!-- hide/show private -->
       
    45         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    46     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    47         <tr><td align="right"><span class="options"
       
    48             >[<a href="frames.html" target="_top">frames</a
       
    49             >]&nbsp;|&nbsp;<a href="imaker.api.IMakerConfigScanner-class.html"
       
    50             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    51       </table>
       
    52     </td>
       
    53   </tr>
       
    54 </table>
       
    55 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    56 <h1 class="epydoc">Class IMakerConfigScanner</h1><span class="codelink"><a href="imaker.api-pysrc.html#IMakerConfigScanner">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58                object --+    
       
    59                         |    
       
    60 <a href="fileutils.AbstractScanner-class.html">fileutils.AbstractScanner</a> --+
       
    61                             |
       
    62                            <strong class="uidshort">IMakerConfigScanner</strong>
       
    63 </pre>
       
    64 
       
    65 <hr />
       
    66 Specialize the abstract filescanner to support detection of the configuration.<br /><br />
       
    67 
       
    68 <!-- ==================== INSTANCE METHODS ==================== -->
       
    69 <a name="section-InstanceMethods"></a>
       
    70 <table class="summary" border="1" cellpadding="3"
       
    71        cellspacing="0" width="100%" bgcolor="white">
       
    72 <tr bgcolor="#70b0f0" class="table-header">
       
    73   <td colspan="2" class="table-header">
       
    74     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    75       <tr valign="top">
       
    76         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    77         <td align="right" valign="top"
       
    78          ><span class="options">[<a href="#section-InstanceMethods"
       
    79          class="privatelink" onclick="toggle_private();"
       
    80          >hide private</a>]</span></td>
       
    81       </tr>
       
    82     </table>
       
    83   </td>
       
    84 </tr>
       
    85 <tr>
       
    86     <td width="15%" align="right" valign="top" class="summary">
       
    87       <span class="summary-type">&nbsp;</span>
       
    88     </td><td class="summary">
       
    89       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    90         <tr>
       
    91           <td><span class="summary-sig"><a href="imaker.api.IMakerConfigScanner-class.html#scan" class="summary-sig-name">scan</a>(<span class="summary-sig-arg">self</span>)</span><br />
       
    92       Implement scanning of relevant configuration.</td>
       
    93           <td align="right" valign="top">
       
    94             <span class="codelink"><a href="imaker.api-pysrc.html#IMakerConfigScanner.scan">source&nbsp;code</a></span>
       
    95             
       
    96           </td>
       
    97         </tr>
       
    98       </table>
       
    99       
       
   100     </td>
       
   101   </tr>
       
   102   <tr>
       
   103     <td colspan="2" class="summary">
       
   104     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="fileutils.AbstractScanner-class.html">fileutils.AbstractScanner</a></code></b>:
       
   105       <code><a href="fileutils.AbstractScanner-class.html#__init__">__init__</a></code>,
       
   106       <code><a href="fileutils.AbstractScanner-class.html#__repr__">__repr__</a></code>,
       
   107       <code><a href="fileutils.AbstractScanner-class.html#__str__">__str__</a></code>,
       
   108       <code><a href="fileutils.AbstractScanner-class.html#add_exclude">add_exclude</a></code>,
       
   109       <code><a href="fileutils.AbstractScanner-class.html#add_exclude_file">add_exclude_file</a></code>,
       
   110       <code><a href="fileutils.AbstractScanner-class.html#add_filetype">add_filetype</a></code>,
       
   111       <code><a href="fileutils.AbstractScanner-class.html#add_include">add_include</a></code>,
       
   112       <code><a href="fileutils.AbstractScanner-class.html#add_selector">add_selector</a></code>,
       
   113       <code><a href="fileutils.AbstractScanner-class.html#is_excluded">is_excluded</a></code>,
       
   114       <code><a href="fileutils.AbstractScanner-class.html#is_filetype">is_filetype</a></code>,
       
   115       <code><a href="fileutils.AbstractScanner-class.html#is_included">is_included</a></code>,
       
   116       <code><a href="fileutils.AbstractScanner-class.html#is_selected">is_selected</a></code>,
       
   117       <code><a href="fileutils.AbstractScanner-class.html#match">match</a></code>,
       
   118       <code><a href="fileutils.AbstractScanner-class.html#test_path">test_path</a></code>
       
   119       </p>
       
   120     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   121       <code>__delattr__</code>,
       
   122       <code>__getattribute__</code>,
       
   123       <code>__hash__</code>,
       
   124       <code>__new__</code>,
       
   125       <code>__reduce__</code>,
       
   126       <code>__reduce_ex__</code>,
       
   127       <code>__setattr__</code>
       
   128       </p>
       
   129     </td>
       
   130   </tr>
       
   131 </table>
       
   132 <!-- ==================== PROPERTIES ==================== -->
       
   133 <a name="section-Properties"></a>
       
   134 <table class="summary" border="1" cellpadding="3"
       
   135        cellspacing="0" width="100%" bgcolor="white">
       
   136 <tr bgcolor="#70b0f0" class="table-header">
       
   137   <td colspan="2" class="table-header">
       
   138     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   139       <tr valign="top">
       
   140         <td align="left"><span class="table-header">Properties</span></td>
       
   141         <td align="right" valign="top"
       
   142          ><span class="options">[<a href="#section-Properties"
       
   143          class="privatelink" onclick="toggle_private();"
       
   144          >hide private</a>]</span></td>
       
   145       </tr>
       
   146     </table>
       
   147   </td>
       
   148 </tr>
       
   149   <tr>
       
   150     <td colspan="2" class="summary">
       
   151     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   152       <code>__class__</code>
       
   153       </p>
       
   154     </td>
       
   155   </tr>
       
   156 </table>
       
   157 <!-- ==================== METHOD DETAILS ==================== -->
       
   158 <a name="section-MethodDetails"></a>
       
   159 <table class="details" border="1" cellpadding="3"
       
   160        cellspacing="0" width="100%" bgcolor="white">
       
   161 <tr bgcolor="#70b0f0" class="table-header">
       
   162   <td colspan="2" class="table-header">
       
   163     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   164       <tr valign="top">
       
   165         <td align="left"><span class="table-header">Method Details</span></td>
       
   166         <td align="right" valign="top"
       
   167          ><span class="options">[<a href="#section-MethodDetails"
       
   168          class="privatelink" onclick="toggle_private();"
       
   169          >hide private</a>]</span></td>
       
   170       </tr>
       
   171     </table>
       
   172   </td>
       
   173 </tr>
       
   174 </table>
       
   175 <a name="scan"></a>
       
   176 <div>
       
   177 <table class="details" border="1" cellpadding="3"
       
   178        cellspacing="0" width="100%" bgcolor="white">
       
   179 <tr><td>
       
   180   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   181   <tr valign="top"><td>
       
   182   <h3 class="epydoc"><span class="sig"><span class="sig-name">scan</span>(<span class="sig-arg">self</span>)</span>
       
   183   </h3>
       
   184   </td><td align="right" valign="top"
       
   185     ><span class="codelink"><a href="imaker.api-pysrc.html#IMakerConfigScanner.scan">source&nbsp;code</a></span>&nbsp;
       
   186     </td>
       
   187   </table>
       
   188   
       
   189   Implement scanning of relevant configuration.
       
   190   <dl class="fields">
       
   191     <dt>Overrides:
       
   192       <a href="fileutils.AbstractScanner-class.html#scan">fileutils.AbstractScanner.scan</a>
       
   193     </dt>
       
   194   </dl>
       
   195 </td></tr></table>
       
   196 </div>
       
   197 <br />
       
   198 <!-- ==================== NAVIGATION BAR ==================== -->
       
   199 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   200        bgcolor="#a0c0ff" cellspacing="0">
       
   201   <tr valign="middle">
       
   202 
       
   203   <!-- Tree link -->
       
   204       <th>&nbsp;&nbsp;&nbsp;<a
       
   205         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   206 
       
   207   <!-- Index link -->
       
   208       <th>&nbsp;&nbsp;&nbsp;<a
       
   209         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   210 
       
   211   <!-- Help link -->
       
   212       <th>&nbsp;&nbsp;&nbsp;<a
       
   213         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   214 
       
   215       <th class="navbar" width="100%"></th>
       
   216   </tr>
       
   217 </table>
       
   218 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   219   <tr>
       
   220     <td align="left" class="footer">
       
   221     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009
       
   222     </td>
       
   223     <td align="right" class="footer">
       
   224       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   225     </td>
       
   226   </tr>
       
   227 </table>
       
   228 
       
   229 <script type="text/javascript">
       
   230   <!--
       
   231   // Private objects are initially displayed (because if
       
   232   // javascript is turned off then we want them to be
       
   233   // visible); but by default, we want to hide them.  So hide
       
   234   // them unless we have a cookie that says to show them.
       
   235   checkCookie()
       
   236   // -->
       
   237 </script>
       
   238   
       
   239 </body>
       
   240 </html>