--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,175 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog</h1>
+<p>
+Module implementing a simple Python syntax checker.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#SyntaxCheckerDialog">SyntaxCheckerDialog</a></td>
+<td>Class implementing a dialog to display the results of a syntax check run.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="SyntaxCheckerDialog" ID="SyntaxCheckerDialog"></a>
+<h2>SyntaxCheckerDialog</h2>
+<p>
+ Class implementing a dialog to display the results of a syntax check run.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_SyntaxCheckerDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#SyntaxCheckerDialog.__init__">SyntaxCheckerDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SyntaxCheckerDialog.__clearErrors">__clearErrors</a></td>
+<td>Private method to clear all error markers of open editors.</td>
+</tr><tr>
+<td><a href="#SyntaxCheckerDialog.__createResultItem">__createResultItem</a></td>
+<td>Private method to create an entry in the result list.</td>
+</tr><tr>
+<td><a href="#SyntaxCheckerDialog.__finish">__finish</a></td>
+<td>Private slot called when the syntax check finished or the user pressed the button.</td>
+</tr><tr>
+<td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td>
+<td>Private method to resort the tree.</td>
+</tr><tr>
+<td><a href="#SyntaxCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr><tr>
+<td><a href="#SyntaxCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
+<td>Private slot to handle the activation of an item.</td>
+</tr><tr>
+<td><a href="#SyntaxCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td>
+<td>Private slot to handle the "Show" button press.</td>
+</tr><tr>
+<td><a href="#SyntaxCheckerDialog.start">start</a></td>
+<td>Public slot to start the syntax check.</td>
+</tr>
+</table>
+<a NAME="SyntaxCheckerDialog.__init__" ID="SyntaxCheckerDialog.__init__"></a>
+<h4>SyntaxCheckerDialog (Constructor)</h4>
+<b>SyntaxCheckerDialog</b>(<i>parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+The parent widget. (QWidget)
+</dd>
+</dl><a NAME="SyntaxCheckerDialog.__clearErrors" ID="SyntaxCheckerDialog.__clearErrors"></a>
+<h4>SyntaxCheckerDialog.__clearErrors</h4>
+<b>__clearErrors</b>(<i></i>)
+<p>
+ Private method to clear all error markers of open editors.
+</p><a NAME="SyntaxCheckerDialog.__createResultItem" ID="SyntaxCheckerDialog.__createResultItem"></a>
+<h4>SyntaxCheckerDialog.__createResultItem</h4>
+<b>__createResultItem</b>(<i>file, line, error, sourcecode</i>)
+<p>
+ Private method to create an entry in the result list.
+</p><dl>
+<dt><i>file</i></dt>
+<dd>
+filename of file (string)
+</dd><dt><i>line</i></dt>
+<dd>
+linenumber of faulty source (integer or string)
+</dd><dt><i>error</i></dt>
+<dd>
+error text (string)
+</dd><dt><i>sourcecode</i></dt>
+<dd>
+faulty line of code (string)
+</dd>
+</dl><a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a>
+<h4>SyntaxCheckerDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+ Private slot called when the syntax check finished or the user pressed the button.
+</p><a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a>
+<h4>SyntaxCheckerDialog.__resort</h4>
+<b>__resort</b>(<i></i>)
+<p>
+ Private method to resort the tree.
+</p><a NAME="SyntaxCheckerDialog.on_buttonBox_clicked" ID="SyntaxCheckerDialog.on_buttonBox_clicked"></a>
+<h4>SyntaxCheckerDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+ Private slot called by a button of the button box clicked.
+</p><dl>
+<dt><i>button</i></dt>
+<dd>
+button that was clicked (QAbstractButton)
+</dd>
+</dl><a NAME="SyntaxCheckerDialog.on_resultList_itemActivated" ID="SyntaxCheckerDialog.on_resultList_itemActivated"></a>
+<h4>SyntaxCheckerDialog.on_resultList_itemActivated</h4>
+<b>on_resultList_itemActivated</b>(<i>itm, col</i>)
+<p>
+ Private slot to handle the activation of an item.
+</p><dl>
+<dt><i>itm</i></dt>
+<dd>
+reference to the activated item (QTreeWidgetItem)
+</dd><dt><i>col</i></dt>
+<dd>
+column the item was activated in (integer)
+</dd>
+</dl><a NAME="SyntaxCheckerDialog.on_showButton_clicked" ID="SyntaxCheckerDialog.on_showButton_clicked"></a>
+<h4>SyntaxCheckerDialog.on_showButton_clicked</h4>
+<b>on_showButton_clicked</b>(<i></i>)
+<p>
+ Private slot to handle the "Show" button press.
+</p><a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a>
+<h4>SyntaxCheckerDialog.start</h4>
+<b>start</b>(<i>fn, codestring = ""</i>)
+<p>
+ Public slot to start the syntax check.
+</p><dl>
+<dt><i>fn</i></dt>
+<dd>
+file or list of files or directory to be checked
+ (string or list of strings)
+</dd><dt><i>codestring</i></dt>
+<dd>
+string containing the code to be checked (string).
+ If this is given, file must be a single file name.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
