Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.ShellWindow.html

eric6/Documentation/Source/eric6.QScintilla.ShellWindow.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.QScintilla.ShellWindow</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.QScintilla.ShellWindow</h1>
23 <p>
24 Module implementing a stand alone shell window.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#ShellWindow">ShellWindow</a></td>
34 <td>Class implementing a stand alone shell window.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="ShellWindow" ID="ShellWindow"></a>
43 <h2>ShellWindow</h2>
44 <p>
45 Class implementing a stand alone shell window.
46 </p>
47 <h3>Derived from</h3>
48 E5MainWindow
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#ShellWindow.__init__">ShellWindow</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#ShellWindow.__about">__about</a></td>
64 <td>Private slot to show a little About message.</td>
65 </tr><tr>
66 <td><a href="#ShellWindow.__aboutQt">__aboutQt</a></td>
67 <td>Private slot to handle the About Qt dialog.</td>
68 </tr><tr>
69 <td><a href="#ShellWindow.__createActions">__createActions</a></td>
70 <td>Private method to create the actions.</td>
71 </tr><tr>
72 <td><a href="#ShellWindow.__createEditActions">__createEditActions</a></td>
73 <td>Private method defining the user interface actions for the edit commands.</td>
74 </tr><tr>
75 <td><a href="#ShellWindow.__createFileActions">__createFileActions</a></td>
76 <td>Private method defining the user interface actions for the file commands.</td>
77 </tr><tr>
78 <td><a href="#ShellWindow.__createHelpActions">__createHelpActions</a></td>
79 <td>Private method to create the Help actions.</td>
80 </tr><tr>
81 <td><a href="#ShellWindow.__createHistoryActions">__createHistoryActions</a></td>
82 <td>Private method defining the user interface actions for the history commands.</td>
83 </tr><tr>
84 <td><a href="#ShellWindow.__createMenus">__createMenus</a></td>
85 <td>Private method to create the menus of the menu bar.</td>
86 </tr><tr>
87 <td><a href="#ShellWindow.__createSearchActions">__createSearchActions</a></td>
88 <td>Private method defining the user interface actions for the search commands.</td>
89 </tr><tr>
90 <td><a href="#ShellWindow.__createStatusBar">__createStatusBar</a></td>
91 <td>Private slot to set up the status bar.</td>
92 </tr><tr>
93 <td><a href="#ShellWindow.__createToolBars">__createToolBars</a></td>
94 <td>Private method to create the various toolbars.</td>
95 </tr><tr>
96 <td><a href="#ShellWindow.__createViewActions">__createViewActions</a></td>
97 <td>Private method defining the user interface actions for the view commands.</td>
98 </tr><tr>
99 <td><a href="#ShellWindow.__historyStyleChanged">__historyStyleChanged</a></td>
100 <td>Private slot to handle a change of the shell history style.</td>
101 </tr><tr>
102 <td><a href="#ShellWindow.__newWindow">__newWindow</a></td>
103 <td>Private slot to start a new instance of eric6.</td>
104 </tr><tr>
105 <td><a href="#ShellWindow.__readSettings">__readSettings</a></td>
106 <td>Private method to read the settings remembered last time.</td>
107 </tr><tr>
108 <td><a href="#ShellWindow.__readShortcut">__readShortcut</a></td>
109 <td>Private function to read a single keyboard shortcut from the settings.</td>
110 </tr><tr>
111 <td><a href="#ShellWindow.__showFind">__showFind</a></td>
112 <td>Private method to display the search widget.</td>
113 </tr><tr>
114 <td><a href="#ShellWindow.__showStartMenu">__showStartMenu</a></td>
115 <td>Private slot to prepare the language menu.</td>
116 </tr><tr>
117 <td><a href="#ShellWindow.__startShell">__startShell</a></td>
118 <td>Private slot to start a shell according to the action triggered.</td>
119 </tr><tr>
120 <td><a href="#ShellWindow.__virtualEnvironmentChanged">__virtualEnvironmentChanged</a></td>
121 <td>Private slot handling a change of the shell's virtual environment.</td>
122 </tr><tr>
123 <td><a href="#ShellWindow.__whatsThis">__whatsThis</a></td>
124 <td>Private slot called in to enter Whats This mode.</td>
125 </tr><tr>
126 <td><a href="#ShellWindow.__writeSettings">__writeSettings</a></td>
127 <td>Private method to write the settings for reuse.</td>
128 </tr><tr>
129 <td><a href="#ShellWindow.__zoom">__zoom</a></td>
130 <td>Private method to handle the zoom action.</td>
131 </tr><tr>
132 <td><a href="#ShellWindow.__zoomIn">__zoomIn</a></td>
133 <td>Private method to handle the zoom in action.</td>
134 </tr><tr>
135 <td><a href="#ShellWindow.__zoomOut">__zoomOut</a></td>
136 <td>Private method to handle the zoom out action.</td>
137 </tr><tr>
138 <td><a href="#ShellWindow.__zoomReset">__zoomReset</a></td>
139 <td>Private method to reset the zoom factor.</td>
140 </tr><tr>
141 <td><a href="#ShellWindow.__zoomTo">__zoomTo</a></td>
142 <td>Private slot to zoom to a given value.</td>
143 </tr><tr>
144 <td><a href="#ShellWindow.__zoomValueChanged">__zoomValueChanged</a></td>
145 <td>Private slot to handle changes of the zoom value.</td>
146 </tr><tr>
147 <td><a href="#ShellWindow.activeWindow">activeWindow</a></td>
148 <td>Public method to get a reference to the active shell.</td>
149 </tr><tr>
150 <td><a href="#ShellWindow.closeEvent">closeEvent</a></td>
151 <td>Protected method to handle the close event.</td>
152 </tr><tr>
153 <td><a href="#ShellWindow.getAPIsManager">getAPIsManager</a></td>
154 <td>Public method to get a reference to the APIs manager.</td>
155 </tr><tr>
156 <td><a href="#ShellWindow.quit">quit</a></td>
157 <td>Public method to quit the application.</td>
158 </tr><tr>
159 <td><a href="#ShellWindow.showFind">showFind</a></td>
160 <td>Public method to display the search widget.</td>
161 </tr>
162 </table>
163 <h3>Static Methods</h3>
164 <table>
165 <tr><td>None</td></tr>
166 </table>
167 <a NAME="ShellWindow.__init__" ID="ShellWindow.__init__"></a>
168 <h4>ShellWindow (Constructor)</h4>
169 <b>ShellWindow</b>(<i>originalPathString, parent=None, name=None</i>)
170 <p>
171 Constructor
172 </p><dl>
173 <dt><i>originalPathString</i> (str)</dt>
174 <dd>
175 original PATH environment variable
176 </dd><dt><i>parent</i> (QWidget)</dt>
177 <dd>
178 reference to the parent widget
179 </dd><dt><i>name</i> (str)</dt>
180 <dd>
181 object name of the window
182 </dd>
183 </dl><a NAME="ShellWindow.__about" ID="ShellWindow.__about"></a>
184 <h4>ShellWindow.__about</h4>
185 <b>__about</b>(<i></i>)
186 <p>
187 Private slot to show a little About message.
188 </p><a NAME="ShellWindow.__aboutQt" ID="ShellWindow.__aboutQt"></a>
189 <h4>ShellWindow.__aboutQt</h4>
190 <b>__aboutQt</b>(<i></i>)
191 <p>
192 Private slot to handle the About Qt dialog.
193 </p><a NAME="ShellWindow.__createActions" ID="ShellWindow.__createActions"></a>
194 <h4>ShellWindow.__createActions</h4>
195 <b>__createActions</b>(<i></i>)
196 <p>
197 Private method to create the actions.
198 </p><a NAME="ShellWindow.__createEditActions" ID="ShellWindow.__createEditActions"></a>
199 <h4>ShellWindow.__createEditActions</h4>
200 <b>__createEditActions</b>(<i></i>)
201 <p>
202 Private method defining the user interface actions for the edit
203 commands.
204 </p><a NAME="ShellWindow.__createFileActions" ID="ShellWindow.__createFileActions"></a>
205 <h4>ShellWindow.__createFileActions</h4>
206 <b>__createFileActions</b>(<i></i>)
207 <p>
208 Private method defining the user interface actions for the file
209 commands.
210 </p><a NAME="ShellWindow.__createHelpActions" ID="ShellWindow.__createHelpActions"></a>
211 <h4>ShellWindow.__createHelpActions</h4>
212 <b>__createHelpActions</b>(<i></i>)
213 <p>
214 Private method to create the Help actions.
215 </p><a NAME="ShellWindow.__createHistoryActions" ID="ShellWindow.__createHistoryActions"></a>
216 <h4>ShellWindow.__createHistoryActions</h4>
217 <b>__createHistoryActions</b>(<i></i>)
218 <p>
219 Private method defining the user interface actions for the history
220 commands.
221 </p><a NAME="ShellWindow.__createMenus" ID="ShellWindow.__createMenus"></a>
222 <h4>ShellWindow.__createMenus</h4>
223 <b>__createMenus</b>(<i></i>)
224 <p>
225 Private method to create the menus of the menu bar.
226 </p><a NAME="ShellWindow.__createSearchActions" ID="ShellWindow.__createSearchActions"></a>
227 <h4>ShellWindow.__createSearchActions</h4>
228 <b>__createSearchActions</b>(<i></i>)
229 <p>
230 Private method defining the user interface actions for the search
231 commands.
232 </p><a NAME="ShellWindow.__createStatusBar" ID="ShellWindow.__createStatusBar"></a>
233 <h4>ShellWindow.__createStatusBar</h4>
234 <b>__createStatusBar</b>(<i></i>)
235 <p>
236 Private slot to set up the status bar.
237 </p><a NAME="ShellWindow.__createToolBars" ID="ShellWindow.__createToolBars"></a>
238 <h4>ShellWindow.__createToolBars</h4>
239 <b>__createToolBars</b>(<i></i>)
240 <p>
241 Private method to create the various toolbars.
242 </p><a NAME="ShellWindow.__createViewActions" ID="ShellWindow.__createViewActions"></a>
243 <h4>ShellWindow.__createViewActions</h4>
244 <b>__createViewActions</b>(<i></i>)
245 <p>
246 Private method defining the user interface actions for the view
247 commands.
248 </p><a NAME="ShellWindow.__historyStyleChanged" ID="ShellWindow.__historyStyleChanged"></a>
249 <h4>ShellWindow.__historyStyleChanged</h4>
250 <b>__historyStyleChanged</b>(<i>historyStyle</i>)
251 <p>
252 Private slot to handle a change of the shell history style.
253 </p><dl>
254 <dt><i>historyStyle</i> (ShellHistoryStyle)</dt>
255 <dd>
256 style to be used for the history
257 </dd>
258 </dl><a NAME="ShellWindow.__newWindow" ID="ShellWindow.__newWindow"></a>
259 <h4>ShellWindow.__newWindow</h4>
260 <b>__newWindow</b>(<i></i>)
261 <p>
262 Private slot to start a new instance of eric6.
263 </p><a NAME="ShellWindow.__readSettings" ID="ShellWindow.__readSettings"></a>
264 <h4>ShellWindow.__readSettings</h4>
265 <b>__readSettings</b>(<i></i>)
266 <p>
267 Private method to read the settings remembered last time.
268 </p><a NAME="ShellWindow.__readShortcut" ID="ShellWindow.__readShortcut"></a>
269 <h4>ShellWindow.__readShortcut</h4>
270 <b>__readShortcut</b>(<i>act, category</i>)
271 <p>
272 Private function to read a single keyboard shortcut from the settings.
273 </p><dl>
274 <dt><i>act</i> (E5Action)</dt>
275 <dd>
276 reference to the action object
277 </dd><dt><i>category</i> (str)</dt>
278 <dd>
279 category the action belongs to
280 </dd>
281 </dl><a NAME="ShellWindow.__showFind" ID="ShellWindow.__showFind"></a>
282 <h4>ShellWindow.__showFind</h4>
283 <b>__showFind</b>(<i></i>)
284 <p>
285 Private method to display the search widget.
286 </p><a NAME="ShellWindow.__showStartMenu" ID="ShellWindow.__showStartMenu"></a>
287 <h4>ShellWindow.__showStartMenu</h4>
288 <b>__showStartMenu</b>(<i></i>)
289 <p>
290 Private slot to prepare the language menu.
291 </p><a NAME="ShellWindow.__startShell" ID="ShellWindow.__startShell"></a>
292 <h4>ShellWindow.__startShell</h4>
293 <b>__startShell</b>(<i>action</i>)
294 <p>
295 Private slot to start a shell according to the action triggered.
296 </p><dl>
297 <dt><i>action</i></dt>
298 <dd>
299 menu action that was triggered (QAction)
300 </dd>
301 </dl><a NAME="ShellWindow.__virtualEnvironmentChanged" ID="ShellWindow.__virtualEnvironmentChanged"></a>
302 <h4>ShellWindow.__virtualEnvironmentChanged</h4>
303 <b>__virtualEnvironmentChanged</b>(<i>venvName</i>)
304 <p>
305 Private slot handling a change of the shell's virtual environment.
306 </p><dl>
307 <dt><i>venvName</i> (str)</dt>
308 <dd>
309 name of the virtual environment of the shell
310 </dd>
311 </dl><a NAME="ShellWindow.__whatsThis" ID="ShellWindow.__whatsThis"></a>
312 <h4>ShellWindow.__whatsThis</h4>
313 <b>__whatsThis</b>(<i></i>)
314 <p>
315 Private slot called in to enter Whats This mode.
316 </p><a NAME="ShellWindow.__writeSettings" ID="ShellWindow.__writeSettings"></a>
317 <h4>ShellWindow.__writeSettings</h4>
318 <b>__writeSettings</b>(<i></i>)
319 <p>
320 Private method to write the settings for reuse.
321 </p><a NAME="ShellWindow.__zoom" ID="ShellWindow.__zoom"></a>
322 <h4>ShellWindow.__zoom</h4>
323 <b>__zoom</b>(<i></i>)
324 <p>
325 Private method to handle the zoom action.
326 </p><a NAME="ShellWindow.__zoomIn" ID="ShellWindow.__zoomIn"></a>
327 <h4>ShellWindow.__zoomIn</h4>
328 <b>__zoomIn</b>(<i></i>)
329 <p>
330 Private method to handle the zoom in action.
331 </p><a NAME="ShellWindow.__zoomOut" ID="ShellWindow.__zoomOut"></a>
332 <h4>ShellWindow.__zoomOut</h4>
333 <b>__zoomOut</b>(<i></i>)
334 <p>
335 Private method to handle the zoom out action.
336 </p><a NAME="ShellWindow.__zoomReset" ID="ShellWindow.__zoomReset"></a>
337 <h4>ShellWindow.__zoomReset</h4>
338 <b>__zoomReset</b>(<i></i>)
339 <p>
340 Private method to reset the zoom factor.
341 </p><a NAME="ShellWindow.__zoomTo" ID="ShellWindow.__zoomTo"></a>
342 <h4>ShellWindow.__zoomTo</h4>
343 <b>__zoomTo</b>(<i>value</i>)
344 <p>
345 Private slot to zoom to a given value.
346 </p><dl>
347 <dt><i>value</i> (int)</dt>
348 <dd>
349 zoom value to be set
350 </dd>
351 </dl><a NAME="ShellWindow.__zoomValueChanged" ID="ShellWindow.__zoomValueChanged"></a>
352 <h4>ShellWindow.__zoomValueChanged</h4>
353 <b>__zoomValueChanged</b>(<i>value</i>)
354 <p>
355 Private slot to handle changes of the zoom value.
356 </p><dl>
357 <dt><i>value</i> (int)</dt>
358 <dd>
359 new zoom value
360 </dd>
361 </dl><a NAME="ShellWindow.activeWindow" ID="ShellWindow.activeWindow"></a>
362 <h4>ShellWindow.activeWindow</h4>
363 <b>activeWindow</b>(<i></i>)
364 <p>
365 Public method to get a reference to the active shell.
366 </p><dl>
367 <dt>Returns:</dt>
368 <dd>
369 reference to the shell widget
370 </dd>
371 </dl><dl>
372 <dt>Return Type:</dt>
373 <dd>
374 Shell
375 </dd>
376 </dl><a NAME="ShellWindow.closeEvent" ID="ShellWindow.closeEvent"></a>
377 <h4>ShellWindow.closeEvent</h4>
378 <b>closeEvent</b>(<i>event</i>)
379 <p>
380 Protected method to handle the close event.
381 </p><dl>
382 <dt><i>event</i> (QCloseEvent)</dt>
383 <dd>
384 close event
385 </dd>
386 </dl><a NAME="ShellWindow.getAPIsManager" ID="ShellWindow.getAPIsManager"></a>
387 <h4>ShellWindow.getAPIsManager</h4>
388 <b>getAPIsManager</b>(<i></i>)
389 <p>
390 Public method to get a reference to the APIs manager.
391 </p><dl>
392 <dt>Returns:</dt>
393 <dd>
394 the APIs manager object (eric6.QScintilla.APIsManager)
395 </dd>
396 </dl><a NAME="ShellWindow.quit" ID="ShellWindow.quit"></a>
397 <h4>ShellWindow.quit</h4>
398 <b>quit</b>(<i></i>)
399 <p>
400 Public method to quit the application.
401 </p><a NAME="ShellWindow.showFind" ID="ShellWindow.showFind"></a>
402 <h4>ShellWindow.showFind</h4>
403 <b>showFind</b>(<i>txt=""</i>)
404 <p>
405 Public method to display the search widget.
406 </p><dl>
407 <dt><i>txt</i> (str)</dt>
408 <dd>
409 text to be shown in the combo
410 </dd>
411 </dl>
412 <div align="right"><a href="#top">Up</a></div>
413 <hr />
414 </body></html>

Mercurial Repository: eric

eric ide

mercurial