Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.QScintilla.ShellWindow.html

changeset 5711
50b6867ffcd3
child 5800
c3379bf35654
equal deleted inserted replaced
5710:b5809b948010 5711:50b6867ffcd3
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.__doClearRestart">__doClearRestart</a></td>
100 <td>Private slot to handle the 'restart and clear' menu entry.</td>
101 </tr><tr>
102 <td><a href="#ShellWindow.__doRestart">__doRestart</a></td>
103 <td>Private slot to handle the 'restart' menu entry.</td>
104 </tr><tr>
105 <td><a href="#ShellWindow.__newWindow">__newWindow</a></td>
106 <td>Private slot to start a new instance of eric6.</td>
107 </tr><tr>
108 <td><a href="#ShellWindow.__readSettings">__readSettings</a></td>
109 <td>Private method to read the settings remembered last time.</td>
110 </tr><tr>
111 <td><a href="#ShellWindow.__readShortcut">__readShortcut</a></td>
112 <td>Private function to read a single keyboard shortcut from the settings.</td>
113 </tr><tr>
114 <td><a href="#ShellWindow.__showFind">__showFind</a></td>
115 <td>Private method to display the search widget.</td>
116 </tr><tr>
117 <td><a href="#ShellWindow.__showLanguageMenu">__showLanguageMenu</a></td>
118 <td>Private slot to prepare the language menu.</td>
119 </tr><tr>
120 <td><a href="#ShellWindow.__startShell">__startShell</a></td>
121 <td>Private slot to start a shell according to the action triggered.</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>
159 </table>
160 <h3>Static Methods</h3>
161 <table>
162 <tr><td>None</td></tr>
163 </table>
164 <a NAME="ShellWindow.__init__" ID="ShellWindow.__init__"></a>
165 <h4>ShellWindow (Constructor)</h4>
166 <b>ShellWindow</b>(<i>parent=None, name=None</i>)
167 <p>
168 Constructor
169 </p><dl>
170 <dt><i>parent</i> (QWidget)</dt>
171 <dd>
172 reference to the parent widget
173 </dd><dt><i>name</i> (str)</dt>
174 <dd>
175 object name of the window
176 </dd>
177 </dl><a NAME="ShellWindow.__about" ID="ShellWindow.__about"></a>
178 <h4>ShellWindow.__about</h4>
179 <b>__about</b>(<i></i>)
180 <p>
181 Private slot to show a little About message.
182 </p><a NAME="ShellWindow.__aboutQt" ID="ShellWindow.__aboutQt"></a>
183 <h4>ShellWindow.__aboutQt</h4>
184 <b>__aboutQt</b>(<i></i>)
185 <p>
186 Private slot to handle the About Qt dialog.
187 </p><a NAME="ShellWindow.__createActions" ID="ShellWindow.__createActions"></a>
188 <h4>ShellWindow.__createActions</h4>
189 <b>__createActions</b>(<i></i>)
190 <p>
191 Private method to create the actions.
192 </p><a NAME="ShellWindow.__createEditActions" ID="ShellWindow.__createEditActions"></a>
193 <h4>ShellWindow.__createEditActions</h4>
194 <b>__createEditActions</b>(<i></i>)
195 <p>
196 Private method defining the user interface actions for the edit
197 commands.
198 </p><a NAME="ShellWindow.__createFileActions" ID="ShellWindow.__createFileActions"></a>
199 <h4>ShellWindow.__createFileActions</h4>
200 <b>__createFileActions</b>(<i></i>)
201 <p>
202 Private method defining the user interface actions for the file
203 commands.
204 </p><a NAME="ShellWindow.__createHelpActions" ID="ShellWindow.__createHelpActions"></a>
205 <h4>ShellWindow.__createHelpActions</h4>
206 <b>__createHelpActions</b>(<i></i>)
207 <p>
208 Private method to create the Help actions.
209 </p><a NAME="ShellWindow.__createHistoryActions" ID="ShellWindow.__createHistoryActions"></a>
210 <h4>ShellWindow.__createHistoryActions</h4>
211 <b>__createHistoryActions</b>(<i></i>)
212 <p>
213 Private method defining the user interface actions for the history
214 commands.
215 </p><a NAME="ShellWindow.__createMenus" ID="ShellWindow.__createMenus"></a>
216 <h4>ShellWindow.__createMenus</h4>
217 <b>__createMenus</b>(<i></i>)
218 <p>
219 Private method to create the menus of the menu bar.
220 </p><a NAME="ShellWindow.__createSearchActions" ID="ShellWindow.__createSearchActions"></a>
221 <h4>ShellWindow.__createSearchActions</h4>
222 <b>__createSearchActions</b>(<i></i>)
223 <p>
224 Private method defining the user interface actions for the search
225 commands.
226 </p><a NAME="ShellWindow.__createStatusBar" ID="ShellWindow.__createStatusBar"></a>
227 <h4>ShellWindow.__createStatusBar</h4>
228 <b>__createStatusBar</b>(<i></i>)
229 <p>
230 Private slot to set up the status bar.
231 </p><a NAME="ShellWindow.__createToolBars" ID="ShellWindow.__createToolBars"></a>
232 <h4>ShellWindow.__createToolBars</h4>
233 <b>__createToolBars</b>(<i></i>)
234 <p>
235 Private method to create the various toolbars.
236 </p><a NAME="ShellWindow.__createViewActions" ID="ShellWindow.__createViewActions"></a>
237 <h4>ShellWindow.__createViewActions</h4>
238 <b>__createViewActions</b>(<i></i>)
239 <p>
240 Private method defining the user interface actions for the view
241 commands.
242 </p><a NAME="ShellWindow.__doClearRestart" ID="ShellWindow.__doClearRestart"></a>
243 <h4>ShellWindow.__doClearRestart</h4>
244 <b>__doClearRestart</b>(<i></i>)
245 <p>
246 Private slot to handle the 'restart and clear' menu entry.
247 </p><a NAME="ShellWindow.__doRestart" ID="ShellWindow.__doRestart"></a>
248 <h4>ShellWindow.__doRestart</h4>
249 <b>__doRestart</b>(<i></i>)
250 <p>
251 Private slot to handle the 'restart' menu entry.
252 </p><a NAME="ShellWindow.__newWindow" ID="ShellWindow.__newWindow"></a>
253 <h4>ShellWindow.__newWindow</h4>
254 <b>__newWindow</b>(<i></i>)
255 <p>
256 Private slot to start a new instance of eric6.
257 </p><a NAME="ShellWindow.__readSettings" ID="ShellWindow.__readSettings"></a>
258 <h4>ShellWindow.__readSettings</h4>
259 <b>__readSettings</b>(<i></i>)
260 <p>
261 Private method to read the settings remembered last time.
262 </p><a NAME="ShellWindow.__readShortcut" ID="ShellWindow.__readShortcut"></a>
263 <h4>ShellWindow.__readShortcut</h4>
264 <b>__readShortcut</b>(<i>act, category</i>)
265 <p>
266 Private function to read a single keyboard shortcut from the settings.
267 </p><dl>
268 <dt><i>act</i> (E5Action)</dt>
269 <dd>
270 reference to the action object
271 </dd><dt><i>category</i> (str)</dt>
272 <dd>
273 category the action belongs to
274 </dd>
275 </dl><a NAME="ShellWindow.__showFind" ID="ShellWindow.__showFind"></a>
276 <h4>ShellWindow.__showFind</h4>
277 <b>__showFind</b>(<i></i>)
278 <p>
279 Private method to display the search widget.
280 </p><a NAME="ShellWindow.__showLanguageMenu" ID="ShellWindow.__showLanguageMenu"></a>
281 <h4>ShellWindow.__showLanguageMenu</h4>
282 <b>__showLanguageMenu</b>(<i></i>)
283 <p>
284 Private slot to prepare the language menu.
285 </p><a NAME="ShellWindow.__startShell" ID="ShellWindow.__startShell"></a>
286 <h4>ShellWindow.__startShell</h4>
287 <b>__startShell</b>(<i>action</i>)
288 <p>
289 Private slot to start a shell according to the action triggered.
290 </p><dl>
291 <dt><i>action</i></dt>
292 <dd>
293 menu action that was triggered (QAction)
294 </dd>
295 </dl><a NAME="ShellWindow.__whatsThis" ID="ShellWindow.__whatsThis"></a>
296 <h4>ShellWindow.__whatsThis</h4>
297 <b>__whatsThis</b>(<i></i>)
298 <p>
299 Private slot called in to enter Whats This mode.
300 </p><a NAME="ShellWindow.__writeSettings" ID="ShellWindow.__writeSettings"></a>
301 <h4>ShellWindow.__writeSettings</h4>
302 <b>__writeSettings</b>(<i></i>)
303 <p>
304 Private method to write the settings for reuse.
305 </p><a NAME="ShellWindow.__zoom" ID="ShellWindow.__zoom"></a>
306 <h4>ShellWindow.__zoom</h4>
307 <b>__zoom</b>(<i></i>)
308 <p>
309 Private method to handle the zoom action.
310 </p><a NAME="ShellWindow.__zoomIn" ID="ShellWindow.__zoomIn"></a>
311 <h4>ShellWindow.__zoomIn</h4>
312 <b>__zoomIn</b>(<i></i>)
313 <p>
314 Private method to handle the zoom in action.
315 </p><a NAME="ShellWindow.__zoomOut" ID="ShellWindow.__zoomOut"></a>
316 <h4>ShellWindow.__zoomOut</h4>
317 <b>__zoomOut</b>(<i></i>)
318 <p>
319 Private method to handle the zoom out action.
320 </p><a NAME="ShellWindow.__zoomReset" ID="ShellWindow.__zoomReset"></a>
321 <h4>ShellWindow.__zoomReset</h4>
322 <b>__zoomReset</b>(<i></i>)
323 <p>
324 Private method to reset the zoom factor.
325 </p><a NAME="ShellWindow.__zoomTo" ID="ShellWindow.__zoomTo"></a>
326 <h4>ShellWindow.__zoomTo</h4>
327 <b>__zoomTo</b>(<i>value</i>)
328 <p>
329 Private slot to zoom to a given value.
330 </p><dl>
331 <dt><i>value</i> (int)</dt>
332 <dd>
333 zoom value to be set
334 </dd>
335 </dl><a NAME="ShellWindow.__zoomValueChanged" ID="ShellWindow.__zoomValueChanged"></a>
336 <h4>ShellWindow.__zoomValueChanged</h4>
337 <b>__zoomValueChanged</b>(<i>value</i>)
338 <p>
339 Private slot to handle changes of the zoom value.
340 </p><dl>
341 <dt><i>value</i> (int)</dt>
342 <dd>
343 new zoom value
344 </dd>
345 </dl><a NAME="ShellWindow.activeWindow" ID="ShellWindow.activeWindow"></a>
346 <h4>ShellWindow.activeWindow</h4>
347 <b>activeWindow</b>(<i></i>)
348 <p>
349 Public method to get a reference to the active shell.
350 </p><dl>
351 <dt>Returns:</dt>
352 <dd>
353 reference to the shell widget
354 </dd>
355 </dl><dl>
356 <dt>Return Type:</dt>
357 <dd>
358 Shell
359 </dd>
360 </dl><a NAME="ShellWindow.closeEvent" ID="ShellWindow.closeEvent"></a>
361 <h4>ShellWindow.closeEvent</h4>
362 <b>closeEvent</b>(<i>event</i>)
363 <p>
364 Protected method to handle the close event.
365 </p><dl>
366 <dt><i>event</i> (QCloseEvent)</dt>
367 <dd>
368 close event
369 </dd>
370 </dl><a NAME="ShellWindow.getAPIsManager" ID="ShellWindow.getAPIsManager"></a>
371 <h4>ShellWindow.getAPIsManager</h4>
372 <b>getAPIsManager</b>(<i></i>)
373 <p>
374 Public method to get a reference to the APIs manager.
375 </p><dl>
376 <dt>Returns:</dt>
377 <dd>
378 the APIs manager object (eric6.QScintilla.APIsManager)
379 </dd>
380 </dl><a NAME="ShellWindow.quit" ID="ShellWindow.quit"></a>
381 <h4>ShellWindow.quit</h4>
382 <b>quit</b>(<i></i>)
383 <p>
384 Public method to quit the application.
385 </p>
386 <div align="right"><a href="#top">Up</a></div>
387 <hr />
388 </body></html>

Mercurial Repository: eric

eric ide

mercurial