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