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

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog</h1>
24 <p>
25 Module implementing a dialog to show the output of the tabnanny command 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>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#TabnannyDialog.__init__">TabnannyDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#TabnannyDialog.__createResultItem">__createResultItem</a></td>
61 <td>Private method to create an entry in the result list.</td>
62 </tr><tr>
63 <td><a href="#TabnannyDialog.__finish">__finish</a></td>
64 <td>Private slot called when the action or the user pressed the button.</td>
65 </tr><tr>
66 <td><a href="#TabnannyDialog.__resort">__resort</a></td>
67 <td>Private method to resort the tree.</td>
68 </tr><tr>
69 <td><a href="#TabnannyDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
70 <td>Private slot called by a button of the button box clicked.</td>
71 </tr><tr>
72 <td><a href="#TabnannyDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
73 <td>Private slot to handle the activation of an item.</td>
74 </tr><tr>
75 <td><a href="#TabnannyDialog.start">start</a></td>
76 <td>Public slot to start the tabnanny check.</td>
77 </tr>
78 </table>
79 <a NAME="TabnannyDialog.__init__" ID="TabnannyDialog.__init__"></a>
80 <h4>TabnannyDialog (Constructor)</h4>
81 <b>TabnannyDialog</b>(<i>parent = None</i>)
82 <p>
83 Constructor
84 </p><dl>
85 <dt><i>parent</i></dt>
86 <dd>
87 The parent widget (QWidget).
88 </dd>
89 </dl><a NAME="TabnannyDialog.__createResultItem" ID="TabnannyDialog.__createResultItem"></a>
90 <h4>TabnannyDialog.__createResultItem</h4>
91 <b>__createResultItem</b>(<i>file, line, sourcecode</i>)
92 <p>
93 Private method to create an entry in the result list.
94 </p><dl>
95 <dt><i>file</i></dt>
96 <dd>
97 filename of file (string)
98 </dd><dt><i>line</i></dt>
99 <dd>
100 linenumber of faulty source (integer or string)
101 </dd><dt><i>sourcecode</i></dt>
102 <dd>
103 faulty line of code (string)
104 </dd>
105 </dl><a NAME="TabnannyDialog.__finish" ID="TabnannyDialog.__finish"></a>
106 <h4>TabnannyDialog.__finish</h4>
107 <b>__finish</b>(<i></i>)
108 <p>
109 Private slot called when the action or the user pressed the button.
110 </p><a NAME="TabnannyDialog.__resort" ID="TabnannyDialog.__resort"></a>
111 <h4>TabnannyDialog.__resort</h4>
112 <b>__resort</b>(<i></i>)
113 <p>
114 Private method to resort the tree.
115 </p><a NAME="TabnannyDialog.on_buttonBox_clicked" ID="TabnannyDialog.on_buttonBox_clicked"></a>
116 <h4>TabnannyDialog.on_buttonBox_clicked</h4>
117 <b>on_buttonBox_clicked</b>(<i>button</i>)
118 <p>
119 Private slot called by a button of the button box clicked.
120 </p><dl>
121 <dt><i>button</i></dt>
122 <dd>
123 button that was clicked (QAbstractButton)
124 </dd>
125 </dl><a NAME="TabnannyDialog.on_resultList_itemActivated" ID="TabnannyDialog.on_resultList_itemActivated"></a>
126 <h4>TabnannyDialog.on_resultList_itemActivated</h4>
127 <b>on_resultList_itemActivated</b>(<i>itm, col</i>)
128 <p>
129 Private slot to handle the activation of an item.
130 </p><dl>
131 <dt><i>itm</i></dt>
132 <dd>
133 reference to the activated item (QTreeWidgetItem)
134 </dd><dt><i>col</i></dt>
135 <dd>
136 column the item was activated in (integer)
137 </dd>
138 </dl><a NAME="TabnannyDialog.start" ID="TabnannyDialog.start"></a>
139 <h4>TabnannyDialog.start</h4>
140 <b>start</b>(<i>fn</i>)
141 <p>
142 Public slot to start the tabnanny check.
143 </p><dl>
144 <dt><i>fn</i></dt>
145 <dd>
146 File or list of files or directory to be checked
147 (string or list of strings)
148 </dd>
149 </dl>
150 <div align="right"><a href="#top">Up</a></div>
151 <hr />
152 </body></html>

eric ide

mercurial