Mercurial Repositories > PyLint Checker / file comparison

comparison: PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog.html

PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog.html

branch
eric7
changeset 117
f8955e5dba87
parent 102
e40ecfd9ec37
equal deleted inserted replaced
116:71d3a2e48265 117:f8955e5dba87
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog</h1> 9 <h1>Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the results of the PyLint run. 11 Module implementing a dialog to show the results of the PyLint run.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#PyLintExecDialog">PyLintExecDialog</a></td> 22 <td><a href="#PyLintExecDialog">PyLintExecDialog</a></td>
25 <td>Class implementing a dialog to show the results of the PyLint run.</td> 23 <td>Class implementing a dialog to show the results of the PyLint run.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="PyLintExecDialog" ID="PyLintExecDialog"></a> 34 <a NAME="PyLintExecDialog" ID="PyLintExecDialog"></a>
36 <h2>PyLintExecDialog</h2> 35 <h2>PyLintExecDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to show the results of the PyLint run. 37 Class implementing a dialog to show the results of the PyLint run.
40 </p> 38 </p>
41 <p> 39 <p>
42 This class starts a QProcess and displays a dialog that 40 This class starts a QProcess and displays a dialog that
43 shows the results of the PyLint command process. 41 shows the results of the PyLint command process.
44 </p> 42 </p>
43
45 <h3>Derived from</h3> 44 <h3>Derived from</h3>
46 QWidget, Ui_PyLintExecDialog 45 QWidget, Ui_PyLintExecDialog
47 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
48
49 <table> 47 <table>
50 <tr><td>filenameRole</td></tr> 48 <tr><td>filenameRole</td></tr>
51 </table> 49 </table>
50
52 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
53 52 <table>
54 <table> 53 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 54 </table>
56 </table> 55
57 <h3>Methods</h3> 56 <h3>Methods</h3>
58 57 <table>
59 <table>
60
61 <tr> 58 <tr>
62 <td><a href="#PyLintExecDialog.__init__">PyLintExecDialog</a></td> 59 <td><a href="#PyLintExecDialog.__init__">PyLintExecDialog</a></td>
63 <td>Constructor</td> 60 <td>Constructor</td>
64 </tr> 61 </tr>
65 <tr> 62 <tr>
105 <tr> 102 <tr>
106 <td><a href="#PyLintExecDialog.start">start</a></td> 103 <td><a href="#PyLintExecDialog.start">start</a></td>
107 <td>Public slot to start PyLint.</td> 104 <td>Public slot to start PyLint.</td>
108 </tr> 105 </tr>
109 </table> 106 </table>
107
110 <h3>Static Methods</h3> 108 <h3>Static Methods</h3>
111 109 <table>
112 <table> 110 <tr><td>None</td></tr>
113 <tr><td>None</td></tr> 111 </table>
114 </table> 112
115 113
116 <a NAME="PyLintExecDialog.__init__" ID="PyLintExecDialog.__init__"></a> 114 <a NAME="PyLintExecDialog.__init__" ID="PyLintExecDialog.__init__"></a>
117 <h4>PyLintExecDialog (Constructor)</h4> 115 <h4>PyLintExecDialog (Constructor)</h4>
118 <b>PyLintExecDialog</b>(<i>parent=None</i>) 116 <b>PyLintExecDialog</b>(<i>parent=None</i>)
119
120 <p> 117 <p>
121 Constructor 118 Constructor
122 </p> 119 </p>
120
123 <dl> 121 <dl>
124 122
125 <dt><i>parent</i> (QWidget)</dt> 123 <dt><i>parent</i> (QWidget)</dt>
126 <dd> 124 <dd>
127 parent widget of this dialog 125 parent widget of this dialog
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="PyLintExecDialog.__createItem" ID="PyLintExecDialog.__createItem"></a> 128 <a NAME="PyLintExecDialog.__createItem" ID="PyLintExecDialog.__createItem"></a>
131 <h4>PyLintExecDialog.__createItem</h4> 129 <h4>PyLintExecDialog.__createItem</h4>
132 <b>__createItem</b>(<i>file, line, type_, message</i>) 130 <b>__createItem</b>(<i>file, line, type_, message</i>)
133
134 <p> 131 <p>
135 Private method to create an entry in the message list. 132 Private method to create an entry in the message list.
136 </p> 133 </p>
134
137 <dl> 135 <dl>
138 136
139 <dt><i>file</i> (str)</dt> 137 <dt><i>file</i> (str)</dt>
140 <dd> 138 <dd>
141 filename of file 139 filename of file
154 </dd> 152 </dd>
155 </dl> 153 </dl>
156 <a NAME="PyLintExecDialog.__finish" ID="PyLintExecDialog.__finish"></a> 154 <a NAME="PyLintExecDialog.__finish" ID="PyLintExecDialog.__finish"></a>
157 <h4>PyLintExecDialog.__finish</h4> 155 <h4>PyLintExecDialog.__finish</h4>
158 <b>__finish</b>(<i></i>) 156 <b>__finish</b>(<i></i>)
159
160 <p> 157 <p>
161 Private slot called when the process finished. 158 Private slot called when the process finished.
162 </p> 159 </p>
163 <p> 160 <p>
164 It is called when the process finished or the user pressed the button. 161 It is called when the process finished or the user pressed the button.
165 </p> 162 </p>
163
166 <a NAME="PyLintExecDialog.__readParseStdout" ID="PyLintExecDialog.__readParseStdout"></a> 164 <a NAME="PyLintExecDialog.__readParseStdout" ID="PyLintExecDialog.__readParseStdout"></a>
167 <h4>PyLintExecDialog.__readParseStdout</h4> 165 <h4>PyLintExecDialog.__readParseStdout</h4>
168 <b>__readParseStdout</b>(<i></i>) 166 <b>__readParseStdout</b>(<i></i>)
169
170 <p> 167 <p>
171 Private slot to handle the readyReadStandardOutput signal for 168 Private slot to handle the readyReadStandardOutput signal for
172 parseable output. 169 parseable output.
173 </p> 170 </p>
174 <p> 171 <p>
175 It reads the output of the process, formats it and inserts it into 172 It reads the output of the process, formats it and inserts it into
176 the message list pane. 173 the message list pane.
177 </p> 174 </p>
175
178 <a NAME="PyLintExecDialog.__readStderr" ID="PyLintExecDialog.__readStderr"></a> 176 <a NAME="PyLintExecDialog.__readStderr" ID="PyLintExecDialog.__readStderr"></a>
179 <h4>PyLintExecDialog.__readStderr</h4> 177 <h4>PyLintExecDialog.__readStderr</h4>
180 <b>__readStderr</b>(<i></i>) 178 <b>__readStderr</b>(<i></i>)
181
182 <p> 179 <p>
183 Private slot to handle the readyReadStandardError signal. 180 Private slot to handle the readyReadStandardError signal.
184 </p> 181 </p>
185 <p> 182 <p>
186 It reads the error output of the process and inserts it into the 183 It reads the error output of the process and inserts it into the
187 error pane. 184 error pane.
188 </p> 185 </p>
186
189 <a NAME="PyLintExecDialog.__readStdout" ID="PyLintExecDialog.__readStdout"></a> 187 <a NAME="PyLintExecDialog.__readStdout" ID="PyLintExecDialog.__readStdout"></a>
190 <h4>PyLintExecDialog.__readStdout</h4> 188 <h4>PyLintExecDialog.__readStdout</h4>
191 <b>__readStdout</b>(<i></i>) 189 <b>__readStdout</b>(<i></i>)
192
193 <p> 190 <p>
194 Private slot to handle the readyReadStandardOutput signal. 191 Private slot to handle the readyReadStandardOutput signal.
195 </p> 192 </p>
196 <p> 193 <p>
197 It reads the output of the process, formats it and inserts it into 194 It reads the output of the process, formats it and inserts it into
198 the contents pane. 195 the contents pane.
199 </p> 196 </p>
197
200 <a NAME="PyLintExecDialog.__writeReport" ID="PyLintExecDialog.__writeReport"></a> 198 <a NAME="PyLintExecDialog.__writeReport" ID="PyLintExecDialog.__writeReport"></a>
201 <h4>PyLintExecDialog.__writeReport</h4> 199 <h4>PyLintExecDialog.__writeReport</h4>
202 <b>__writeReport</b>(<i></i>) 200 <b>__writeReport</b>(<i></i>)
203
204 <p> 201 <p>
205 Private slot to write the report to a report file. 202 Private slot to write the report to a report file.
206 </p> 203 </p>
204
207 <a NAME="PyLintExecDialog.on_buttonBox_clicked" ID="PyLintExecDialog.on_buttonBox_clicked"></a> 205 <a NAME="PyLintExecDialog.on_buttonBox_clicked" ID="PyLintExecDialog.on_buttonBox_clicked"></a>
208 <h4>PyLintExecDialog.on_buttonBox_clicked</h4> 206 <h4>PyLintExecDialog.on_buttonBox_clicked</h4>
209 <b>on_buttonBox_clicked</b>(<i>button</i>) 207 <b>on_buttonBox_clicked</b>(<i>button</i>)
210
211 <p> 208 <p>
212 Private slot called by a button of the button box clicked. 209 Private slot called by a button of the button box clicked.
213 </p> 210 </p>
211
214 <dl> 212 <dl>
215 213
216 <dt><i>button</i> (QAbstractButton)</dt> 214 <dt><i>button</i> (QAbstractButton)</dt>
217 <dd> 215 <dd>
218 button that was clicked 216 button that was clicked
219 </dd> 217 </dd>
220 </dl> 218 </dl>
221 <a NAME="PyLintExecDialog.on_messageList_itemActivated" ID="PyLintExecDialog.on_messageList_itemActivated"></a> 219 <a NAME="PyLintExecDialog.on_messageList_itemActivated" ID="PyLintExecDialog.on_messageList_itemActivated"></a>
222 <h4>PyLintExecDialog.on_messageList_itemActivated</h4> 220 <h4>PyLintExecDialog.on_messageList_itemActivated</h4>
223 <b>on_messageList_itemActivated</b>(<i>itm, column</i>) 221 <b>on_messageList_itemActivated</b>(<i>itm, column</i>)
224
225 <p> 222 <p>
226 Private slot to handle the itemActivated signal of the message list. 223 Private slot to handle the itemActivated signal of the message list.
227 </p> 224 </p>
225
228 <dl> 226 <dl>
229 227
230 <dt><i>itm</i> (QTreeWidgetItem)</dt> 228 <dt><i>itm</i> (QTreeWidgetItem)</dt>
231 <dd> 229 <dd>
232 The message item that was activated 230 The message item that was activated
237 </dd> 235 </dd>
238 </dl> 236 </dl>
239 <a NAME="PyLintExecDialog.on_refreshButton_clicked" ID="PyLintExecDialog.on_refreshButton_clicked"></a> 237 <a NAME="PyLintExecDialog.on_refreshButton_clicked" ID="PyLintExecDialog.on_refreshButton_clicked"></a>
240 <h4>PyLintExecDialog.on_refreshButton_clicked</h4> 238 <h4>PyLintExecDialog.on_refreshButton_clicked</h4>
241 <b>on_refreshButton_clicked</b>(<i></i>) 239 <b>on_refreshButton_clicked</b>(<i></i>)
242
243 <p> 240 <p>
244 Private slot to refresh the status display. 241 Private slot to refresh the status display.
245 </p> 242 </p>
243
246 <a NAME="PyLintExecDialog.on_saveButton_clicked" ID="PyLintExecDialog.on_saveButton_clicked"></a> 244 <a NAME="PyLintExecDialog.on_saveButton_clicked" ID="PyLintExecDialog.on_saveButton_clicked"></a>
247 <h4>PyLintExecDialog.on_saveButton_clicked</h4> 245 <h4>PyLintExecDialog.on_saveButton_clicked</h4>
248 <b>on_saveButton_clicked</b>(<i></i>) 246 <b>on_saveButton_clicked</b>(<i></i>)
249
250 <p> 247 <p>
251 Private slot to save the report to a file. 248 Private slot to save the report to a file.
252 </p> 249 </p>
250
253 <a NAME="PyLintExecDialog.start" ID="PyLintExecDialog.start"></a> 251 <a NAME="PyLintExecDialog.start" ID="PyLintExecDialog.start"></a>
254 <h4>PyLintExecDialog.start</h4> 252 <h4>PyLintExecDialog.start</h4>
255 <b>start</b>(<i>args, fn, reportFile, ppath</i>) 253 <b>start</b>(<i>args, fn, reportFile, ppath</i>)
256
257 <p> 254 <p>
258 Public slot to start PyLint. 255 Public slot to start PyLint.
259 </p> 256 </p>
257
260 <dl> 258 <dl>
261 259
262 <dt><i>args</i> (list of str)</dt> 260 <dt><i>args</i> (list of str)</dt>
263 <dd> 261 <dd>
264 commandline arguments for documentation programPyLint 262 commandline arguments for documentation programPyLint

Mercurial Repository: PyLint Checker

eric ide

mercurial