doc/api/python/version.Version-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>version.Version</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="version-module.html">Module&nbsp;version</a> ::
       
    38         Class&nbsp;Version
       
    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="version.Version-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 Version</h1><span class="codelink"><a href="version-pysrc.html#Version">source&nbsp;code</a></span><br /><br />
       
    56 Version template.<br /><br />
       
    57 
       
    58 <!-- ==================== INSTANCE METHODS ==================== -->
       
    59 <a name="section-InstanceMethods"></a>
       
    60 <table class="summary" border="1" cellpadding="3"
       
    61        cellspacing="0" width="100%" bgcolor="white">
       
    62 <tr bgcolor="#70b0f0" class="table-header">
       
    63   <td colspan="2" class="table-header">
       
    64     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    65       <tr valign="top">
       
    66         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    67         <td align="right" valign="top"
       
    68          ><span class="options">[<a href="#section-InstanceMethods"
       
    69          class="privatelink" onclick="toggle_private();"
       
    70          >hide private</a>]</span></td>
       
    71       </tr>
       
    72     </table>
       
    73   </td>
       
    74 </tr>
       
    75 <tr>
       
    76     <td width="15%" align="right" valign="top" class="summary">
       
    77       <span class="summary-type">&nbsp;</span>
       
    78     </td><td class="summary">
       
    79       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    80         <tr>
       
    81           <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
       
    82         <span class="summary-sig-arg">vtype</span>,
       
    83         <span class="summary-sig-arg">config</span>)</span><br />
       
    84       Initialise the Version object.</td>
       
    85           <td align="right" valign="top">
       
    86             <span class="codelink"><a href="version-pysrc.html#Version.__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="version_string"></a><span class="summary-sig-name">version_string</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   101       Returns the formatted version string.</td>
       
   102           <td align="right" valign="top">
       
   103             <span class="codelink"><a href="version-pysrc.html#Version.version_string">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 name="write"></a><span class="summary-sig-name">write</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   118       Write the version string to the vtype.txt.path file.</td>
       
   119           <td align="right" valign="top">
       
   120             <span class="codelink"><a href="version-pysrc.html#Version.write">source&nbsp;code</a></span>
       
   121             
       
   122           </td>
       
   123         </tr>
       
   124       </table>
       
   125       
       
   126     </td>
       
   127   </tr>
       
   128 <tr class="private">
       
   129     <td width="15%" align="right" valign="top" class="summary">
       
   130       <span class="summary-type">&nbsp;</span>
       
   131     </td><td class="summary">
       
   132       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   133         <tr>
       
   134           <td><span class="summary-sig"><a name="__write"></a><span class="summary-sig-name">__write</span>(<span class="summary-sig-arg">self</span>,
       
   135         <span class="summary-sig-arg">path</span>,
       
   136         <span class="summary-sig-arg">content</span>)</span></td>
       
   137           <td align="right" valign="top">
       
   138             <span class="codelink"><a href="version-pysrc.html#Version.__write">source&nbsp;code</a></span>
       
   139             
       
   140           </td>
       
   141         </tr>
       
   142       </table>
       
   143       
       
   144     </td>
       
   145   </tr>
       
   146 <tr class="private">
       
   147     <td width="15%" align="right" valign="top" class="summary">
       
   148       <span class="summary-type">&nbsp;</span>
       
   149     </td><td class="summary">
       
   150       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   151         <tr>
       
   152           <td><span class="summary-sig"><a name="__unescape"></a><span class="summary-sig-name">__unescape</span>(<span class="summary-sig-arg">self</span>,
       
   153         <span class="summary-sig-arg">text</span>)</span></td>
       
   154           <td align="right" valign="top">
       
   155             <span class="codelink"><a href="version-pysrc.html#Version.__unescape">source&nbsp;code</a></span>
       
   156             
       
   157           </td>
       
   158         </tr>
       
   159       </table>
       
   160       
       
   161     </td>
       
   162   </tr>
       
   163 <tr>
       
   164     <td width="15%" align="right" valign="top" class="summary">
       
   165       <span class="summary-type">&nbsp;</span>
       
   166     </td><td class="summary">
       
   167       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   168         <tr>
       
   169           <td><span class="summary-sig"><a name="__str__"></a><span class="summary-sig-name">__str__</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   170       The string representation of the version object is the full version string.</td>
       
   171           <td align="right" valign="top">
       
   172             <span class="codelink"><a href="version-pysrc.html#Version.__str__">source&nbsp;code</a></span>
       
   173             
       
   174           </td>
       
   175         </tr>
       
   176       </table>
       
   177       
       
   178     </td>
       
   179   </tr>
       
   180 </table>
       
   181 <!-- ==================== NAVIGATION BAR ==================== -->
       
   182 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   183        bgcolor="#a0c0ff" cellspacing="0">
       
   184   <tr valign="middle">
       
   185 
       
   186   <!-- Tree link -->
       
   187       <th>&nbsp;&nbsp;&nbsp;<a
       
   188         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   189 
       
   190   <!-- Index link -->
       
   191       <th>&nbsp;&nbsp;&nbsp;<a
       
   192         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   193 
       
   194   <!-- Help link -->
       
   195       <th>&nbsp;&nbsp;&nbsp;<a
       
   196         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   197 
       
   198       <th class="navbar" width="100%"></th>
       
   199   </tr>
       
   200 </table>
       
   201 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   202   <tr>
       
   203     <td align="left" class="footer">
       
   204     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:19 2009
       
   205     </td>
       
   206     <td align="right" class="footer">
       
   207       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   208     </td>
       
   209   </tr>
       
   210 </table>
       
   211 
       
   212 <script type="text/javascript">
       
   213   <!--
       
   214   // Private objects are initially displayed (because if
       
   215   // javascript is turned off then we want them to be
       
   216   // visible); but by default, we want to hide them.  So hide
       
   217   // them unless we have a cookie that says to show them.
       
   218   checkCookie()
       
   219   // -->
       
   220 </script>
       
   221   
       
   222 </body>
       
   223 </html>