Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html

Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html

changeset 2876
bfa39cf40277
parent 2867
eb325d7f7335
child 2878
61042247f793
equal deleted inserted replaced
2875:1267f0663801 2876:bfa39cf40277
49 </p> 49 </p>
50 <h3>Derived from</h3> 50 <h3>Derived from</h3>
51 QDialog, Ui_Pep8Dialog 51 QDialog, Ui_Pep8Dialog
52 <h3>Class Attributes</h3> 52 <h3>Class Attributes</h3>
53 <table> 53 <table>
54 <tr><td>filenameRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>positionRole</td></tr><tr><td>settingsKey</td></tr> 54 <tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>positionRole</td></tr>
55 </table> 55 </table>
56 <h3>Class Methods</h3> 56 <h3>Class Methods</h3>
57 <table> 57 <table>
58 <tr><td>None</td></tr> 58 <tr><td>None</td></tr>
59 </table> 59 </table>
70 <td>Private method to create an entry in the result list.</td> 70 <td>Private method to create an entry in the result list.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#Pep8Dialog.__finish">__finish</a></td> 72 <td><a href="#Pep8Dialog.__finish">__finish</a></td>
73 <td>Private slot called when the PEP 8 check finished or the user pressed the cancel button.</td> 73 <td>Private slot called when the PEP 8 check finished or the user pressed the cancel button.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#Pep8Dialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td>
76 <td>Private method to extract all selected items for fixable issues.</td>
77 </tr><tr>
78 <td><a href="#Pep8Dialog.__itemFixable">__itemFixable</a></td>
79 <td>Private method to check, if an item has a fixable issue.</td>
80 </tr><tr>
81 <td><a href="#Pep8Dialog.__modifyFixedResultItem">__modifyFixedResultItem</a></td>
82 <td>Private method to modify a result list entry to show its positive fixed state.</td>
83 </tr><tr>
75 <td><a href="#Pep8Dialog.__resetStatistics">__resetStatistics</a></td> 84 <td><a href="#Pep8Dialog.__resetStatistics">__resetStatistics</a></td>
76 <td>Private slot to reset the statistics data.</td> 85 <td>Private slot to reset the statistics data.</td>
77 </tr><tr> 86 </tr><tr>
78 <td><a href="#Pep8Dialog.__resort">__resort</a></td> 87 <td><a href="#Pep8Dialog.__resort">__resort</a></td>
79 <td>Private method to resort the tree.</td> 88 <td>Private method to resort the tree.</td>
80 </tr><tr> 89 </tr><tr>
90 <td><a href="#Pep8Dialog.__selectCodes">__selectCodes</a></td>
91 <td>Private method to select message codes via a selection dialog.</td>
92 </tr><tr>
93 <td><a href="#Pep8Dialog.__updateFixerStatistics">__updateFixerStatistics</a></td>
94 <td>Private method to update the collected fixer related statistics.</td>
95 </tr><tr>
81 <td><a href="#Pep8Dialog.__updateStatistics">__updateStatistics</a></td> 96 <td><a href="#Pep8Dialog.__updateStatistics">__updateStatistics</a></td>
82 <td>Private method to update the collected statistics.</td> 97 <td>Private method to update the collected statistics.</td>
83 </tr><tr> 98 </tr><tr>
84 <td><a href="#Pep8Dialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 99 <td><a href="#Pep8Dialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
85 <td>Private slot called by a button of the button box clicked.</td> 100 <td>Private slot called by a button of the button box clicked.</td>
86 </tr><tr> 101 </tr><tr>
87 <td><a href="#Pep8Dialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td> 102 <td><a href="#Pep8Dialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td>
88 <td>Private slot to select the message codes to be excluded via a selection dialog.</td> 103 <td>Private slot to select the message codes to be excluded via a selection dialog.</td>
89 </tr><tr> 104 </tr><tr>
105 <td><a href="#Pep8Dialog.on_fixButton_clicked">on_fixButton_clicked</a></td>
106 <td>Private slot to fix selected issues.</td>
107 </tr><tr>
90 <td><a href="#Pep8Dialog.on_fixIssuesSelectButton_clicked">on_fixIssuesSelectButton_clicked</a></td> 108 <td><a href="#Pep8Dialog.on_fixIssuesSelectButton_clicked">on_fixIssuesSelectButton_clicked</a></td>
91 <td>Private slot to select the issue codes to be fixed via a selection dialog.</td> 109 <td>Private slot to select the issue codes to be fixed via a selection dialog.</td>
92 </tr><tr> 110 </tr><tr>
93 <td><a href="#Pep8Dialog.on_includeMessagesSelectButton_clicked">on_includeMessagesSelectButton_clicked</a></td> 111 <td><a href="#Pep8Dialog.on_includeMessagesSelectButton_clicked">on_includeMessagesSelectButton_clicked</a></td>
94 <td>Private slot to select the message codes to be included via a selection dialog.</td> 112 <td>Private slot to select the message codes to be included via a selection dialog.</td>
95 </tr><tr> 113 </tr><tr>
96 <td><a href="#Pep8Dialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td> 114 <td><a href="#Pep8Dialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td>
97 <td>Private slot to load the default configuration values.</td> 115 <td>Private slot to load the default configuration values.</td>
98 </tr><tr> 116 </tr><tr>
117 <td><a href="#Pep8Dialog.on_noFixIssuesSelectButton_clicked">on_noFixIssuesSelectButton_clicked</a></td>
118 <td>Private slot to select the issue codes not to be fixed via a selection dialog.</td>
119 </tr><tr>
99 <td><a href="#Pep8Dialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> 120 <td><a href="#Pep8Dialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
100 <td>Private slot to handle the activation of an item.</td> 121 <td>Private slot to handle the activation of an item.</td>
122 </tr><tr>
123 <td><a href="#Pep8Dialog.on_resultList_itemSelectionChanged">on_resultList_itemSelectionChanged</a></td>
124 <td>Private slot to change the dialog state depending on the selection.</td>
101 </tr><tr> 125 </tr><tr>
102 <td><a href="#Pep8Dialog.on_showButton_clicked">on_showButton_clicked</a></td> 126 <td><a href="#Pep8Dialog.on_showButton_clicked">on_showButton_clicked</a></td>
103 <td>Private slot to handle the "Show" button press.</td> 127 <td>Private slot to handle the "Show" button press.</td>
104 </tr><tr> 128 </tr><tr>
105 <td><a href="#Pep8Dialog.on_startButton_clicked">on_startButton_clicked</a></td> 129 <td><a href="#Pep8Dialog.on_startButton_clicked">on_startButton_clicked</a></td>
163 <h4>Pep8Dialog.__finish</h4> 187 <h4>Pep8Dialog.__finish</h4>
164 <b>__finish</b>(<i></i>) 188 <b>__finish</b>(<i></i>)
165 <p> 189 <p>
166 Private slot called when the PEP 8 check finished or the user 190 Private slot called when the PEP 8 check finished or the user
167 pressed the cancel button. 191 pressed the cancel button.
168 </p><a NAME="Pep8Dialog.__resetStatistics" ID="Pep8Dialog.__resetStatistics"></a> 192 </p><a NAME="Pep8Dialog.__getSelectedFixableItems" ID="Pep8Dialog.__getSelectedFixableItems"></a>
193 <h4>Pep8Dialog.__getSelectedFixableItems</h4>
194 <b>__getSelectedFixableItems</b>(<i></i>)
195 <p>
196 Private method to extract all selected items for fixable issues.
197 </p><dl>
198 <dt>Returns:</dt>
199 <dd>
200 selected items for fixable issues (list of QTreeWidgetItem)
201 </dd>
202 </dl><a NAME="Pep8Dialog.__itemFixable" ID="Pep8Dialog.__itemFixable"></a>
203 <h4>Pep8Dialog.__itemFixable</h4>
204 <b>__itemFixable</b>(<i>itm</i>)
205 <p>
206 Private method to check, if an item has a fixable issue.
207 </p><dl>
208 <dt><i>itm</i></dt>
209 <dd>
210 item to be checked (QTreeWidgetItem)
211 </dd>
212 </dl><dl>
213 <dt>Returns:</dt>
214 <dd>
215 flag indicating a fixable issue (boolean)
216 </dd>
217 </dl><a NAME="Pep8Dialog.__modifyFixedResultItem" ID="Pep8Dialog.__modifyFixedResultItem"></a>
218 <h4>Pep8Dialog.__modifyFixedResultItem</h4>
219 <b>__modifyFixedResultItem</b>(<i>itm, text</i>)
220 <p>
221 Private method to modify a result list entry to show its
222 positive fixed state.
223 </p><dl>
224 <dt><i>itm</i></dt>
225 <dd>
226 reference to the item to modify (QTreeWidgetItem)
227 </dd><dt><i>text</i></dt>
228 <dd>
229 text to be appended (string)
230 </dd>
231 </dl><a NAME="Pep8Dialog.__resetStatistics" ID="Pep8Dialog.__resetStatistics"></a>
169 <h4>Pep8Dialog.__resetStatistics</h4> 232 <h4>Pep8Dialog.__resetStatistics</h4>
170 <b>__resetStatistics</b>(<i></i>) 233 <b>__resetStatistics</b>(<i></i>)
171 <p> 234 <p>
172 Private slot to reset the statistics data. 235 Private slot to reset the statistics data.
173 </p><a NAME="Pep8Dialog.__resort" ID="Pep8Dialog.__resort"></a> 236 </p><a NAME="Pep8Dialog.__resort" ID="Pep8Dialog.__resort"></a>
174 <h4>Pep8Dialog.__resort</h4> 237 <h4>Pep8Dialog.__resort</h4>
175 <b>__resort</b>(<i></i>) 238 <b>__resort</b>(<i></i>)
176 <p> 239 <p>
177 Private method to resort the tree. 240 Private method to resort the tree.
178 </p><a NAME="Pep8Dialog.__updateStatistics" ID="Pep8Dialog.__updateStatistics"></a> 241 </p><a NAME="Pep8Dialog.__selectCodes" ID="Pep8Dialog.__selectCodes"></a>
242 <h4>Pep8Dialog.__selectCodes</h4>
243 <b>__selectCodes</b>(<i>edit, showFixCodes</i>)
244 <p>
245 Private method to select message codes via a selection dialog.
246 </p><dl>
247 <dt><i>edit</i></dt>
248 <dd>
249 reference of the line edit to be populated (QLineEdit)
250 </dd><dt><i>showFixCodes</i></dt>
251 <dd>
252 flag indicating to show a list of fixable
253 issues (boolean)
254 </dd>
255 </dl><a NAME="Pep8Dialog.__updateFixerStatistics" ID="Pep8Dialog.__updateFixerStatistics"></a>
256 <h4>Pep8Dialog.__updateFixerStatistics</h4>
257 <b>__updateFixerStatistics</b>(<i>fixer</i>)
258 <p>
259 Private method to update the collected fixer related statistics.
260 </p><dl>
261 <dt><i>fixer</i></dt>
262 <dd>
263 reference to the PEP 8 fixer (Pep8Fixer)
264 </dd>
265 </dl><a NAME="Pep8Dialog.__updateStatistics" ID="Pep8Dialog.__updateStatistics"></a>
179 <h4>Pep8Dialog.__updateStatistics</h4> 266 <h4>Pep8Dialog.__updateStatistics</h4>
180 <b>__updateStatistics</b>(<i>statistics, fixer</i>) 267 <b>__updateStatistics</b>(<i>statistics, fixer</i>)
181 <p> 268 <p>
182 Private method to update the collected statistics. 269 Private method to update the collected statistics.
183 </p><dl> 270 </p><dl>
203 <h4>Pep8Dialog.on_excludeMessagesSelectButton_clicked</h4> 290 <h4>Pep8Dialog.on_excludeMessagesSelectButton_clicked</h4>
204 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>) 291 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
205 <p> 292 <p>
206 Private slot to select the message codes to be excluded via a 293 Private slot to select the message codes to be excluded via a
207 selection dialog. 294 selection dialog.
295 </p><a NAME="Pep8Dialog.on_fixButton_clicked" ID="Pep8Dialog.on_fixButton_clicked"></a>
296 <h4>Pep8Dialog.on_fixButton_clicked</h4>
297 <b>on_fixButton_clicked</b>(<i></i>)
298 <p>
299 Private slot to fix selected issues.
208 </p><a NAME="Pep8Dialog.on_fixIssuesSelectButton_clicked" ID="Pep8Dialog.on_fixIssuesSelectButton_clicked"></a> 300 </p><a NAME="Pep8Dialog.on_fixIssuesSelectButton_clicked" ID="Pep8Dialog.on_fixIssuesSelectButton_clicked"></a>
209 <h4>Pep8Dialog.on_fixIssuesSelectButton_clicked</h4> 301 <h4>Pep8Dialog.on_fixIssuesSelectButton_clicked</h4>
210 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>) 302 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>)
211 <p> 303 <p>
212 Private slot to select the issue codes to be fixed via a 304 Private slot to select the issue codes to be fixed via a
220 </p><a NAME="Pep8Dialog.on_loadDefaultButton_clicked" ID="Pep8Dialog.on_loadDefaultButton_clicked"></a> 312 </p><a NAME="Pep8Dialog.on_loadDefaultButton_clicked" ID="Pep8Dialog.on_loadDefaultButton_clicked"></a>
221 <h4>Pep8Dialog.on_loadDefaultButton_clicked</h4> 313 <h4>Pep8Dialog.on_loadDefaultButton_clicked</h4>
222 <b>on_loadDefaultButton_clicked</b>(<i></i>) 314 <b>on_loadDefaultButton_clicked</b>(<i></i>)
223 <p> 315 <p>
224 Private slot to load the default configuration values. 316 Private slot to load the default configuration values.
317 </p><a NAME="Pep8Dialog.on_noFixIssuesSelectButton_clicked" ID="Pep8Dialog.on_noFixIssuesSelectButton_clicked"></a>
318 <h4>Pep8Dialog.on_noFixIssuesSelectButton_clicked</h4>
319 <b>on_noFixIssuesSelectButton_clicked</b>(<i></i>)
320 <p>
321 Private slot to select the issue codes not to be fixed via a
322 selection dialog.
225 </p><a NAME="Pep8Dialog.on_resultList_itemActivated" ID="Pep8Dialog.on_resultList_itemActivated"></a> 323 </p><a NAME="Pep8Dialog.on_resultList_itemActivated" ID="Pep8Dialog.on_resultList_itemActivated"></a>
226 <h4>Pep8Dialog.on_resultList_itemActivated</h4> 324 <h4>Pep8Dialog.on_resultList_itemActivated</h4>
227 <b>on_resultList_itemActivated</b>(<i>item, column</i>) 325 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
228 <p> 326 <p>
229 Private slot to handle the activation of an item. 327 Private slot to handle the activation of an item.
233 reference to the activated item (QTreeWidgetItem) 331 reference to the activated item (QTreeWidgetItem)
234 </dd><dt><i>column</i></dt> 332 </dd><dt><i>column</i></dt>
235 <dd> 333 <dd>
236 column the item was activated in (integer) 334 column the item was activated in (integer)
237 </dd> 335 </dd>
238 </dl><a NAME="Pep8Dialog.on_showButton_clicked" ID="Pep8Dialog.on_showButton_clicked"></a> 336 </dl><a NAME="Pep8Dialog.on_resultList_itemSelectionChanged" ID="Pep8Dialog.on_resultList_itemSelectionChanged"></a>
337 <h4>Pep8Dialog.on_resultList_itemSelectionChanged</h4>
338 <b>on_resultList_itemSelectionChanged</b>(<i></i>)
339 <p>
340 Private slot to change the dialog state depending on the selection.
341 </p><a NAME="Pep8Dialog.on_showButton_clicked" ID="Pep8Dialog.on_showButton_clicked"></a>
239 <h4>Pep8Dialog.on_showButton_clicked</h4> 342 <h4>Pep8Dialog.on_showButton_clicked</h4>
240 <b>on_showButton_clicked</b>(<i></i>) 343 <b>on_showButton_clicked</b>(<i></i>)
241 <p> 344 <p>
242 Private slot to handle the "Show" button press. 345 Private slot to handle the "Show" button press.
243 </p><a NAME="Pep8Dialog.on_startButton_clicked" ID="Pep8Dialog.on_startButton_clicked"></a> 346 </p><a NAME="Pep8Dialog.on_startButton_clicked" ID="Pep8Dialog.on_startButton_clicked"></a>

Mercurial Repository: eric

eric ide

mercurial