src/eric7/Documentation/Source/eric7.QScintilla.ShellWindow.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10132
66c11ab8fefd
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.QScintilla.ShellWindow</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QScintilla.ShellWindow</h1>
10
11 <p>
12 Module implementing a stand alone shell window.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#ShellWindow">ShellWindow</a></td>
25 <td>Class implementing a stand alone shell window.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="ShellWindow" ID="ShellWindow"></a>
36 <h2>ShellWindow</h2>
37
38 <p>
39 Class implementing a stand alone shell window.
40 </p>
41 <h3>Derived from</h3>
42 EricMainWindow
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#ShellWindow.__init__">ShellWindow</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#ShellWindow.__about">__about</a></td>
63 <td>Private slot to show a little About message.</td>
64 </tr>
65 <tr>
66 <td><a href="#ShellWindow.__aboutQt">__aboutQt</a></td>
67 <td>Private slot to handle the About Qt dialog.</td>
68 </tr>
69 <tr>
70 <td><a href="#ShellWindow.__clientDebuggerId">__clientDebuggerId</a></td>
71 <td>Private slot to receive the ID of a newly connected debugger backend.</td>
72 </tr>
73 <tr>
74 <td><a href="#ShellWindow.__createActions">__createActions</a></td>
75 <td>Private method to create the actions.</td>
76 </tr>
77 <tr>
78 <td><a href="#ShellWindow.__createEditActions">__createEditActions</a></td>
79 <td>Private method defining the user interface actions for the edit commands.</td>
80 </tr>
81 <tr>
82 <td><a href="#ShellWindow.__createFileActions">__createFileActions</a></td>
83 <td>Private method defining the user interface actions for the file commands.</td>
84 </tr>
85 <tr>
86 <td><a href="#ShellWindow.__createHelpActions">__createHelpActions</a></td>
87 <td>Private method to create the Help actions.</td>
88 </tr>
89 <tr>
90 <td><a href="#ShellWindow.__createHistoryActions">__createHistoryActions</a></td>
91 <td>Private method defining the user interface actions for the history commands.</td>
92 </tr>
93 <tr>
94 <td><a href="#ShellWindow.__createMenus">__createMenus</a></td>
95 <td>Private method to create the menus of the menu bar.</td>
96 </tr>
97 <tr>
98 <td><a href="#ShellWindow.__createSearchActions">__createSearchActions</a></td>
99 <td>Private method defining the user interface actions for the search commands.</td>
100 </tr>
101 <tr>
102 <td><a href="#ShellWindow.__createStatusBar">__createStatusBar</a></td>
103 <td>Private slot to set up the status bar.</td>
104 </tr>
105 <tr>
106 <td><a href="#ShellWindow.__createToolBars">__createToolBars</a></td>
107 <td>Private method to create the various toolbars.</td>
108 </tr>
109 <tr>
110 <td><a href="#ShellWindow.__createViewActions">__createViewActions</a></td>
111 <td>Private method defining the user interface actions for the view commands.</td>
112 </tr>
113 <tr>
114 <td><a href="#ShellWindow.__historyStyleChanged">__historyStyleChanged</a></td>
115 <td>Private slot to handle a change of the shell history style.</td>
116 </tr>
117 <tr>
118 <td><a href="#ShellWindow.__newWindow">__newWindow</a></td>
119 <td>Private slot to start a new instance of eric.</td>
120 </tr>
121 <tr>
122 <td><a href="#ShellWindow.__readSettings">__readSettings</a></td>
123 <td>Private method to read the settings remembered last time.</td>
124 </tr>
125 <tr>
126 <td><a href="#ShellWindow.__readShortcut">__readShortcut</a></td>
127 <td>Private function to read a single keyboard shortcut from the settings.</td>
128 </tr>
129 <tr>
130 <td><a href="#ShellWindow.__showFind">__showFind</a></td>
131 <td>Private method to display the search widget.</td>
132 </tr>
133 <tr>
134 <td><a href="#ShellWindow.__showStartMenu">__showStartMenu</a></td>
135 <td>Private slot to prepare the language menu.</td>
136 </tr>
137 <tr>
138 <td><a href="#ShellWindow.__startShell">__startShell</a></td>
139 <td>Private slot to start a shell according to the action triggered.</td>
140 </tr>
141 <tr>
142 <td><a href="#ShellWindow.__virtualEnvironmentChanged">__virtualEnvironmentChanged</a></td>
143 <td>Private slot handling a change of the shell's virtual environment.</td>
144 </tr>
145 <tr>
146 <td><a href="#ShellWindow.__whatsThis">__whatsThis</a></td>
147 <td>Private slot called in to enter Whats This mode.</td>
148 </tr>
149 <tr>
150 <td><a href="#ShellWindow.__writeSettings">__writeSettings</a></td>
151 <td>Private method to write the settings for reuse.</td>
152 </tr>
153 <tr>
154 <td><a href="#ShellWindow.__zoom">__zoom</a></td>
155 <td>Private method to handle the zoom action.</td>
156 </tr>
157 <tr>
158 <td><a href="#ShellWindow.__zoomIn">__zoomIn</a></td>
159 <td>Private method to handle the zoom in action.</td>
160 </tr>
161 <tr>
162 <td><a href="#ShellWindow.__zoomOut">__zoomOut</a></td>
163 <td>Private method to handle the zoom out action.</td>
164 </tr>
165 <tr>
166 <td><a href="#ShellWindow.__zoomReset">__zoomReset</a></td>
167 <td>Private method to reset the zoom factor.</td>
168 </tr>
169 <tr>
170 <td><a href="#ShellWindow.__zoomTo">__zoomTo</a></td>
171 <td>Private slot to zoom to a given value.</td>
172 </tr>
173 <tr>
174 <td><a href="#ShellWindow.__zoomValueChanged">__zoomValueChanged</a></td>
175 <td>Private slot to handle changes of the zoom value.</td>
176 </tr>
177 <tr>
178 <td><a href="#ShellWindow.activeWindow">activeWindow</a></td>
179 <td>Public method to get a reference to the active shell.</td>
180 </tr>
181 <tr>
182 <td><a href="#ShellWindow.closeEvent">closeEvent</a></td>
183 <td>Protected method to handle the close event.</td>
184 </tr>
185 <tr>
186 <td><a href="#ShellWindow.getAPIsManager">getAPIsManager</a></td>
187 <td>Public method to get a reference to the APIs manager.</td>
188 </tr>
189 <tr>
190 <td><a href="#ShellWindow.getDebuggerId">getDebuggerId</a></td>
191 <td>Public method to get the most recently registered debugger ID.</td>
192 </tr>
193 <tr>
194 <td><a href="#ShellWindow.quit">quit</a></td>
195 <td>Public method to quit the application.</td>
196 </tr>
197 <tr>
198 <td><a href="#ShellWindow.showFind">showFind</a></td>
199 <td>Public method to display the search widget.</td>
200 </tr>
201 </table>
202 <h3>Static Methods</h3>
203
204 <table>
205 <tr><td>None</td></tr>
206 </table>
207
208 <a NAME="ShellWindow.__init__" ID="ShellWindow.__init__"></a>
209 <h4>ShellWindow (Constructor)</h4>
210 <b>ShellWindow</b>(<i>originalPathString, parent=None, name=None</i>)
211
212 <p>
213 Constructor
214 </p>
215 <dl>
216
217 <dt><i>originalPathString</i> (str)</dt>
218 <dd>
219 original PATH environment variable
220 </dd>
221 <dt><i>parent</i> (QWidget)</dt>
222 <dd>
223 reference to the parent widget
224 </dd>
225 <dt><i>name</i> (str)</dt>
226 <dd>
227 object name of the window
228 </dd>
229 </dl>
230 <a NAME="ShellWindow.__about" ID="ShellWindow.__about"></a>
231 <h4>ShellWindow.__about</h4>
232 <b>__about</b>(<i></i>)
233
234 <p>
235 Private slot to show a little About message.
236 </p>
237 <a NAME="ShellWindow.__aboutQt" ID="ShellWindow.__aboutQt"></a>
238 <h4>ShellWindow.__aboutQt</h4>
239 <b>__aboutQt</b>(<i></i>)
240
241 <p>
242 Private slot to handle the About Qt dialog.
243 </p>
244 <a NAME="ShellWindow.__clientDebuggerId" ID="ShellWindow.__clientDebuggerId"></a>
245 <h4>ShellWindow.__clientDebuggerId</h4>
246 <b>__clientDebuggerId</b>(<i>debuggerId</i>)
247
248 <p>
249 Private slot to receive the ID of a newly connected debugger backend.
250 </p>
251 <dl>
252
253 <dt><i>debuggerId</i> (str)</dt>
254 <dd>
255 ID of a newly connected debugger backend
256 </dd>
257 </dl>
258 <a NAME="ShellWindow.__createActions" ID="ShellWindow.__createActions"></a>
259 <h4>ShellWindow.__createActions</h4>
260 <b>__createActions</b>(<i></i>)
261
262 <p>
263 Private method to create the actions.
264 </p>
265 <a NAME="ShellWindow.__createEditActions" ID="ShellWindow.__createEditActions"></a>
266 <h4>ShellWindow.__createEditActions</h4>
267 <b>__createEditActions</b>(<i></i>)
268
269 <p>
270 Private method defining the user interface actions for the edit
271 commands.
272 </p>
273 <a NAME="ShellWindow.__createFileActions" ID="ShellWindow.__createFileActions"></a>
274 <h4>ShellWindow.__createFileActions</h4>
275 <b>__createFileActions</b>(<i></i>)
276
277 <p>
278 Private method defining the user interface actions for the file
279 commands.
280 </p>
281 <a NAME="ShellWindow.__createHelpActions" ID="ShellWindow.__createHelpActions"></a>
282 <h4>ShellWindow.__createHelpActions</h4>
283 <b>__createHelpActions</b>(<i></i>)
284
285 <p>
286 Private method to create the Help actions.
287 </p>
288 <a NAME="ShellWindow.__createHistoryActions" ID="ShellWindow.__createHistoryActions"></a>
289 <h4>ShellWindow.__createHistoryActions</h4>
290 <b>__createHistoryActions</b>(<i></i>)
291
292 <p>
293 Private method defining the user interface actions for the history
294 commands.
295 </p>
296 <a NAME="ShellWindow.__createMenus" ID="ShellWindow.__createMenus"></a>
297 <h4>ShellWindow.__createMenus</h4>
298 <b>__createMenus</b>(<i></i>)
299
300 <p>
301 Private method to create the menus of the menu bar.
302 </p>
303 <a NAME="ShellWindow.__createSearchActions" ID="ShellWindow.__createSearchActions"></a>
304 <h4>ShellWindow.__createSearchActions</h4>
305 <b>__createSearchActions</b>(<i></i>)
306
307 <p>
308 Private method defining the user interface actions for the search
309 commands.
310 </p>
311 <a NAME="ShellWindow.__createStatusBar" ID="ShellWindow.__createStatusBar"></a>
312 <h4>ShellWindow.__createStatusBar</h4>
313 <b>__createStatusBar</b>(<i></i>)
314
315 <p>
316 Private slot to set up the status bar.
317 </p>
318 <a NAME="ShellWindow.__createToolBars" ID="ShellWindow.__createToolBars"></a>
319 <h4>ShellWindow.__createToolBars</h4>
320 <b>__createToolBars</b>(<i></i>)
321
322 <p>
323 Private method to create the various toolbars.
324 </p>
325 <a NAME="ShellWindow.__createViewActions" ID="ShellWindow.__createViewActions"></a>
326 <h4>ShellWindow.__createViewActions</h4>
327 <b>__createViewActions</b>(<i></i>)
328
329 <p>
330 Private method defining the user interface actions for the view
331 commands.
332 </p>
333 <a NAME="ShellWindow.__historyStyleChanged" ID="ShellWindow.__historyStyleChanged"></a>
334 <h4>ShellWindow.__historyStyleChanged</h4>
335 <b>__historyStyleChanged</b>(<i>historyStyle</i>)
336
337 <p>
338 Private slot to handle a change of the shell history style.
339 </p>
340 <dl>
341
342 <dt><i>historyStyle</i> (ShellHistoryStyle)</dt>
343 <dd>
344 style to be used for the history
345 </dd>
346 </dl>
347 <a NAME="ShellWindow.__newWindow" ID="ShellWindow.__newWindow"></a>
348 <h4>ShellWindow.__newWindow</h4>
349 <b>__newWindow</b>(<i></i>)
350
351 <p>
352 Private slot to start a new instance of eric.
353 </p>
354 <a NAME="ShellWindow.__readSettings" ID="ShellWindow.__readSettings"></a>
355 <h4>ShellWindow.__readSettings</h4>
356 <b>__readSettings</b>(<i></i>)
357
358 <p>
359 Private method to read the settings remembered last time.
360 </p>
361 <a NAME="ShellWindow.__readShortcut" ID="ShellWindow.__readShortcut"></a>
362 <h4>ShellWindow.__readShortcut</h4>
363 <b>__readShortcut</b>(<i>act, category</i>)
364
365 <p>
366 Private function to read a single keyboard shortcut from the settings.
367 </p>
368 <dl>
369
370 <dt><i>act</i> (EricAction)</dt>
371 <dd>
372 reference to the action object
373 </dd>
374 <dt><i>category</i> (str)</dt>
375 <dd>
376 category the action belongs to
377 </dd>
378 </dl>
379 <a NAME="ShellWindow.__showFind" ID="ShellWindow.__showFind"></a>
380 <h4>ShellWindow.__showFind</h4>
381 <b>__showFind</b>(<i></i>)
382
383 <p>
384 Private method to display the search widget.
385 </p>
386 <a NAME="ShellWindow.__showStartMenu" ID="ShellWindow.__showStartMenu"></a>
387 <h4>ShellWindow.__showStartMenu</h4>
388 <b>__showStartMenu</b>(<i></i>)
389
390 <p>
391 Private slot to prepare the language menu.
392 </p>
393 <a NAME="ShellWindow.__startShell" ID="ShellWindow.__startShell"></a>
394 <h4>ShellWindow.__startShell</h4>
395 <b>__startShell</b>(<i>action</i>)
396
397 <p>
398 Private slot to start a shell according to the action triggered.
399 </p>
400 <dl>
401
402 <dt><i>action</i></dt>
403 <dd>
404 menu action that was triggered (QAction)
405 </dd>
406 </dl>
407 <a NAME="ShellWindow.__virtualEnvironmentChanged" ID="ShellWindow.__virtualEnvironmentChanged"></a>
408 <h4>ShellWindow.__virtualEnvironmentChanged</h4>
409 <b>__virtualEnvironmentChanged</b>(<i>venvName</i>)
410
411 <p>
412 Private slot handling a change of the shell's virtual environment.
413 </p>
414 <dl>
415
416 <dt><i>venvName</i> (str)</dt>
417 <dd>
418 name of the virtual environment of the shell
419 </dd>
420 </dl>
421 <a NAME="ShellWindow.__whatsThis" ID="ShellWindow.__whatsThis"></a>
422 <h4>ShellWindow.__whatsThis</h4>
423 <b>__whatsThis</b>(<i></i>)
424
425 <p>
426 Private slot called in to enter Whats This mode.
427 </p>
428 <a NAME="ShellWindow.__writeSettings" ID="ShellWindow.__writeSettings"></a>
429 <h4>ShellWindow.__writeSettings</h4>
430 <b>__writeSettings</b>(<i></i>)
431
432 <p>
433 Private method to write the settings for reuse.
434 </p>
435 <a NAME="ShellWindow.__zoom" ID="ShellWindow.__zoom"></a>
436 <h4>ShellWindow.__zoom</h4>
437 <b>__zoom</b>(<i></i>)
438
439 <p>
440 Private method to handle the zoom action.
441 </p>
442 <a NAME="ShellWindow.__zoomIn" ID="ShellWindow.__zoomIn"></a>
443 <h4>ShellWindow.__zoomIn</h4>
444 <b>__zoomIn</b>(<i></i>)
445
446 <p>
447 Private method to handle the zoom in action.
448 </p>
449 <a NAME="ShellWindow.__zoomOut" ID="ShellWindow.__zoomOut"></a>
450 <h4>ShellWindow.__zoomOut</h4>
451 <b>__zoomOut</b>(<i></i>)
452
453 <p>
454 Private method to handle the zoom out action.
455 </p>
456 <a NAME="ShellWindow.__zoomReset" ID="ShellWindow.__zoomReset"></a>
457 <h4>ShellWindow.__zoomReset</h4>
458 <b>__zoomReset</b>(<i></i>)
459
460 <p>
461 Private method to reset the zoom factor.
462 </p>
463 <a NAME="ShellWindow.__zoomTo" ID="ShellWindow.__zoomTo"></a>
464 <h4>ShellWindow.__zoomTo</h4>
465 <b>__zoomTo</b>(<i>value</i>)
466
467 <p>
468 Private slot to zoom to a given value.
469 </p>
470 <dl>
471
472 <dt><i>value</i> (int)</dt>
473 <dd>
474 zoom value to be set
475 </dd>
476 </dl>
477 <a NAME="ShellWindow.__zoomValueChanged" ID="ShellWindow.__zoomValueChanged"></a>
478 <h4>ShellWindow.__zoomValueChanged</h4>
479 <b>__zoomValueChanged</b>(<i>value</i>)
480
481 <p>
482 Private slot to handle changes of the zoom value.
483 </p>
484 <dl>
485
486 <dt><i>value</i> (int)</dt>
487 <dd>
488 new zoom value
489 </dd>
490 </dl>
491 <a NAME="ShellWindow.activeWindow" ID="ShellWindow.activeWindow"></a>
492 <h4>ShellWindow.activeWindow</h4>
493 <b>activeWindow</b>(<i></i>)
494
495 <p>
496 Public method to get a reference to the active shell.
497 </p>
498 <dl>
499 <dt>Return:</dt>
500 <dd>
501 reference to the shell widget
502 </dd>
503 </dl>
504 <dl>
505 <dt>Return Type:</dt>
506 <dd>
507 Shell
508 </dd>
509 </dl>
510 <a NAME="ShellWindow.closeEvent" ID="ShellWindow.closeEvent"></a>
511 <h4>ShellWindow.closeEvent</h4>
512 <b>closeEvent</b>(<i>event</i>)
513
514 <p>
515 Protected method to handle the close event.
516 </p>
517 <dl>
518
519 <dt><i>event</i> (QCloseEvent)</dt>
520 <dd>
521 close event
522 </dd>
523 </dl>
524 <a NAME="ShellWindow.getAPIsManager" ID="ShellWindow.getAPIsManager"></a>
525 <h4>ShellWindow.getAPIsManager</h4>
526 <b>getAPIsManager</b>(<i></i>)
527
528 <p>
529 Public method to get a reference to the APIs manager.
530 </p>
531 <dl>
532 <dt>Return:</dt>
533 <dd>
534 the APIs manager object (eric7.QScintilla.APIsManager)
535 </dd>
536 </dl>
537 <a NAME="ShellWindow.getDebuggerId" ID="ShellWindow.getDebuggerId"></a>
538 <h4>ShellWindow.getDebuggerId</h4>
539 <b>getDebuggerId</b>(<i></i>)
540
541 <p>
542 Public method to get the most recently registered debugger ID.
543 </p>
544 <dl>
545 <dt>Return:</dt>
546 <dd>
547 debugger ID
548 </dd>
549 </dl>
550 <dl>
551 <dt>Return Type:</dt>
552 <dd>
553 str
554 </dd>
555 </dl>
556 <a NAME="ShellWindow.quit" ID="ShellWindow.quit"></a>
557 <h4>ShellWindow.quit</h4>
558 <b>quit</b>(<i></i>)
559
560 <p>
561 Public method to quit the application.
562 </p>
563 <a NAME="ShellWindow.showFind" ID="ShellWindow.showFind"></a>
564 <h4>ShellWindow.showFind</h4>
565 <b>showFind</b>(<i>txt=""</i>)
566
567 <p>
568 Public method to display the search widget.
569 </p>
570 <dl>
571
572 <dt><i>txt</i> (str)</dt>
573 <dd>
574 text to be shown in the combo
575 </dd>
576 </dl>
577 <div align="right"><a href="#top">Up</a></div>
578 <hr />
579 </body></html>

eric ide

mercurial