--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Sun Jan 09 18:16:46 2011 +0100
@@ -0,0 +1,243 @@
+<?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>eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog</title>
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog</h1>
+<p>
+Module implementing a dialog to show the results of the PEP 8 check.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Pep8Dialog">Pep8Dialog</a></td>
+<td>Class implementing a dialog to show the results of the PEP 8 check.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="Pep8Dialog" ID="Pep8Dialog"></a>
+<h2>Pep8Dialog</h2>
+<p>
+ Class implementing a dialog to show the results of the PEP 8 check.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_Pep8Dialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>filenameRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>positionRole</td></tr><tr><td>settingsKey</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Pep8Dialog.__init__">Pep8Dialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.__clearErrors">__clearErrors</a></td>
+<td>Private method to clear all warning markers of open editors.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.__createResultItem">__createResultItem</a></td>
+<td>Private method to create an entry in the result list.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.__finish">__finish</a></td>
+<td>Private slot called when the PEP 8 check finished or the user pressed the cancel button.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.__resort">__resort</a></td>
+<td>Private method to resort the tree.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.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="#Pep8Dialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td>
+<td>Private slot to select the message codes to be excluded via a selection dialog.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.on_includeMessagesSelectButton_clicked">on_includeMessagesSelectButton_clicked</a></td>
+<td>Private slot to select the message codes to be included via a selection dialog.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td>
+<td>Private slot to load the default configuration values.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
+<td>Private slot to handle the activation of an item.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.on_showButton_clicked">on_showButton_clicked</a></td>
+<td>Private slot to handle the "Show" button press.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.on_startButton_clicked">on_startButton_clicked</a></td>
+<td>Private slot to start a PEP 8 check run.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td>
+<td>Private slot to store the current configuration values as default values.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.prepare">prepare</a></td>
+<td>Public method to prepare the dialog with a list of filenames.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.start">start</a></td>
+<td>Public slot to start the PEP 8 check.</td>
+</tr>
+</table>
+<a NAME="Pep8Dialog.__init__" ID="Pep8Dialog.__init__"></a>
+<h4>Pep8Dialog (Constructor)</h4>
+<b>Pep8Dialog</b>(<i>parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="Pep8Dialog.__clearErrors" ID="Pep8Dialog.__clearErrors"></a>
+<h4>Pep8Dialog.__clearErrors</h4>
+<b>__clearErrors</b>(<i></i>)
+<p>
+ Private method to clear all warning markers of open editors.
+</p><a NAME="Pep8Dialog.__createResultItem" ID="Pep8Dialog.__createResultItem"></a>
+<h4>Pep8Dialog.__createResultItem</h4>
+<b>__createResultItem</b>(<i>file, line, pos, message</i>)
+<p>
+ Private method to create an entry in the result list.
+</p><dl>
+<dt><i>file</i></dt>
+<dd>
+file name of the file (string)
+</dd><dt><i>line</i></dt>
+<dd>
+line number of issue (integer or string)
+</dd><dt><i>pos</i></dt>
+<dd>
+character position of issue (integer or string)
+</dd><dt><i>message</i></dt>
+<dd>
+message text (string)
+</dd>
+</dl><a NAME="Pep8Dialog.__finish" ID="Pep8Dialog.__finish"></a>
+<h4>Pep8Dialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+ Private slot called when the PEP 8 check finished or the user
+ pressed the cancel button.
+</p><a NAME="Pep8Dialog.__resort" ID="Pep8Dialog.__resort"></a>
+<h4>Pep8Dialog.__resort</h4>
+<b>__resort</b>(<i></i>)
+<p>
+ Private method to resort the tree.
+</p><a NAME="Pep8Dialog.on_buttonBox_clicked" ID="Pep8Dialog.on_buttonBox_clicked"></a>
+<h4>Pep8Dialog.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="Pep8Dialog.on_excludeMessagesSelectButton_clicked" ID="Pep8Dialog.on_excludeMessagesSelectButton_clicked"></a>
+<h4>Pep8Dialog.on_excludeMessagesSelectButton_clicked</h4>
+<b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
+<p>
+ Private slot to select the message codes to be excluded via a
+ selection dialog.
+</p><a NAME="Pep8Dialog.on_includeMessagesSelectButton_clicked" ID="Pep8Dialog.on_includeMessagesSelectButton_clicked"></a>
+<h4>Pep8Dialog.on_includeMessagesSelectButton_clicked</h4>
+<b>on_includeMessagesSelectButton_clicked</b>(<i></i>)
+<p>
+ Private slot to select the message codes to be included via a
+ selection dialog.
+</p><a NAME="Pep8Dialog.on_loadDefaultButton_clicked" ID="Pep8Dialog.on_loadDefaultButton_clicked"></a>
+<h4>Pep8Dialog.on_loadDefaultButton_clicked</h4>
+<b>on_loadDefaultButton_clicked</b>(<i></i>)
+<p>
+ Private slot to load the default configuration values.
+</p><a NAME="Pep8Dialog.on_resultList_itemActivated" ID="Pep8Dialog.on_resultList_itemActivated"></a>
+<h4>Pep8Dialog.on_resultList_itemActivated</h4>
+<b>on_resultList_itemActivated</b>(<i>item, column</i>)
+<p>
+ Private slot to handle the activation of an item.
+</p><dl>
+<dt><i>item</i></dt>
+<dd>
+reference to the activated item (QTreeWidgetItem)
+</dd><dt><i>column</i></dt>
+<dd>
+column the item was activated in (integer)
+</dd>
+</dl><a NAME="Pep8Dialog.on_showButton_clicked" ID="Pep8Dialog.on_showButton_clicked"></a>
+<h4>Pep8Dialog.on_showButton_clicked</h4>
+<b>on_showButton_clicked</b>(<i></i>)
+<p>
+ Private slot to handle the "Show" button press.
+</p><a NAME="Pep8Dialog.on_startButton_clicked" ID="Pep8Dialog.on_startButton_clicked"></a>
+<h4>Pep8Dialog.on_startButton_clicked</h4>
+<b>on_startButton_clicked</b>(<i></i>)
+<p>
+ Private slot to start a PEP 8 check run.
+</p><a NAME="Pep8Dialog.on_storeDefaultButton_clicked" ID="Pep8Dialog.on_storeDefaultButton_clicked"></a>
+<h4>Pep8Dialog.on_storeDefaultButton_clicked</h4>
+<b>on_storeDefaultButton_clicked</b>(<i></i>)
+<p>
+ Private slot to store the current configuration values as
+ default values.
+</p><a NAME="Pep8Dialog.prepare" ID="Pep8Dialog.prepare"></a>
+<h4>Pep8Dialog.prepare</h4>
+<b>prepare</b>(<i>fileList, project</i>)
+<p>
+ Public method to prepare the dialog with a list of filenames.
+</p><dl>
+<dt><i>fileList</i></dt>
+<dd>
+list of filenames (list of strings)
+</dd><dt><i>project</i></dt>
+<dd>
+reference to the project object (Project)
+</dd>
+</dl><a NAME="Pep8Dialog.start" ID="Pep8Dialog.start"></a>
+<h4>Pep8Dialog.start</h4>
+<b>start</b>(<i>fn, codestring = "", save = False, repeat = None</i>)
+<p>
+ Public slot to start the PEP 8 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><dt><i>save=</i></dt>
+<dd>
+flag indicating to save the given
+ file/file list/directory (boolean)
+</dd><dt><i>repeat=</i></dt>
+<dd>
+state of the repeat check box if it is not None
+ (None or boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
