ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html

branch
eric7
changeset 147
eb28b4b6f7f5
parent 144
5c3684ee818e
child 148
dcbd3a96f03c
equal deleted inserted replaced
146:7d955b1995d5 147:eb28b4b6f7f5
143 <p> 143 <p>
144 Constructor 144 Constructor
145 </p> 145 </p>
146 <dl> 146 <dl>
147 147
148 <dt><i>text</i></dt> 148 <dt><i>text</i> (str)</dt>
149 <dd> 149 <dd>
150 text to be shown by the label (string) 150 text to be shown by the label
151 </dd> 151 </dd>
152 <dt><i>fixed=</i></dt> 152 <dt><i>fixed</i> (bool)</dt>
153 <dd> 153 <dd>
154 flag indicating a fixed font should be used (boolean) 154 flag indicating a fixed font should be used
155 </dd> 155 </dd>
156 <dt><i>linewrap=</i></dt> 156 <dt><i>linewrap</i> (bool)</dt>
157 <dd> 157 <dd>
158 flag indicating to wrap long lines (boolean) 158 flag indicating to wrap long lines
159 </dd> 159 </dd>
160 <dt><i>msgSuccess=</i></dt> 160 <dt><i>msgSuccess</i> (str)</dt>
161 <dd> 161 <dd>
162 optional string to show upon successful execution 162 optional string to show upon successful execution
163 (string) 163 </dd>
164 </dd> 164 <dt><i>msgError</i> (str)</dt>
165 <dt><i>msgError=</i></dt>
166 <dd> 165 <dd>
167 optional string to show upon unsuccessful execution 166 optional string to show upon unsuccessful execution
168 (string) 167 </dd>
169 </dd> 168 <dt><i>parent</i> (QWidget)</dt>
170 <dt><i>parent=</i></dt> 169 <dd>
171 <dd> 170 parent widget
172 parent widget (QWidget)
173 </dd> 171 </dd>
174 </dl> 172 </dl>
175 <a NAME="PyramidDialog.__procFinished" ID="PyramidDialog.__procFinished"></a> 173 <a NAME="PyramidDialog.__procFinished" ID="PyramidDialog.__procFinished"></a>
176 <h4>PyramidDialog.__procFinished</h4> 174 <h4>PyramidDialog.__procFinished</h4>
177 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 175 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
179 <p> 177 <p>
180 Private slot connected to the finished signal. 178 Private slot connected to the finished signal.
181 </p> 179 </p>
182 <dl> 180 <dl>
183 181
184 <dt><i>exitCode</i></dt> 182 <dt><i>exitCode</i> (int)</dt>
185 <dd> 183 <dd>
186 exit code of the process (integer) 184 exit code of the process
187 </dd> 185 </dd>
188 <dt><i>exitStatus</i></dt> 186 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
189 <dd> 187 <dd>
190 exit status of the process (QProcess.ExitStatus) 188 exit status of the process
191 </dd> 189 </dd>
192 </dl> 190 </dl>
193 <a NAME="PyramidDialog.__readStderr" ID="PyramidDialog.__readStderr"></a> 191 <a NAME="PyramidDialog.__readStderr" ID="PyramidDialog.__readStderr"></a>
194 <h4>PyramidDialog.__readStderr</h4> 192 <h4>PyramidDialog.__readStderr</h4>
195 <b>__readStderr</b>(<i></i>) 193 <b>__readStderr</b>(<i></i>)
227 <p> 225 <p>
228 Protected slot to handle a key press event. 226 Protected slot to handle a key press event.
229 </p> 227 </p>
230 <dl> 228 <dl>
231 229
232 <dt><i>evt</i></dt> 230 <dt><i>evt</i> (QKeyEvent)</dt>
233 <dd> 231 <dd>
234 the key press event (QKeyEvent) 232 the key press event
235 </dd> 233 </dd>
236 </dl> 234 </dl>
237 <a NAME="PyramidDialog.normalExit" ID="PyramidDialog.normalExit"></a> 235 <a NAME="PyramidDialog.normalExit" ID="PyramidDialog.normalExit"></a>
238 <h4>PyramidDialog.normalExit</h4> 236 <h4>PyramidDialog.normalExit</h4>
239 <b>normalExit</b>(<i></i>) 237 <b>normalExit</b>(<i></i>)
242 Public method to check for a normal process termination. 240 Public method to check for a normal process termination.
243 </p> 241 </p>
244 <dl> 242 <dl>
245 <dt>Return:</dt> 243 <dt>Return:</dt>
246 <dd> 244 <dd>
247 flag indicating normal process termination (boolean) 245 flag indicating normal process termination
246 </dd>
247 </dl>
248 <dl>
249 <dt>Return Type:</dt>
250 <dd>
251 bool
248 </dd> 252 </dd>
249 </dl> 253 </dl>
250 <a NAME="PyramidDialog.normalExitWithoutErrors" ID="PyramidDialog.normalExitWithoutErrors"></a> 254 <a NAME="PyramidDialog.normalExitWithoutErrors" ID="PyramidDialog.normalExitWithoutErrors"></a>
251 <h4>PyramidDialog.normalExitWithoutErrors</h4> 255 <h4>PyramidDialog.normalExitWithoutErrors</h4>
252 <b>normalExitWithoutErrors</b>(<i></i>) 256 <b>normalExitWithoutErrors</b>(<i></i>)
256 error messages. 260 error messages.
257 </p> 261 </p>
258 <dl> 262 <dl>
259 <dt>Return:</dt> 263 <dt>Return:</dt>
260 <dd> 264 <dd>
261 flag indicating normal process termination (boolean) 265 flag indicating normal process termination
266 </dd>
267 </dl>
268 <dl>
269 <dt>Return Type:</dt>
270 <dd>
271 bool
262 </dd> 272 </dd>
263 </dl> 273 </dl>
264 <a NAME="PyramidDialog.on_buttonBox_clicked" ID="PyramidDialog.on_buttonBox_clicked"></a> 274 <a NAME="PyramidDialog.on_buttonBox_clicked" ID="PyramidDialog.on_buttonBox_clicked"></a>
265 <h4>PyramidDialog.on_buttonBox_clicked</h4> 275 <h4>PyramidDialog.on_buttonBox_clicked</h4>
266 <b>on_buttonBox_clicked</b>(<i>button</i>) 276 <b>on_buttonBox_clicked</b>(<i>button</i>)
268 <p> 278 <p>
269 Private slot called by a button of the button box clicked. 279 Private slot called by a button of the button box clicked.
270 </p> 280 </p>
271 <dl> 281 <dl>
272 282
273 <dt><i>button</i></dt> 283 <dt><i>button</i> (QAbstractButton)</dt>
274 <dd> 284 <dd>
275 button that was clicked (QAbstractButton) 285 button that was clicked
276 </dd> 286 </dd>
277 </dl> 287 </dl>
278 <a NAME="PyramidDialog.on_input_returnPressed" ID="PyramidDialog.on_input_returnPressed"></a> 288 <a NAME="PyramidDialog.on_input_returnPressed" ID="PyramidDialog.on_input_returnPressed"></a>
279 <h4>PyramidDialog.on_input_returnPressed</h4> 289 <h4>PyramidDialog.on_input_returnPressed</h4>
280 <b>on_input_returnPressed</b>(<i></i>) 290 <b>on_input_returnPressed</b>(<i></i>)
289 <p> 299 <p>
290 Private slot to handle the password checkbox toggled. 300 Private slot to handle the password checkbox toggled.
291 </p> 301 </p>
292 <dl> 302 <dl>
293 303
294 <dt><i>isOn</i></dt> 304 <dt><i>isOn</i> (bool)</dt>
295 <dd> 305 <dd>
296 flag indicating the status of the check box (boolean) 306 flag indicating the status of the check box
297 </dd> 307 </dd>
298 </dl> 308 </dl>
299 <a NAME="PyramidDialog.on_sendButton_clicked" ID="PyramidDialog.on_sendButton_clicked"></a> 309 <a NAME="PyramidDialog.on_sendButton_clicked" ID="PyramidDialog.on_sendButton_clicked"></a>
300 <h4>PyramidDialog.on_sendButton_clicked</h4> 310 <h4>PyramidDialog.on_sendButton_clicked</h4>
301 <b>on_sendButton_clicked</b>(<i></i>) 311 <b>on_sendButton_clicked</b>(<i></i>)
310 <p> 320 <p>
311 Public slot used to start a batch of processes. 321 Public slot used to start a batch of processes.
312 </p> 322 </p>
313 <dl> 323 <dl>
314 324
315 <dt><i>argsLists</i></dt> 325 <dt><i>argsLists</i> (list of list of str)</dt>
316 <dd> 326 <dd>
317 list of lists of arguments for the processes 327 list of lists of arguments for the processes
318 (list of list of string) 328 </dd>
319 </dd> 329 <dt><i>workingDir</i> (str)</dt>
320 <dt><i>workingDir</i></dt> 330 <dd>
321 <dd> 331 working directory for the process
322 working directory for the process (string)
323 </dd> 332 </dd>
324 </dl> 333 </dl>
325 <dl> 334 <dl>
326 <dt>Return:</dt> 335 <dt>Return:</dt>
327 <dd> 336 <dd>
328 flag indicating a successful start of the first process 337 flag indicating a successful start of the first process
329 (boolean) 338 </dd>
339 </dl>
340 <dl>
341 <dt>Return Type:</dt>
342 <dd>
343 bool
330 </dd> 344 </dd>
331 </dl> 345 </dl>
332 <a NAME="PyramidDialog.startProcess" ID="PyramidDialog.startProcess"></a> 346 <a NAME="PyramidDialog.startProcess" ID="PyramidDialog.startProcess"></a>
333 <h4>PyramidDialog.startProcess</h4> 347 <h4>PyramidDialog.startProcess</h4>
334 <b>startProcess</b>(<i>command, args, workingDir=None, showArgs=True</i>) 348 <b>startProcess</b>(<i>command, args, workingDir=None, showArgs=True</i>)
336 <p> 350 <p>
337 Public slot used to start the process. 351 Public slot used to start the process.
338 </p> 352 </p>
339 <dl> 353 <dl>
340 354
341 <dt><i>command</i></dt> 355 <dt><i>command</i> (str)</dt>
342 <dd> 356 <dd>
343 command to start (string) 357 command to start
344 </dd> 358 </dd>
345 <dt><i>args</i></dt> 359 <dt><i>args</i> (list of str)</dt>
346 <dd> 360 <dd>
347 list of arguments for the process (list of strings) 361 list of arguments for the process
348 </dd> 362 </dd>
349 <dt><i>workingDir=</i></dt> 363 <dt><i>workingDir</i> (str)</dt>
350 <dd> 364 <dd>
351 working directory for the process (string) 365 working directory for the process
352 </dd> 366 </dd>
353 <dt><i>showArgs=</i></dt> 367 <dt><i>showArgs</i> (bool)</dt>
354 <dd> 368 <dd>
355 flag indicating to show the arguments (boolean) 369 flag indicating to show the arguments
356 </dd> 370 </dd>
357 </dl> 371 </dl>
358 <dl> 372 <dl>
359 <dt>Return:</dt> 373 <dt>Return:</dt>
360 <dd> 374 <dd>
361 flag indicating a successful start of the process 375 flag indicating a successful start of the process
376 </dd>
377 </dl>
378 <dl>
379 <dt>Return Type:</dt>
380 <dd>
381 bool
362 </dd> 382 </dd>
363 </dl> 383 </dl>
364 <div align="right"><a href="#top">Up</a></div> 384 <div align="right"><a href="#top">Up</a></div>
365 <hr /> 385 <hr />
366 </body></html> 386 </body></html>

eric ide

mercurial