--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.DataViews.PyCoverageJsonReportDialog.html Mon May 23 18:15:10 2022 +0200 @@ -0,0 +1,133 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.DataViews.PyCoverageJsonReportDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.DataViews.PyCoverageJsonReportDialog</h1> + +<p> +Module implementing a dialog to enter the parameters for a coverage JSON +report. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#PyCoverageJsonReportDialog">PyCoverageJsonReportDialog</a></td> +<td>Class implementing a dialog to enter the parameters for a coverage JSON report.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="PyCoverageJsonReportDialog" ID="PyCoverageJsonReportDialog"></a> +<h2>PyCoverageJsonReportDialog</h2> + +<p> + Class implementing a dialog to enter the parameters for a coverage JSON + report. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyCoverageJsonReportDialog +<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="#PyCoverageJsonReportDialog.__init__">PyCoverageJsonReportDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PyCoverageJsonReportDialog.getData">getData</a></td> +<td>Public method to get the entered data.</td> +</tr> +<tr> +<td><a href="#PyCoverageJsonReportDialog.on_outputFilePicker_textChanged">on_outputFilePicker_textChanged</a></td> +<td>Private slot handling a change of the output file.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="PyCoverageJsonReportDialog.__init__" ID="PyCoverageJsonReportDialog.__init__"></a> +<h4>PyCoverageJsonReportDialog (Constructor)</h4> +<b>PyCoverageJsonReportDialog</b>(<i>defaultDirectory, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>defaultDirectory</i> (str)</dt> +<dd> +default directory for selecting the output + directory +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="PyCoverageJsonReportDialog.getData" ID="PyCoverageJsonReportDialog.getData"></a> +<h4>PyCoverageJsonReportDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to get the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the output file and a flag indicating the + creation of a compact JSON file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) +</dd> +</dl> +<a NAME="PyCoverageJsonReportDialog.on_outputFilePicker_textChanged" ID="PyCoverageJsonReportDialog.on_outputFilePicker_textChanged"></a> +<h4>PyCoverageJsonReportDialog.on_outputFilePicker_textChanged</h4> +<b>on_outputFilePicker_textChanged</b>(<i>filename</i>) + +<p> + Private slot handling a change of the output file. +</p> +<dl> + +<dt><i>filename</i> (str)</dt> +<dd> +current text of the file picker +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file