--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Mon Aug 12 22:21:53 2013 +0200
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Sun Sep 08 19:04:07 2013 +0200
@@ -32,6 +32,9 @@
<tr>
<td><a href="#Pep8Dialog">Pep8Dialog</a></td>
<td>Class implementing a dialog to show the results of the PEP 8 check.</td>
+</tr><tr>
+<td><a href="#Pep8Report">Pep8Report</a></td>
+<td>Class implementing a special report to be used with our dialog.</td>
</tr>
</table>
<h3>Functions</h3>
@@ -48,7 +51,7 @@
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>
+<tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>positionRole</td></tr>
</table>
<h3>Class Methods</h3>
<table>
@@ -63,21 +66,33 @@
<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.__createErrorItem">__createErrorItem</a></td>
-<td>Private method to create an entry in the result list.</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.__getSelectedFixableItems">__getSelectedFixableItems</a></td>
+<td>Private method to extract all selected items for fixable issues.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.__itemFixable">__itemFixable</a></td>
+<td>Private method to check, if an item has a fixable issue.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.__modifyFixedResultItem">__modifyFixedResultItem</a></td>
+<td>Private method to modify a result list entry to show its positive fixed state.</td>
+</tr><tr>
<td><a href="#Pep8Dialog.__resetStatistics">__resetStatistics</a></td>
<td>Private slot to reset the statistics data.</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.__selectCodes">__selectCodes</a></td>
+<td>Private method to select message codes via a selection dialog.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.__updateFixerStatistics">__updateFixerStatistics</a></td>
+<td>Private method to update the collected fixer related statistics.</td>
+</tr><tr>
<td><a href="#Pep8Dialog.__updateStatistics">__updateStatistics</a></td>
<td>Private method to update the collected statistics.</td>
</tr><tr>
@@ -87,6 +102,9 @@
<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_fixButton_clicked">on_fixButton_clicked</a></td>
+<td>Private slot to fix selected issues.</td>
+</tr><tr>
<td><a href="#Pep8Dialog.on_fixIssuesSelectButton_clicked">on_fixIssuesSelectButton_clicked</a></td>
<td>Private slot to select the issue codes to be fixed via a selection dialog.</td>
</tr><tr>
@@ -96,9 +114,18 @@
<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_noFixIssuesSelectButton_clicked">on_noFixIssuesSelectButton_clicked</a></td>
+<td>Private slot to select the issue codes not to be fixed via a selection dialog.</td>
+</tr><tr>
+<td><a href="#Pep8Dialog.on_resetDefaultButton_clicked">on_resetDefaultButton_clicked</a></td>
+<td>Slot documentation goes here.</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_resultList_itemSelectionChanged">on_resultList_itemSelectionChanged</a></td>
+<td>Private slot to change the dialog state depending on the selection.</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>
@@ -137,29 +164,7 @@
<b>__clearErrors</b>(<i></i>)
<p>
Private method to clear all warning markers of open editors.
-</p><a NAME="Pep8Dialog.__createErrorItem" ID="Pep8Dialog.__createErrorItem"></a>
-<h4>Pep8Dialog.__createErrorItem</h4>
-<b>__createErrorItem</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><dt><i>fixed</i></dt>
-<dd>
-flag indicating a fixed issue (boolean)
-</dd>
-</dl><a NAME="Pep8Dialog.__createResultItem" ID="Pep8Dialog.__createResultItem"></a>
+</p><a NAME="Pep8Dialog.__createResultItem" ID="Pep8Dialog.__createResultItem"></a>
<h4>Pep8Dialog.__createResultItem</h4>
<b>__createResultItem</b>(<i>file, line, pos, message, fixed</i>)
<p>
@@ -187,7 +192,46 @@
<p>
Private slot called when the PEP 8 check finished or the user
pressed the cancel button.
-</p><a NAME="Pep8Dialog.__resetStatistics" ID="Pep8Dialog.__resetStatistics"></a>
+</p><a NAME="Pep8Dialog.__getSelectedFixableItems" ID="Pep8Dialog.__getSelectedFixableItems"></a>
+<h4>Pep8Dialog.__getSelectedFixableItems</h4>
+<b>__getSelectedFixableItems</b>(<i></i>)
+<p>
+ Private method to extract all selected items for fixable issues.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+selected items for fixable issues (list of QTreeWidgetItem)
+</dd>
+</dl><a NAME="Pep8Dialog.__itemFixable" ID="Pep8Dialog.__itemFixable"></a>
+<h4>Pep8Dialog.__itemFixable</h4>
+<b>__itemFixable</b>(<i>itm</i>)
+<p>
+ Private method to check, if an item has a fixable issue.
+</p><dl>
+<dt><i>itm</i></dt>
+<dd>
+item to be checked (QTreeWidgetItem)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a fixable issue (boolean)
+</dd>
+</dl><a NAME="Pep8Dialog.__modifyFixedResultItem" ID="Pep8Dialog.__modifyFixedResultItem"></a>
+<h4>Pep8Dialog.__modifyFixedResultItem</h4>
+<b>__modifyFixedResultItem</b>(<i>itm, text</i>)
+<p>
+ Private method to modify a result list entry to show its
+ positive fixed state.
+</p><dl>
+<dt><i>itm</i></dt>
+<dd>
+reference to the item to modify (QTreeWidgetItem)
+</dd><dt><i>text</i></dt>
+<dd>
+text to be appended (string)
+</dd>
+</dl><a NAME="Pep8Dialog.__resetStatistics" ID="Pep8Dialog.__resetStatistics"></a>
<h4>Pep8Dialog.__resetStatistics</h4>
<b>__resetStatistics</b>(<i></i>)
<p>
@@ -197,7 +241,31 @@
<b>__resort</b>(<i></i>)
<p>
Private method to resort the tree.
-</p><a NAME="Pep8Dialog.__updateStatistics" ID="Pep8Dialog.__updateStatistics"></a>
+</p><a NAME="Pep8Dialog.__selectCodes" ID="Pep8Dialog.__selectCodes"></a>
+<h4>Pep8Dialog.__selectCodes</h4>
+<b>__selectCodes</b>(<i>edit, showFixCodes</i>)
+<p>
+ Private method to select message codes via a selection dialog.
+</p><dl>
+<dt><i>edit</i></dt>
+<dd>
+reference of the line edit to be populated (QLineEdit)
+</dd><dt><i>showFixCodes</i></dt>
+<dd>
+flag indicating to show a list of fixable
+ issues (boolean)
+</dd>
+</dl><a NAME="Pep8Dialog.__updateFixerStatistics" ID="Pep8Dialog.__updateFixerStatistics"></a>
+<h4>Pep8Dialog.__updateFixerStatistics</h4>
+<b>__updateFixerStatistics</b>(<i>fixer</i>)
+<p>
+ Private method to update the collected fixer related statistics.
+</p><dl>
+<dt><i>fixer</i></dt>
+<dd>
+reference to the PEP 8 fixer (Pep8Fixer)
+</dd>
+</dl><a NAME="Pep8Dialog.__updateStatistics" ID="Pep8Dialog.__updateStatistics"></a>
<h4>Pep8Dialog.__updateStatistics</h4>
<b>__updateStatistics</b>(<i>statistics, fixer</i>)
<p>
@@ -227,6 +295,11 @@
<p>
Private slot to select the message codes to be excluded via a
selection dialog.
+</p><a NAME="Pep8Dialog.on_fixButton_clicked" ID="Pep8Dialog.on_fixButton_clicked"></a>
+<h4>Pep8Dialog.on_fixButton_clicked</h4>
+<b>on_fixButton_clicked</b>(<i></i>)
+<p>
+ Private slot to fix selected issues.
</p><a NAME="Pep8Dialog.on_fixIssuesSelectButton_clicked" ID="Pep8Dialog.on_fixIssuesSelectButton_clicked"></a>
<h4>Pep8Dialog.on_fixIssuesSelectButton_clicked</h4>
<b>on_fixIssuesSelectButton_clicked</b>(<i></i>)
@@ -244,6 +317,17 @@
<b>on_loadDefaultButton_clicked</b>(<i></i>)
<p>
Private slot to load the default configuration values.
+</p><a NAME="Pep8Dialog.on_noFixIssuesSelectButton_clicked" ID="Pep8Dialog.on_noFixIssuesSelectButton_clicked"></a>
+<h4>Pep8Dialog.on_noFixIssuesSelectButton_clicked</h4>
+<b>on_noFixIssuesSelectButton_clicked</b>(<i></i>)
+<p>
+ Private slot to select the issue codes not to be fixed via a
+ selection dialog.
+</p><a NAME="Pep8Dialog.on_resetDefaultButton_clicked" ID="Pep8Dialog.on_resetDefaultButton_clicked"></a>
+<h4>Pep8Dialog.on_resetDefaultButton_clicked</h4>
+<b>on_resetDefaultButton_clicked</b>(<i></i>)
+<p>
+ Slot documentation goes here.
</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>)
@@ -257,7 +341,12 @@
<dd>
column the item was activated in (integer)
</dd>
-</dl><a NAME="Pep8Dialog.on_showButton_clicked" ID="Pep8Dialog.on_showButton_clicked"></a>
+</dl><a NAME="Pep8Dialog.on_resultList_itemSelectionChanged" ID="Pep8Dialog.on_resultList_itemSelectionChanged"></a>
+<h4>Pep8Dialog.on_resultList_itemSelectionChanged</h4>
+<b>on_resultList_itemSelectionChanged</b>(<i></i>)
+<p>
+ Private slot to change the dialog state depending on the selection.
+</p><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>
@@ -312,5 +401,69 @@
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="Pep8Report" ID="Pep8Report"></a>
+<h2>Pep8Report</h2>
+<p>
+ Class implementing a special report to be used with our dialog.
+</p>
+<h3>Derived from</h3>
+pep8.BaseReport
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Pep8Report.__init__">Pep8Report</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Pep8Report.error_args">error_args</a></td>
+<td>Public method to collect the error messages.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="Pep8Report.__init__" ID="Pep8Report.__init__"></a>
+<h4>Pep8Report (Constructor)</h4>
+<b>Pep8Report</b>(<i>options</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>options</i></dt>
+<dd>
+options for the report (optparse.Values)
+</dd>
+</dl><a NAME="Pep8Report.error_args" ID="Pep8Report.error_args"></a>
+<h4>Pep8Report.error_args</h4>
+<b>error_args</b>(<i>line_number, offset, code, check, *args</i>)
+<p>
+ Public method to collect the error messages.
+</p><dl>
+<dt><i>line_number</i></dt>
+<dd>
+line number of the issue (integer)
+</dd><dt><i>offset</i></dt>
+<dd>
+position within line of the issue (integer)
+</dd><dt><i>code</i></dt>
+<dd>
+message code (string)
+</dd><dt><i>check</i></dt>
+<dd>
+reference to the checker function (function)
+</dd><dt><i>args</i></dt>
+<dd>
+arguments for the message (list)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>
\ No newline at end of file
