--- a/Documentation/Source/eric5.DataViews.PyCoverageDialog.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.DataViews.PyCoverageDialog.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.DataViews.PyCoverageDialog</h1> <p> -Module implementing a Python code coverage dialog. +Module implementing a Python code coverage dialog. </p> <h3>Global Attributes</h3> <table> @@ -32,7 +32,7 @@ <table> <tr> <td><a href="#PyCoverageDialog">PyCoverageDialog</a></td> -<td>Class implementing a dialog to display the collected code coverage data.</td> +<td>Class implementing a dialog to display the collected code coverage data.</td> </tr> </table> <h3>Functions</h3> @@ -43,7 +43,7 @@ <a NAME="PyCoverageDialog" ID="PyCoverageDialog"></a> <h2>PyCoverageDialog</h2> <p> - Class implementing a dialog to display the collected code coverage data. + Class implementing a dialog to display the collected code coverage data. </p> <h3>Derived from</h3> QDialog, Ui_PyCoverageDialog @@ -55,180 +55,180 @@ <table> <tr> <td><a href="#PyCoverageDialog.__init__">PyCoverageDialog</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#PyCoverageDialog.__annotate">__annotate</a></td> -<td>Private slot to handle the annotate context menu action.</td> +<td>Private slot to handle the annotate context menu action.</td> </tr><tr> <td><a href="#PyCoverageDialog.__annotateAll">__annotateAll</a></td> -<td>Private slot to handle the annotate all context menu action.</td> +<td>Private slot to handle the annotate all context menu action.</td> </tr><tr> <td><a href="#PyCoverageDialog.__createResultItem">__createResultItem</a></td> -<td>Private method to create an entry in the result list.</td> +<td>Private method to create an entry in the result list.</td> </tr><tr> <td><a href="#PyCoverageDialog.__deleteAnnotated">__deleteAnnotated</a></td> -<td>Private slot to handle the delete annotated context menu action.</td> +<td>Private slot to handle the delete annotated context menu action.</td> </tr><tr> <td><a href="#PyCoverageDialog.__erase">__erase</a></td> -<td>Private slot to handle the erase context menu action.</td> +<td>Private slot to handle the erase context menu action.</td> </tr><tr> <td><a href="#PyCoverageDialog.__finish">__finish</a></td> -<td>Private slot called when the action finished or the user pressed the button.</td> +<td>Private slot called when the action finished or the user pressed the button.</td> </tr><tr> <td><a href="#PyCoverageDialog.__format_lines">__format_lines</a></td> -<td>Private method to format a list of integers into string by coalescing groups.</td> +<td>Private method to format a list of integers into string by coalescing groups.</td> </tr><tr> <td><a href="#PyCoverageDialog.__showContextMenu">__showContextMenu</a></td> -<td>Private slot to show the context menu of the listview.</td> +<td>Private slot to show the context menu of the listview.</td> </tr><tr> <td><a href="#PyCoverageDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> -<td>Private slot called by a button of the button box clicked.</td> +<td>Private slot called by a button of the button box clicked.</td> </tr><tr> <td><a href="#PyCoverageDialog.on_reloadButton_clicked">on_reloadButton_clicked</a></td> -<td>Private slot to reload the coverage info.</td> +<td>Private slot to reload the coverage info.</td> </tr><tr> <td><a href="#PyCoverageDialog.start">start</a></td> -<td>Public slot to start the coverage data evaluation.</td> +<td>Public slot to start the coverage data evaluation.</td> </tr><tr> <td><a href="#PyCoverageDialog.stringify">stringify</a></td> -<td>Private helper function to generate a string representation of a pair</td> +<td>Private helper function to generate a string representation of a pair</td> </tr> </table> <a NAME="PyCoverageDialog.__init__" ID="PyCoverageDialog.__init__"></a> <h4>PyCoverageDialog (Constructor)</h4> <b>PyCoverageDialog</b>(<i>parent = None</i>) <p> - Constructor + Constructor </p><dl> <dt><i>parent</i></dt> <dd> -parent widget (QWidget) +parent widget (QWidget) </dd> </dl><a NAME="PyCoverageDialog.__annotate" ID="PyCoverageDialog.__annotate"></a> <h4>PyCoverageDialog.__annotate</h4> <b>__annotate</b>(<i></i>) <p> - Private slot to handle the annotate context menu action. + Private slot to handle the annotate context menu action. </p><p> - This method produce an annotated coverage file of the - selected file. + This method produce an annotated coverage file of the + selected file. </p><a NAME="PyCoverageDialog.__annotateAll" ID="PyCoverageDialog.__annotateAll"></a> <h4>PyCoverageDialog.__annotateAll</h4> <b>__annotateAll</b>(<i></i>) <p> - Private slot to handle the annotate all context menu action. + Private slot to handle the annotate all context menu action. </p><p> - This method produce an annotated coverage file of every - file listed in the listview. + This method produce an annotated coverage file of every + file listed in the listview. </p><a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a> <h4>PyCoverageDialog.__createResultItem</h4> <b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>) <p> - Private method to create an entry in the result list. + Private method to create an entry in the result list. </p><dl> <dt><i>file</i></dt> <dd> -filename of file (string) +filename of file (string) </dd><dt><i>statements</i></dt> <dd> -amount of statements (integer) +amount of statements (integer) </dd><dt><i>executed</i></dt> <dd> -amount of executed statements (integer) +amount of executed statements (integer) </dd><dt><i>coverage</i></dt> <dd> -percent of coverage (integer) +percent of coverage (integer) </dd><dt><i>excluded</i></dt> <dd> -list of excluded lines (string) +list of excluded lines (string) </dd><dt><i>missing</i></dt> <dd> -list of lines without coverage (string) +list of lines without coverage (string) </dd> </dl><a NAME="PyCoverageDialog.__deleteAnnotated" ID="PyCoverageDialog.__deleteAnnotated"></a> <h4>PyCoverageDialog.__deleteAnnotated</h4> <b>__deleteAnnotated</b>(<i></i>) <p> - Private slot to handle the delete annotated context menu action. + Private slot to handle the delete annotated context menu action. </p><p> - This method deletes all annotated files. These are files - ending with ',cover'. + This method deletes all annotated files. These are files + ending with ',cover'. </p><a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a> <h4>PyCoverageDialog.__erase</h4> <b>__erase</b>(<i></i>) <p> - Private slot to handle the erase context menu action. + Private slot to handle the erase context menu action. </p><p> - This method erases the collected coverage data that is - stored in the .coverage file. + This method erases the collected coverage data that is + stored in the .coverage file. </p><a NAME="PyCoverageDialog.__finish" ID="PyCoverageDialog.__finish"></a> <h4>PyCoverageDialog.__finish</h4> <b>__finish</b>(<i></i>) <p> - Private slot called when the action finished or the user pressed the button. + Private slot called when the action finished or the user pressed the button. </p><a NAME="PyCoverageDialog.__format_lines" ID="PyCoverageDialog.__format_lines"></a> <h4>PyCoverageDialog.__format_lines</h4> <b>__format_lines</b>(<i>lines</i>) <p> - Private method to format a list of integers into string by coalescing groups. + Private method to format a list of integers into string by coalescing groups. </p><dl> <dt><i>lines</i></dt> <dd> -list of integers +list of integers </dd> </dl><dl> <dt>Returns:</dt> <dd> -string representing the list +string representing the list </dd> </dl><a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a> <h4>PyCoverageDialog.__showContextMenu</h4> <b>__showContextMenu</b>(<i>coord</i>) <p> - Private slot to show the context menu of the listview. + Private slot to show the context menu of the listview. </p><dl> <dt><i>coord</i></dt> <dd> -the position of the mouse pointer (QPoint) +the position of the mouse pointer (QPoint) </dd> </dl><a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a> <h4>PyCoverageDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) <p> - Private slot called by a button of the button box clicked. + Private slot called by a button of the button box clicked. </p><dl> <dt><i>button</i></dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked (QAbstractButton) </dd> </dl><a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a> <h4>PyCoverageDialog.on_reloadButton_clicked</h4> <b>on_reloadButton_clicked</b>(<i></i>) <p> - Private slot to reload the coverage info. + Private slot to reload the coverage info. </p><a NAME="PyCoverageDialog.start" ID="PyCoverageDialog.start"></a> <h4>PyCoverageDialog.start</h4> <b>start</b>(<i>cfn, fn</i>) <p> - Public slot to start the coverage data evaluation. + Public slot to start the coverage data evaluation. </p><dl> <dt><i>cfn</i></dt> <dd> -basename of the coverage file (string) +basename of the coverage file (string) </dd><dt><i>fn</i></dt> <dd> -file or list of files or directory to be checked - (string or list of strings) +file or list of files or directory to be checked + (string or list of strings) </dd> </dl><a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a> <h4>PyCoverageDialog.stringify</h4> <b>stringify</b>(<i></i>) <p> - Private helper function to generate a string representation of a pair + Private helper function to generate a string representation of a pair </p><dl> <dt><i>pair</i></dt> <dd> -pair of integers +pair of integers </dd> </dl> <div align="right"><a href="#top">Up</a></div>