Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog.html

Documentation/Source/eric6.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog.html

changeset 3673
e26d7d0c1088
child 4237
ff8a3e769fca
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog</h1>
23 <p>
24 Module implementing a dialog to show the output of the tabnanny command
25 process.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#TabnannyDialog">TabnannyDialog</a></td>
35 <td>Class implementing a dialog to show the results of the tabnanny check run.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="TabnannyDialog" ID="TabnannyDialog"></a>
44 <h2>TabnannyDialog</h2>
45 <p>
46 Class implementing a dialog to show the results of the tabnanny check run.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_TabnannyDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#TabnannyDialog.__init__">TabnannyDialog</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#TabnannyDialog.__createResultItem">__createResultItem</a></td>
65 <td>Private method to create an entry in the result list.</td>
66 </tr><tr>
67 <td><a href="#TabnannyDialog.__finish">__finish</a></td>
68 <td>Private slot called when the action or the user pressed the button.</td>
69 </tr><tr>
70 <td><a href="#TabnannyDialog.__processResult">__processResult</a></td>
71 <td>Private slot called after perfoming a style check on one file.</td>
72 </tr><tr>
73 <td><a href="#TabnannyDialog.__resort">__resort</a></td>
74 <td>Private method to resort the tree.</td>
75 </tr><tr>
76 <td><a href="#TabnannyDialog.check">check</a></td>
77 <td>Public method to start a style check for one file.</td>
78 </tr><tr>
79 <td><a href="#TabnannyDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
80 <td>Private slot called by a button of the button box clicked.</td>
81 </tr><tr>
82 <td><a href="#TabnannyDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
83 <td>Private slot to handle the activation of an item.</td>
84 </tr><tr>
85 <td><a href="#TabnannyDialog.on_startButton_clicked">on_startButton_clicked</a></td>
86 <td>Private slot to start a code metrics run.</td>
87 </tr><tr>
88 <td><a href="#TabnannyDialog.prepare">prepare</a></td>
89 <td>Public method to prepare the dialog with a list of filenames.</td>
90 </tr><tr>
91 <td><a href="#TabnannyDialog.start">start</a></td>
92 <td>Public slot to start the tabnanny check.</td>
93 </tr>
94 </table>
95 <h3>Static Methods</h3>
96 <table>
97 <tr><td>None</td></tr>
98 </table>
99 <a NAME="TabnannyDialog.__init__" ID="TabnannyDialog.__init__"></a>
100 <h4>TabnannyDialog (Constructor)</h4>
101 <b>TabnannyDialog</b>(<i>indentCheckService, parent=None</i>)
102 <p>
103 Constructor
104 </p><dl>
105 <dt><i>indentCheckService</i></dt>
106 <dd>
107 reference to the service (IndentCheckService)
108 </dd><dt><i>parent</i></dt>
109 <dd>
110 The parent widget (QWidget).
111 </dd>
112 </dl><a NAME="TabnannyDialog.__createResultItem" ID="TabnannyDialog.__createResultItem"></a>
113 <h4>TabnannyDialog.__createResultItem</h4>
114 <b>__createResultItem</b>(<i>file, line, sourcecode</i>)
115 <p>
116 Private method to create an entry in the result list.
117 </p><dl>
118 <dt><i>file</i></dt>
119 <dd>
120 filename of file (string)
121 </dd><dt><i>line</i></dt>
122 <dd>
123 linenumber of faulty source (integer or string)
124 </dd><dt><i>sourcecode</i></dt>
125 <dd>
126 faulty line of code (string)
127 </dd>
128 </dl><a NAME="TabnannyDialog.__finish" ID="TabnannyDialog.__finish"></a>
129 <h4>TabnannyDialog.__finish</h4>
130 <b>__finish</b>(<i></i>)
131 <p>
132 Private slot called when the action or the user pressed the button.
133 </p><a NAME="TabnannyDialog.__processResult" ID="TabnannyDialog.__processResult"></a>
134 <h4>TabnannyDialog.__processResult</h4>
135 <b>__processResult</b>(<i>fn, nok, line, error</i>)
136 <p>
137 Private slot called after perfoming a style check on one file.
138 </p><dl>
139 <dt><i>fn</i></dt>
140 <dd>
141 filename of the just checked file (str)
142 </dd><dt><i>nok</i></dt>
143 <dd>
144 flag if a problem was found (bool)
145 </dd><dt><i>line</i></dt>
146 <dd>
147 line number (str)
148 </dd><dt><i>error</i></dt>
149 <dd>
150 text of the problem (str)
151 </dd>
152 </dl><a NAME="TabnannyDialog.__resort" ID="TabnannyDialog.__resort"></a>
153 <h4>TabnannyDialog.__resort</h4>
154 <b>__resort</b>(<i></i>)
155 <p>
156 Private method to resort the tree.
157 </p><a NAME="TabnannyDialog.check" ID="TabnannyDialog.check"></a>
158 <h4>TabnannyDialog.check</h4>
159 <b>check</b>(<i>codestring=''</i>)
160 <p>
161 Public method to start a style check for one file.
162 </p><p>
163 The results are reported to the __processResult slot.
164 </p><dl>
165 <dt><i>codestring=</i></dt>
166 <dd>
167 optional sourcestring (str)
168 </dd>
169 </dl><a NAME="TabnannyDialog.on_buttonBox_clicked" ID="TabnannyDialog.on_buttonBox_clicked"></a>
170 <h4>TabnannyDialog.on_buttonBox_clicked</h4>
171 <b>on_buttonBox_clicked</b>(<i>button</i>)
172 <p>
173 Private slot called by a button of the button box clicked.
174 </p><dl>
175 <dt><i>button</i></dt>
176 <dd>
177 button that was clicked (QAbstractButton)
178 </dd>
179 </dl><a NAME="TabnannyDialog.on_resultList_itemActivated" ID="TabnannyDialog.on_resultList_itemActivated"></a>
180 <h4>TabnannyDialog.on_resultList_itemActivated</h4>
181 <b>on_resultList_itemActivated</b>(<i>itm, col</i>)
182 <p>
183 Private slot to handle the activation of an item.
184 </p><dl>
185 <dt><i>itm</i></dt>
186 <dd>
187 reference to the activated item (QTreeWidgetItem)
188 </dd><dt><i>col</i></dt>
189 <dd>
190 column the item was activated in (integer)
191 </dd>
192 </dl><a NAME="TabnannyDialog.on_startButton_clicked" ID="TabnannyDialog.on_startButton_clicked"></a>
193 <h4>TabnannyDialog.on_startButton_clicked</h4>
194 <b>on_startButton_clicked</b>(<i></i>)
195 <p>
196 Private slot to start a code metrics run.
197 </p><a NAME="TabnannyDialog.prepare" ID="TabnannyDialog.prepare"></a>
198 <h4>TabnannyDialog.prepare</h4>
199 <b>prepare</b>(<i>fileList, project</i>)
200 <p>
201 Public method to prepare the dialog with a list of filenames.
202 </p><dl>
203 <dt><i>fileList</i></dt>
204 <dd>
205 list of filenames (list of strings)
206 </dd><dt><i>project</i></dt>
207 <dd>
208 reference to the project object (Project)
209 </dd>
210 </dl><a NAME="TabnannyDialog.start" ID="TabnannyDialog.start"></a>
211 <h4>TabnannyDialog.start</h4>
212 <b>start</b>(<i>fn</i>)
213 <p>
214 Public slot to start the tabnanny check.
215 </p><dl>
216 <dt><i>fn</i></dt>
217 <dd>
218 File or list of files or directory to be checked
219 (string or list of strings)
220 </dd>
221 </dl>
222 <div align="right"><a href="#top">Up</a></div>
223 <hr />
224 </body></html>

Mercurial Repository: eric

eric ide

mercurial