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