PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog.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.PyLintConfigDialog</h1> 9 <h1>Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to configure the PyLint process. 11 Module implementing a dialog to configure the PyLint process.
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="#PyLintConfigDialog">PyLintConfigDialog</a></td> 22 <td><a href="#PyLintConfigDialog">PyLintConfigDialog</a></td>
25 <td>Class implementing a dialog to configure the PyLint process.</td> 23 <td>Class implementing a dialog to configure the PyLint process.</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="PyLintConfigDialog" ID="PyLintConfigDialog"></a> 34 <a NAME="PyLintConfigDialog" ID="PyLintConfigDialog"></a>
36 <h2>PyLintConfigDialog</h2> 35 <h2>PyLintConfigDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to configure the PyLint process. 37 Class implementing a dialog to configure the PyLint process.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_PyLintConfigDialog 41 QDialog, Ui_PyLintConfigDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td> 55 <td><a href="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
85 <tr> 82 <tr>
86 <td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td> 83 <td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td>
87 <td>Private slot to handle the generation of a sample configuration.</td> 84 <td>Private slot to handle the generation of a sample configuration.</td>
88 </tr> 85 </tr>
89 </table> 86 </table>
87
90 <h3>Static Methods</h3> 88 <h3>Static Methods</h3>
91 89 <table>
92 <table> 90 <tr><td>None</td></tr>
93 <tr><td>None</td></tr> 91 </table>
94 </table> 92
95 93
96 <a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a> 94 <a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a>
97 <h4>PyLintConfigDialog (Constructor)</h4> 95 <h4>PyLintConfigDialog (Constructor)</h4>
98 <b>PyLintConfigDialog</b>(<i>ppath, exe, parms, version</i>) 96 <b>PyLintConfigDialog</b>(<i>ppath, exe, parms, version, parent=None</i>)
99
100 <p> 97 <p>
101 Constructor 98 Constructor
102 </p> 99 </p>
100
103 <dl> 101 <dl>
104 102
105 <dt><i>ppath</i> (str)</dt> 103 <dt><i>ppath</i> (str)</dt>
106 <dd> 104 <dd>
107 project path; used to set the default path for the 105 project path; used to set the default path for the
116 parameters to set in the dialog 114 parameters to set in the dialog
117 </dd> 115 </dd>
118 <dt><i>version</i> (str)</dt> 116 <dt><i>version</i> (str)</dt>
119 <dd> 117 <dd>
120 pylint version (unused) 118 pylint version (unused)
119 </dd>
120 <dt><i>parent</i> (QWidget)</dt>
121 <dd>
122 reference to the parent widget (defaults to None)
121 </dd> 123 </dd>
122 </dl> 124 </dl>
123 <a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a> 125 <a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a>
124 <h4>PyLintConfigDialog.__createConfigDone</h4> 126 <h4>PyLintConfigDialog.__createConfigDone</h4>
125 <b>__createConfigDone</b>(<i>exitCode, exitStatus</i>) 127 <b>__createConfigDone</b>(<i>exitCode, exitStatus</i>)
126
127 <p> 128 <p>
128 Private slot to handle the the finished signal of the pylint process. 129 Private slot to handle the the finished signal of the pylint process.
129 </p> 130 </p>
131
130 <dl> 132 <dl>
131 133
132 <dt><i>exitCode</i> (int)</dt> 134 <dt><i>exitCode</i> (int)</dt>
133 <dd> 135 <dd>
134 exit code of the process 136 exit code of the process
139 </dd> 141 </dd>
140 </dl> 142 </dl>
141 <a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a> 143 <a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a>
142 <h4>PyLintConfigDialog.__initializeDefaults</h4> 144 <h4>PyLintConfigDialog.__initializeDefaults</h4>
143 <b>__initializeDefaults</b>(<i></i>) 145 <b>__initializeDefaults</b>(<i></i>)
144
145 <p> 146 <p>
146 Private method to set the default values. 147 Private method to set the default values.
147 </p> 148 </p>
148 <p> 149 <p>
149 These are needed later on to generate the commandline 150 These are needed later on to generate the commandline
150 parameters. 151 parameters.
151 </p> 152 </p>
153
152 <a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a> 154 <a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a>
153 <h4>PyLintConfigDialog.__readStderr</h4> 155 <h4>PyLintConfigDialog.__readStderr</h4>
154 <b>__readStderr</b>(<i></i>) 156 <b>__readStderr</b>(<i></i>)
155
156 <p> 157 <p>
157 Private slot to handle the readyReadStandardError signal of the 158 Private slot to handle the readyReadStandardError signal of the
158 pylint process. 159 pylint process.
159 </p> 160 </p>
161
160 <a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a> 162 <a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a>
161 <h4>PyLintConfigDialog.__readStdout</h4> 163 <h4>PyLintConfigDialog.__readStdout</h4>
162 <b>__readStdout</b>(<i></i>) 164 <b>__readStdout</b>(<i></i>)
163
164 <p> 165 <p>
165 Private slot to handle the readyReadStandardOutput signal of the 166 Private slot to handle the readyReadStandardOutput signal of the
166 pylint process. 167 pylint process.
167 </p> 168 </p>
169
168 <a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a> 170 <a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a>
169 <h4>PyLintConfigDialog.accept</h4> 171 <h4>PyLintConfigDialog.accept</h4>
170 <b>accept</b>(<i></i>) 172 <b>accept</b>(<i></i>)
171
172 <p> 173 <p>
173 Public slot called by the Ok button. 174 Public slot called by the Ok button.
174 </p> 175 </p>
175 <p> 176 <p>
176 It saves the values in the parameters dictionary. 177 It saves the values in the parameters dictionary.
177 </p> 178 </p>
179
178 <a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a> 180 <a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a>
179 <h4>PyLintConfigDialog.generateParameters</h4> 181 <h4>PyLintConfigDialog.generateParameters</h4>
180 <b>generateParameters</b>(<i></i>) 182 <b>generateParameters</b>(<i></i>)
181
182 <p> 183 <p>
183 Public method that generates the commandline parameters. 184 Public method that generates the commandline parameters.
184 </p> 185 </p>
185 <p> 186 <p>
186 It generates a list of strings to be used 187 It generates a list of strings to be used
191 </p> 192 </p>
192 <p> 193 <p>
193 <b>Note</b>: The arguments list contains the name of the pylint 194 <b>Note</b>: The arguments list contains the name of the pylint
194 executable as the first parameter. 195 executable as the first parameter.
195 </p> 196 </p>
197
196 <dl> 198 <dl>
197 <dt>Return:</dt> 199 <dt>Return:</dt>
198 <dd> 200 <dd>
199 a tuple of the commandline parameters and non default 201 a tuple of the commandline parameters and non default
200 parameters 202 parameters
207 </dd> 209 </dd>
208 </dl> 210 </dl>
209 <a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a> 211 <a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a>
210 <h4>PyLintConfigDialog.on_configButton_clicked</h4> 212 <h4>PyLintConfigDialog.on_configButton_clicked</h4>
211 <b>on_configButton_clicked</b>(<i></i>) 213 <b>on_configButton_clicked</b>(<i></i>)
212
213 <p> 214 <p>
214 Private slot to handle the generation of a sample configuration. 215 Private slot to handle the generation of a sample configuration.
215 </p> 216 </p>
217
216 <div align="right"><a href="#top">Up</a></div> 218 <div align="right"><a href="#top">Up</a></div>
217 <hr /> 219 <hr />
218 </body></html> 220 </body></html>

eric ide

mercurial