Documentation/Source/eric5.DataViews.CodeMetricsDialog.html

<?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.DataViews.CodeMetricsDialog</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.DataViews.CodeMetricsDialog</h1>
<p>
Module implementing a code metrics dialog.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#CodeMetricsDialog">CodeMetricsDialog</a></td>
<td>Class implementing a dialog to display the code metrics.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="CodeMetricsDialog" ID="CodeMetricsDialog"></a>
<h2>CodeMetricsDialog</h2>
<p>
    Class implementing a dialog to display the code metrics.
</p>
<h3>Derived from</h3>
QDialog, Ui_CodeMetricsDialog
<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="#CodeMetricsDialog.__createResultItem">__createResultItem</a></td>
<td>Private slot to create a new item in the result list.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.__createSummaryItem">__createSummaryItem</a></td>
<td>Private slot to create a new item in the summary list.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.__finish">__finish</a></td>
<td>Private slot called when the action finished or the user pressed the button.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.__getValues">__getValues</a></td>
<td>Private method to extract the code metric values.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.__resizeResultColumns">__resizeResultColumns</a></td>
<td>Private method to resize the list columns.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.__resizeSummaryColumns">__resizeSummaryColumns</a></td>
<td>Private method to resize the list columns.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.__resultCollapse">__resultCollapse</a></td>
<td>Private slot to collapse all entries of the resultlist.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.__resultExpand">__resultExpand</a></td>
<td>Private slot to expand all entries of the resultlist.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.__showContextMenu">__showContextMenu</a></td>
<td>Private slot to show the context menu of the listview.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.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="#CodeMetricsDialog.on_startButton_clicked">on_startButton_clicked</a></td>
<td>Private slot to start a code metrics run.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.prepare">prepare</a></td>
<td>Public method to prepare the dialog with a list of filenames.</td>
</tr><tr>
<td><a href="#CodeMetricsDialog.start">start</a></td>
<td>Public slot to start the code metrics determination.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="CodeMetricsDialog.__init__" ID="CodeMetricsDialog.__init__"></a>
<h4>CodeMetricsDialog (Constructor)</h4>
<b>CodeMetricsDialog</b>(<i>parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
parent widget (QWidget)
</dd>
</dl><a NAME="CodeMetricsDialog.__createResultItem" ID="CodeMetricsDialog.__createResultItem"></a>
<h4>CodeMetricsDialog.__createResultItem</h4>
<b>__createResultItem</b>(<i>parent, strings</i>)
<p>
        Private slot to create a new item in the result list.
</p><dl>
<dt><i>parent</i></dt>
<dd>
parent of the new item (QTreeWidget or QTreeWidgetItem)
</dd><dt><i>strings</i></dt>
<dd>
strings to be displayed (list of strings)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
the generated item
</dd>
</dl><a NAME="CodeMetricsDialog.__createSummaryItem" ID="CodeMetricsDialog.__createSummaryItem"></a>
<h4>CodeMetricsDialog.__createSummaryItem</h4>
<b>__createSummaryItem</b>(<i>col0, col1</i>)
<p>
        Private slot to create a new item in the summary list.
</p><dl>
<dt><i>col0</i></dt>
<dd>
string for column 0 (string)
</dd><dt><i>col1</i></dt>
<dd>
string for column 1 (string)
</dd>
</dl><a NAME="CodeMetricsDialog.__finish" ID="CodeMetricsDialog.__finish"></a>
<h4>CodeMetricsDialog.__finish</h4>
<b>__finish</b>(<i></i>)
<p>
        Private slot called when the action finished or the user pressed the button.
</p><a NAME="CodeMetricsDialog.__getValues" ID="CodeMetricsDialog.__getValues"></a>
<h4>CodeMetricsDialog.__getValues</h4>
<b>__getValues</b>(<i>loc, stats, identifier</i>)
<p>
        Private method to extract the code metric values.
</p><dl>
<dt><i>loc</i></dt>
<dd>
reference to the locale object (QLocale)
</dd><dt><i>stats</i></dt>
<dd>
reference to the code metric statistics object
</dd><dt><i>identifier</i></dt>
<dd>
identifier to get values for
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of values suitable for display (list of strings)
</dd>
</dl><a NAME="CodeMetricsDialog.__resizeResultColumns" ID="CodeMetricsDialog.__resizeResultColumns"></a>
<h4>CodeMetricsDialog.__resizeResultColumns</h4>
<b>__resizeResultColumns</b>(<i></i>)
<p>
        Private method to resize the list columns.
</p><a NAME="CodeMetricsDialog.__resizeSummaryColumns" ID="CodeMetricsDialog.__resizeSummaryColumns"></a>
<h4>CodeMetricsDialog.__resizeSummaryColumns</h4>
<b>__resizeSummaryColumns</b>(<i></i>)
<p>
        Private method to resize the list columns.
</p><a NAME="CodeMetricsDialog.__resultCollapse" ID="CodeMetricsDialog.__resultCollapse"></a>
<h4>CodeMetricsDialog.__resultCollapse</h4>
<b>__resultCollapse</b>(<i></i>)
<p>
        Private slot to collapse all entries of the resultlist.
</p><a NAME="CodeMetricsDialog.__resultExpand" ID="CodeMetricsDialog.__resultExpand"></a>
<h4>CodeMetricsDialog.__resultExpand</h4>
<b>__resultExpand</b>(<i></i>)
<p>
        Private slot to expand all entries of the resultlist.
</p><a NAME="CodeMetricsDialog.__showContextMenu" ID="CodeMetricsDialog.__showContextMenu"></a>
<h4>CodeMetricsDialog.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord</i>)
<p>
        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)
</dd>
</dl><a NAME="CodeMetricsDialog.on_buttonBox_clicked" ID="CodeMetricsDialog.on_buttonBox_clicked"></a>
<h4>CodeMetricsDialog.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="CodeMetricsDialog.on_startButton_clicked" ID="CodeMetricsDialog.on_startButton_clicked"></a>
<h4>CodeMetricsDialog.on_startButton_clicked</h4>
<b>on_startButton_clicked</b>(<i></i>)
<p>
        Private slot to start a code metrics run.
</p><a NAME="CodeMetricsDialog.prepare" ID="CodeMetricsDialog.prepare"></a>
<h4>CodeMetricsDialog.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="CodeMetricsDialog.start" ID="CodeMetricsDialog.start"></a>
<h4>CodeMetricsDialog.start</h4>
<b>start</b>(<i>fn</i>)
<p>
        Public slot to start the code metrics determination.
</p><dl>
<dt><i>fn</i></dt>
<dd>
file or list of files or directory to show
                the code metrics for (string or list of strings)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>