text: <?xml version="1.0" encoding="ascii"?>
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
            "DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <title>epydoc.gui.GUILogger</title>
    <link rel="stylesheet" href="epydoc.css" type="text/css" />
    <script type="text/javascript" src="epydoc.js"></script>
  </head>
  
  <body bgcolor="white" text="black" link="blue" vlink="#204080"
        alink="#204080">
  <!-- ==================== NAVIGATION BAR ==================== -->
  <table class="navbar" border="0" width="100%" cellpadding="0"
         bgcolor="#a0c0ff" cellspacing="0">
    <tr valign="middle">
    <!-- Home link -->
        <th>&nbsp;&nbsp;&nbsp;<a
          href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  
    <!-- Tree link -->
        <th>&nbsp;&nbsp;&nbsp;<a
          href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  
    <!-- Index link -->
        <th>&nbsp;&nbsp;&nbsp;<a
          href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  
    <!-- Help link -->
        <th>&nbsp;&nbsp;&nbsp;<a
          href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  
    <!-- Project homepage -->
        <th class="navbar" align="right" width="100%">
          <table border="0" cellpadding="0" cellspacing="0">
            <tr><th class="navbar" align="center"
              ><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
            </tr></table></th>
    </tr>
  </table>
  <table width="100%" cellpadding="0" cellspacing="0">
    <tr valign="top">
      <td width="100%">
        <span class="breadcrumbs">
          <a href="epydoc-module.html">Package&nbsp;epydoc</a> ::
          <a href="epydoc.gui-module.html">Module&nbsp;gui</a> ::
          Class&nbsp;GUILogger
        </span>
      </td>
      <td>
        <table cellpadding="0" cellspacing="0">
          <!-- hide/show private -->
          <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
      onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
          <tr><td align="right"><span class="options"
              >[<a href="frames.html" target="_top">frames</a
              >]&nbsp;|&nbsp;<a href="epydoc.gui.GUILogger-class.html"
              target="_top">no&nbsp;frames</a>]</span></td></tr>
        </table>
      </td>
    </tr>
  </table>
  <!-- ==================== CLASS DESCRIPTION ==================== -->
  <h1 class="epydoc">Class GUILogger</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger">source&nbsp;code</a></span></p>
  <center>
  <center>  <map id="uml_class_diagram_for_epydoc_g" name="uml_class_diagram_for_epydoc_g">
  <area shape="rect" href="epydoc.log.Logger&#45;class.html#close" title="Perform any tasks needed to close this logger." alt="" coords="92,36,159,55" />
  <area shape="rect" href="epydoc.log.Logger&#45;class.html" title="An abstract base class that defines the interface for loggers, which are used by epydoc to report information back to the user." alt="" coords="80,6,171,62" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#__init__" title="epydoc.gui.GUILogger.__init__" alt="" coords="18,111,234,130" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#clear" title="epydoc.gui.GUILogger.clear" alt="" coords="18,130,234,148" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#log" title="Display a message." alt="" coords="18,148,234,167" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#start_block" title="Start a new message block." alt="" coords="18,167,234,186" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#end_block" title="End a warning block." alt="" coords="18,186,234,204" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#start_progress" title="Begin displaying progress for a new task." alt="" coords="18,204,234,223" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#end_progress" title="Finish off the display of progress for the current task." alt="" coords="18,223,234,242" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#progress" title="Update the progress display." alt="" coords="18,242,234,260" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html#read" title="epydoc.gui.GUILogger.read" alt="" coords="18,260,234,279" />
  <area shape="rect" href="epydoc.gui.GUILogger&#45;class.html" title="epydoc.gui.GUILogger" alt="" coords="6,80,246,286" />
  </map>
    <img src="uml_class_diagram_for_epydoc_g.gif" alt='' usemap="#uml_class_diagram_for_epydoc_g" ismap="ismap" class="graph-without-title" />
  </center>
  </center>
  <hr />
  <!-- ==================== INSTANCE METHODS ==================== -->
  <a name="section-InstanceMethods"></a>
  <table class="summary" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr bgcolor="#70b0f0" class="table-header">
    <td colspan="2" class="table-header">
      <table border="0" cellpadding="0" cellspacing="0" width="100%">
        <tr valign="top">
          <td align="left"><span class="table-header">Instance Methods</span></td>
          <td align="right" valign="top"
           ><span class="options">[<a href="#section-InstanceMethods"
           class="privatelink" onclick="toggle_private();"
           >hide private</a>]</span></td>
        </tr>
      </table>
    </td>
  </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
          <span class="summary-sig-arg">progress</span>,
          <span class="summary-sig-arg">cancel</span>)</span></td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.__init__">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a name="clear"></a><span class="summary-sig-name">clear</span>(<span class="summary-sig-arg">self</span>)</span></td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.clear">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a href="epydoc.gui.GUILogger-class.html#log" class="summary-sig-name">log</a>(<span class="summary-sig-arg">self</span>,
          <span class="summary-sig-arg">level</span>,
          <span class="summary-sig-arg">message</span>)</span><br />
        Display a message.</td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.log">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a href="epydoc.gui.GUILogger-class.html#start_block" class="summary-sig-name">start_block</a>(<span class="summary-sig-arg">self</span>,
          <span class="summary-sig-arg">header</span>)</span><br />
        Start a new message block.</td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.start_block">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a href="epydoc.gui.GUILogger-class.html#end_block" class="summary-sig-name">end_block</a>(<span class="summary-sig-arg">self</span>)</span><br />
        End a warning block.</td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.end_block">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a href="epydoc.gui.GUILogger-class.html#start_progress" class="summary-sig-name">start_progress</a>(<span class="summary-sig-arg">self</span>,
          <span class="summary-sig-arg">header</span>=<span class="summary-sig-default">None</span>)</span><br />
        Begin displaying progress for a new task.</td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.start_progress">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a href="epydoc.gui.GUILogger-class.html#end_progress" class="summary-sig-name">end_progress</a>(<span class="summary-sig-arg">self</span>)</span><br />
        Finish off the display of progress for the current task.</td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.end_progress">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a href="epydoc.gui.GUILogger-class.html#progress" class="summary-sig-name">progress</a>(<span class="summary-sig-arg">self</span>,
          <span class="summary-sig-arg">percent</span>,
          <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
        Update the progress display.</td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.progress">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
  <tr>
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
        <table width="100%" cellpadding="0" cellspacing="0" border="0">
          <tr>
            <td><span class="summary-sig"><a name="read"></a><span class="summary-sig-name">read</span>(<span class="summary-sig-arg">self</span>)</span></td>
            <td align="right" valign="top">
              <span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.read">source&nbsp;code</a></span>
              
            </td>
          </tr>
        </table>
        
      </td>
    </tr>
    <tr>
      <td colspan="2" class="summary">
      <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.log.Logger-class.html">log.Logger</a></code></b>:
        <code><a href="epydoc.log.Logger-class.html#close">close</a></code>
        </p>
      </td>
    </tr>
  </table>
  <!-- ==================== CLASS VARIABLES ==================== -->
  <a name="section-ClassVariables"></a>
  <table class="summary" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr bgcolor="#70b0f0" class="table-header">
    <td colspan="2" class="table-header">
      <table border="0" cellpadding="0" cellspacing="0" width="100%">
        <tr valign="top">
          <td align="left"><span class="table-header">Class Variables</span></td>
          <td align="right" valign="top"
           ><span class="options">[<a href="#section-ClassVariables"
           class="privatelink" onclick="toggle_private();"
           >hide private</a>]</span></td>
        </tr>
      </table>
    </td>
  </tr>
  <tr class="private">
      <td width="15%" align="right" valign="top" class="summary">
        <span class="summary-type">&nbsp;</span>
      </td><td class="summary">
          <a name="_STAGES"></a><span class="summary-name">_STAGES</span> = <code title="[40, 7, 1, 3, 1, 30, 1, 2, 100]"><code class="variable-group">[</code>40<code class="variable-op">, </code>7<code class="variable-op">, </code>1<code class="variable-op">, </code>3<code class="variable-op">, </code>1<code class="variable-op">, </code>30<code class="variable-op">, </code>1<code class="variable-op">, </code>2<code class="variable-op">, </code>100<code class="variable-group">]</code></code>
      </td>
    </tr>
  </table>
  <!-- ==================== METHOD DETAILS ==================== -->
  <a name="section-MethodDetails"></a>
  <table class="details" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr bgcolor="#70b0f0" class="table-header">
    <td colspan="2" class="table-header">
      <table border="0" cellpadding="0" cellspacing="0" width="100%">
        <tr valign="top">
          <td align="left"><span class="table-header">Method Details</span></td>
          <td align="right" valign="top"
           ><span class="options">[<a href="#section-MethodDetails"
           class="privatelink" onclick="toggle_private();"
           >hide private</a>]</span></td>
        </tr>
      </table>
    </td>
  </tr>
  </table>
  <a name="log"></a>
  <div>
  <table class="details" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr><td>
    <table width="100%" cellpadding="0" cellspacing="0" border="0">
    <tr valign="top"><td>
    <h3 class="epydoc"><span class="sig"><span class="sig-name">log</span>(<span class="sig-arg">self</span>,
          <span class="sig-arg">level</span>,
          <span class="sig-arg">message</span>)</span>
    </h3>
    </td><td align="right" valign="top"
      ><span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.log">source&nbsp;code</a></span>&nbsp;
      </td>
    </tr></table>
    
    <p>Display a message.</p>
    <dl class="fields">
      <dt>Parameters:</dt>
      <dd><ul class="nomargin-top">
          <li><strong class="pname"><code>message</code></strong> - The message string to display.  <code>message</code> may contain 
            newlines, but does not need to end in a newline.</li>
          <li><strong class="pname"><code>level</code></strong> - An integer value indicating the severity of the message.</li>
      </ul></dd>
      <dt>Overrides:
          <a href="epydoc.log.Logger-class.html#log">log.Logger.log</a>
          <dd><em class="note">(inherited documentation)</em></dd>
      </dt>
    </dl>
  </td></tr></table>
  </div>
  <a name="start_block"></a>
  <div>
  <table class="details" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr><td>
    <table width="100%" cellpadding="0" cellspacing="0" border="0">
    <tr valign="top"><td>
    <h3 class="epydoc"><span class="sig"><span class="sig-name">start_block</span>(<span class="sig-arg">self</span>,
          <span class="sig-arg">header</span>)</span>
    </h3>
    </td><td align="right" valign="top"
      ><span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.start_block">source&nbsp;code</a></span>&nbsp;
      </td>
    </tr></table>
    
    <p>Start a new message block.  Any calls to <a 
    href="epydoc.log-module.html#info" class="link">info()</a>, <a 
    href="epydoc.log-module.html#warning" class="link">warning()</a>, or <a 
    href="epydoc.log-module.html#error" class="link">error()</a> that occur 
    between a call to <code>start_block</code> and a corresponding call to 
    <code>end_block</code> will be grouped together, and displayed with a 
    common header. <code>start_block</code> can be called multiple times (to 
    form nested blocks), but every call to <code>start_block</code> 
    <i>must</i> be balanced by a call to <code>end_block</code>.</p>
    <dl class="fields">
      <dt>Overrides:
          <a href="epydoc.log.Logger-class.html#start_block">log.Logger.start_block</a>
          <dd><em class="note">(inherited documentation)</em></dd>
      </dt>
    </dl>
  </td></tr></table>
  </div>
  <a name="end_block"></a>
  <div>
  <table class="details" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr><td>
    <table width="100%" cellpadding="0" cellspacing="0" border="0">
    <tr valign="top"><td>
    <h3 class="epydoc"><span class="sig"><span class="sig-name">end_block</span>(<span class="sig-arg">self</span>)</span>
    </h3>
    </td><td align="right" valign="top"
      ><span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.end_block">source&nbsp;code</a></span>&nbsp;
      </td>
    </tr></table>
    
    <p>End a warning block.  See <a 
    href="epydoc.cli.ConsoleLogger-class.html#start_block" 
    class="link">start_block</a> for details.</p>
    <dl class="fields">
      <dt>Overrides:
          <a href="epydoc.log.Logger-class.html#end_block">log.Logger.end_block</a>
          <dd><em class="note">(inherited documentation)</em></dd>
      </dt>
    </dl>
  </td></tr></table>
  </div>
  <a name="start_progress"></a>
  <div>
  <table class="details" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr><td>
    <table width="100%" cellpadding="0" cellspacing="0" border="0">
    <tr valign="top"><td>
    <h3 class="epydoc"><span class="sig"><span class="sig-name">start_progress</span>(<span class="sig-arg">self</span>,
          <span class="sig-arg">header</span>=<span class="sig-default">None</span>)</span>
    </h3>
    </td><td align="right" valign="top"
      ><span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.start_progress">source&nbsp;code</a></span>&nbsp;
      </td>
    </tr></table>
    
    <p>Begin displaying progress for a new task.  <code>header</code> is a 
    description of the task for which progress is being reported. Each call 
    to <code>start_progress</code> must be followed by a call to 
    <code>end_progress</code> (with no intervening calls to 
    <code>start_progress</code>).</p>
    <dl class="fields">
      <dt>Overrides:
          <a href="epydoc.log.Logger-class.html#start_progress">log.Logger.start_progress</a>
          <dd><em class="note">(inherited documentation)</em></dd>
      </dt>
    </dl>
  </td></tr></table>
  </div>
  <a name="end_progress"></a>
  <div>
  <table class="details" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr><td>
    <table width="100%" cellpadding="0" cellspacing="0" border="0">
    <tr valign="top"><td>
    <h3 class="epydoc"><span class="sig"><span class="sig-name">end_progress</span>(<span class="sig-arg">self</span>)</span>
    </h3>
    </td><td align="right" valign="top"
      ><span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.end_progress">source&nbsp;code</a></span>&nbsp;
      </td>
    </tr></table>
    
    <p>Finish off the display of progress for the current task.  See <a 
    href="epydoc.cli.ConsoleLogger-class.html#start_progress" 
    class="link">start_progress</a> for more information.</p>
    <dl class="fields">
      <dt>Overrides:
          <a href="epydoc.log.Logger-class.html#end_progress">log.Logger.end_progress</a>
          <dd><em class="note">(inherited documentation)</em></dd>
      </dt>
    </dl>
  </td></tr></table>
  </div>
  <a name="progress"></a>
  <div>
  <table class="details" border="1" cellpadding="3"
         cellspacing="0" width="100%" bgcolor="white">
  <tr><td>
    <table width="100%" cellpadding="0" cellspacing="0" border="0">
    <tr valign="top"><td>
    <h3 class="epydoc"><span class="sig"><span class="sig-name">progress</span>(<span class="sig-arg">self</span>,
          <span class="sig-arg">percent</span>,
          <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
    </h3>
    </td><td align="right" valign="top"
      ><span class="codelink"><a href="epydoc.gui-pysrc.html#GUILogger.progress">source&nbsp;code</a></span>&nbsp;
      </td>
    </tr></table>
    
    <p>Update the progress display.</p>
    <dl class="fields">
      <dt>Parameters:</dt>
      <dd><ul class="nomargin-top">
          <li><strong class="pname"><code>percent</code></strong> - A float from 0.0 to 1.0, indicating how much progress has been 
            made.</li>
          <li><strong class="pname"><code>message</code></strong> - A message indicating the most recent action that contributed 
            towards that progress.</li>
      </ul></dd>
      <dt>Overrides:
          <a href="epydoc.log.Logger-class.html#progress">log.Logger.progress</a>
          <dd><em class="note">(inherited documentation)</em></dd>
      </dt>
    </dl>
  </td></tr></table>
  </div>
  <br />
  <!-- ==================== NAVIGATION BAR ==================== -->
  <table class="navbar" border="0" width="100%" cellpadding="0"
         bgcolor="#a0c0ff" cellspacing="0">
    <tr valign="middle">
    <!-- Home link -->
        <th>&nbsp;&nbsp;&nbsp;<a
          href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  
    <!-- Tree link -->
        <th>&nbsp;&nbsp;&nbsp;<a
          href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  
    <!-- Index link -->
        <th>&nbsp;&nbsp;&nbsp;<a
          href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  
    <!-- Help link -->
        <th>&nbsp;&nbsp;&nbsp;<a
          href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  
    <!-- Project homepage -->
        <th class="navbar" align="right" width="100%">
          <table border="0" cellpadding="0" cellspacing="0">
            <tr><th class="navbar" align="center"
              ><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
            </tr></table></th>
    </tr>
  </table>
  <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    <tr>
      <td align="left" class="footer">
      <a href="epydoc-log.html">Generated by Epydoc
      3.0.1 on Wed Jan 30 14:08:21 2008</a>
      </td>
      <td align="right" class="footer">
        <a target="mainFrame" href="http://epydoc.sourceforge.net"
          >http://epydoc.sourceforge.net</a>
      </td>
    </tr>
  </table>
  
  <script type="text/javascript">
    <!--
    // Private objects are initially displayed (because if
    // javascript is turned off then we want them to be
    // visible); but by default, we want to hide them.  So hide
    // them unless we have a cookie that says to show them.
    checkCookie();
    // -->
  </script>
  </body>
  </html>
  