eric7/Documentation/Source/eric7.DataViews.PyCoverageHtmlReportDialog.html

branch
eric7
changeset 9097
213951c41dcd
equal deleted inserted replaced
9096:f6f7d8f364c3 9097:213951c41dcd
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.DataViews.PyCoverageHtmlReportDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.DataViews.PyCoverageHtmlReportDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the parameters for a coverage HTML
13 report.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#PyCoverageHtmlReportDialog">PyCoverageHtmlReportDialog</a></td>
26 <td>Class implementing a dialog to enter the parameters for a coverage HTML report.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="PyCoverageHtmlReportDialog" ID="PyCoverageHtmlReportDialog"></a>
37 <h2>PyCoverageHtmlReportDialog</h2>
38
39 <p>
40 Class implementing a dialog to enter the parameters for a coverage HTML
41 report.
42 </p>
43 <h3>Derived from</h3>
44 QDialog, Ui_PyCoverageHtmlReportDialog
45 <h3>Class Attributes</h3>
46
47 <table>
48 <tr><td>None</td></tr>
49 </table>
50 <h3>Class Methods</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Methods</h3>
56
57 <table>
58
59 <tr>
60 <td><a href="#PyCoverageHtmlReportDialog.__init__">PyCoverageHtmlReportDialog</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#PyCoverageHtmlReportDialog.getData">getData</a></td>
65 <td>Public method to get the entered data.</td>
66 </tr>
67 <tr>
68 <td><a href="#PyCoverageHtmlReportDialog.on_outputDirectoryPicker_textChanged">on_outputDirectoryPicker_textChanged</a></td>
69 <td>Private slot handling a change of the output directory.</td>
70 </tr>
71 </table>
72 <h3>Static Methods</h3>
73
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77
78 <a NAME="PyCoverageHtmlReportDialog.__init__" ID="PyCoverageHtmlReportDialog.__init__"></a>
79 <h4>PyCoverageHtmlReportDialog (Constructor)</h4>
80 <b>PyCoverageHtmlReportDialog</b>(<i>defaultDirectory, parent=None</i>)
81
82 <p>
83 Constructor
84 </p>
85 <dl>
86
87 <dt><i>defaultDirectory</i> (str)</dt>
88 <dd>
89 default directory for selecting the output
90 directory
91 </dd>
92 <dt><i>parent</i> (QWidget (optional))</dt>
93 <dd>
94 reference to the parent widget (defaults to None)
95 </dd>
96 </dl>
97 <a NAME="PyCoverageHtmlReportDialog.getData" ID="PyCoverageHtmlReportDialog.getData"></a>
98 <h4>PyCoverageHtmlReportDialog.getData</h4>
99 <b>getData</b>(<i></i>)
100
101 <p>
102 Public method to get the entered data.
103 </p>
104 <dl>
105 <dt>Return:</dt>
106 <dd>
107 tuple containing the report title, the output directory, the
108 path of a file containing extra CSS and a flag indicating to open
109 the generated report in a browser
110 </dd>
111 </dl>
112 <dl>
113 <dt>Return Type:</dt>
114 <dd>
115 tuple of (str, str, str, bool)
116 </dd>
117 </dl>
118 <a NAME="PyCoverageHtmlReportDialog.on_outputDirectoryPicker_textChanged" ID="PyCoverageHtmlReportDialog.on_outputDirectoryPicker_textChanged"></a>
119 <h4>PyCoverageHtmlReportDialog.on_outputDirectoryPicker_textChanged</h4>
120 <b>on_outputDirectoryPicker_textChanged</b>(<i>directory</i>)
121
122 <p>
123 Private slot handling a change of the output directory.
124 </p>
125 <dl>
126
127 <dt><i>directory</i> (str)</dt>
128 <dd>
129 current text of the directory picker
130 </dd>
131 </dl>
132 <div align="right"><a href="#top">Up</a></div>
133 <hr />
134 </body></html>

eric ide

mercurial