|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.UI.UserInterface</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.UI.UserInterface</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing the main user interface. |
|
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="#Redirector">Redirector</a></td> |
|
25 <td>Helper class used to redirect stdout and stderr to the log window.</td> |
|
26 </tr> |
|
27 <tr> |
|
28 <td><a href="#UserInterface">UserInterface</a></td> |
|
29 <td>Class implementing the main user interface.</td> |
|
30 </tr> |
|
31 </table> |
|
32 <h3>Functions</h3> |
|
33 |
|
34 <table> |
|
35 <tr><td>None</td></tr> |
|
36 </table> |
|
37 <hr /> |
|
38 <hr /> |
|
39 <a NAME="Redirector" ID="Redirector"></a> |
|
40 <h2>Redirector</h2> |
|
41 |
|
42 <p> |
|
43 Helper class used to redirect stdout and stderr to the log window. |
|
44 </p> |
|
45 <h3>Signals</h3> |
|
46 <dl> |
|
47 |
|
48 <dt>appendStderr(str)</dt> |
|
49 <dd> |
|
50 emitted to write data to stderr logger |
|
51 </dd> |
|
52 <dt>appendStdout(str)</dt> |
|
53 <dd> |
|
54 emitted to write data to stdout logger |
|
55 </dd> |
|
56 </dl> |
|
57 <h3>Derived from</h3> |
|
58 QObject |
|
59 <h3>Class Attributes</h3> |
|
60 |
|
61 <table> |
|
62 <tr><td>None</td></tr> |
|
63 </table> |
|
64 <h3>Class Methods</h3> |
|
65 |
|
66 <table> |
|
67 <tr><td>None</td></tr> |
|
68 </table> |
|
69 <h3>Methods</h3> |
|
70 |
|
71 <table> |
|
72 |
|
73 <tr> |
|
74 <td><a href="#Redirector.__init__">Redirector</a></td> |
|
75 <td>Constructor</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#Redirector.__bufferedWrite">__bufferedWrite</a></td> |
|
79 <td>Private method returning number of characters to write.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#Redirector.__nWrite">__nWrite</a></td> |
|
83 <td>Private method used to write data.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#Redirector.flush">flush</a></td> |
|
87 <td>Public method used to flush the buffered data.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#Redirector.write">write</a></td> |
|
91 <td>Public method used to write data.</td> |
|
92 </tr> |
|
93 </table> |
|
94 <h3>Static Methods</h3> |
|
95 |
|
96 <table> |
|
97 <tr><td>None</td></tr> |
|
98 </table> |
|
99 |
|
100 <a NAME="Redirector.__init__" ID="Redirector.__init__"></a> |
|
101 <h4>Redirector (Constructor)</h4> |
|
102 <b>Redirector</b>(<i>stderr, parent=None</i>) |
|
103 |
|
104 <p> |
|
105 Constructor |
|
106 </p> |
|
107 <dl> |
|
108 |
|
109 <dt><i>stderr</i> (bool)</dt> |
|
110 <dd> |
|
111 flag indicating stderr is being redirected |
|
112 </dd> |
|
113 <dt><i>parent</i> (QObject)</dt> |
|
114 <dd> |
|
115 reference to the parent object |
|
116 </dd> |
|
117 </dl> |
|
118 <a NAME="Redirector.__bufferedWrite" ID="Redirector.__bufferedWrite"></a> |
|
119 <h4>Redirector.__bufferedWrite</h4> |
|
120 <b>__bufferedWrite</b>(<i></i>) |
|
121 |
|
122 <p> |
|
123 Private method returning number of characters to write. |
|
124 </p> |
|
125 <dl> |
|
126 <dt>Return:</dt> |
|
127 <dd> |
|
128 number of characters buffered or length of buffered line |
|
129 (integer) |
|
130 </dd> |
|
131 </dl> |
|
132 <a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a> |
|
133 <h4>Redirector.__nWrite</h4> |
|
134 <b>__nWrite</b>(<i>n</i>) |
|
135 |
|
136 <p> |
|
137 Private method used to write data. |
|
138 </p> |
|
139 <dl> |
|
140 |
|
141 <dt><i>n</i></dt> |
|
142 <dd> |
|
143 max number of bytes to write |
|
144 </dd> |
|
145 </dl> |
|
146 <a NAME="Redirector.flush" ID="Redirector.flush"></a> |
|
147 <h4>Redirector.flush</h4> |
|
148 <b>flush</b>(<i></i>) |
|
149 |
|
150 <p> |
|
151 Public method used to flush the buffered data. |
|
152 </p> |
|
153 <a NAME="Redirector.write" ID="Redirector.write"></a> |
|
154 <h4>Redirector.write</h4> |
|
155 <b>write</b>(<i>s</i>) |
|
156 |
|
157 <p> |
|
158 Public method used to write data. |
|
159 </p> |
|
160 <dl> |
|
161 |
|
162 <dt><i>s</i></dt> |
|
163 <dd> |
|
164 data to be written (it must support the str-method) |
|
165 </dd> |
|
166 </dl> |
|
167 <div align="right"><a href="#top">Up</a></div> |
|
168 <hr /> |
|
169 <hr /> |
|
170 <a NAME="UserInterface" ID="UserInterface"></a> |
|
171 <h2>UserInterface</h2> |
|
172 |
|
173 <p> |
|
174 Class implementing the main user interface. |
|
175 </p> |
|
176 <h3>Signals</h3> |
|
177 <dl> |
|
178 |
|
179 <dt>appendStderr(str)</dt> |
|
180 <dd> |
|
181 emitted to write data to stderr logger |
|
182 </dd> |
|
183 <dt>appendStdout(str)</dt> |
|
184 <dd> |
|
185 emitted to write data to stdout logger |
|
186 </dd> |
|
187 <dt>masterPasswordChanged(str, str)</dt> |
|
188 <dd> |
|
189 emitted after the master |
|
190 password has been changed with the old and the new password |
|
191 </dd> |
|
192 <dt>onlineStateChanged(online)</dt> |
|
193 <dd> |
|
194 emitted to indicate a change of the |
|
195 network state |
|
196 </dd> |
|
197 <dt>preferencesChanged()</dt> |
|
198 <dd> |
|
199 emitted after the preferences were changed |
|
200 </dd> |
|
201 <dt>reloadAPIs()</dt> |
|
202 <dd> |
|
203 emitted to reload the api information |
|
204 </dd> |
|
205 <dt>showMenu(str, QMenu)</dt> |
|
206 <dd> |
|
207 emitted when a menu is about to be shown. The |
|
208 name of the menu and a reference to the menu are given. |
|
209 </dd> |
|
210 </dl> |
|
211 <h3>Derived from</h3> |
|
212 EricMainWindow |
|
213 <h3>Class Attributes</h3> |
|
214 |
|
215 <table> |
|
216 <tr><td>BottomSide</td></tr><tr><td>ErrorLogFileName</td></tr><tr><td>LeftSide</td></tr><tr><td>RightSide</td></tr><tr><td>maxFilePathLen</td></tr><tr><td>maxMenuFilePathLen</td></tr> |
|
217 </table> |
|
218 <h3>Class Methods</h3> |
|
219 |
|
220 <table> |
|
221 <tr><td>None</td></tr> |
|
222 </table> |
|
223 <h3>Methods</h3> |
|
224 |
|
225 <table> |
|
226 |
|
227 <tr> |
|
228 <td><a href="#UserInterface.__init__">UserInterface</a></td> |
|
229 <td>Constructor</td> |
|
230 </tr> |
|
231 <tr> |
|
232 <td><a href="#UserInterface.__TBMenuTriggered">__TBMenuTriggered</a></td> |
|
233 <td>Private method to handle the toggle of a toolbar via the Window-> Toolbars submenu.</td> |
|
234 </tr> |
|
235 <tr> |
|
236 <td><a href="#UserInterface.__TBPopupMenuTriggered">__TBPopupMenuTriggered</a></td> |
|
237 <td>Private method to handle the toggle of a toolbar via the QMainWindow Toolbars popup menu.</td> |
|
238 </tr> |
|
239 <tr> |
|
240 <td><a href="#UserInterface.__TRPreviewer">__TRPreviewer</a></td> |
|
241 <td>Private slot to start the Translation Previewer executable.</td> |
|
242 </tr> |
|
243 <tr> |
|
244 <td><a href="#UserInterface.__UIPreviewer">__UIPreviewer</a></td> |
|
245 <td>Private slot to start the UI Previewer executable.</td> |
|
246 </tr> |
|
247 <tr> |
|
248 <td><a href="#UserInterface.__activateBrowser">__activateBrowser</a></td> |
|
249 <td>Private slot to handle the activation of the file browser.</td> |
|
250 </tr> |
|
251 <tr> |
|
252 <td><a href="#UserInterface.__activateCondaWidget">__activateCondaWidget</a></td> |
|
253 <td>Private slot to handle the activation of the Conda manager widget.</td> |
|
254 </tr> |
|
255 <tr> |
|
256 <td><a href="#UserInterface.__activateFindFileWidget">__activateFindFileWidget</a></td> |
|
257 <td>Private slot to activate the Find In Files widget.</td> |
|
258 </tr> |
|
259 <tr> |
|
260 <td><a href="#UserInterface.__activateFindLocationWidget">__activateFindLocationWidget</a></td> |
|
261 <td>Private method to activate the Find File widget.</td> |
|
262 </tr> |
|
263 <tr> |
|
264 <td><a href="#UserInterface.__activateHelpViewerWidget">__activateHelpViewerWidget</a></td> |
|
265 <td>Private method to activate the embedded Help Viewer window.</td> |
|
266 </tr> |
|
267 <tr> |
|
268 <td><a href="#UserInterface.__activateIRC">__activateIRC</a></td> |
|
269 <td>Private slot to handle the activation of the IRC window.</td> |
|
270 </tr> |
|
271 <tr> |
|
272 <td><a href="#UserInterface.__activateLeftRightSidebarWidget">__activateLeftRightSidebarWidget</a></td> |
|
273 <td>Private method to activate the given widget in the left or right sidebar.</td> |
|
274 </tr> |
|
275 <tr> |
|
276 <td><a href="#UserInterface.__activateLogViewer">__activateLogViewer</a></td> |
|
277 <td>Private slot to handle the activation of the Log Viewer.</td> |
|
278 </tr> |
|
279 <tr> |
|
280 <td><a href="#UserInterface.__activateMicroPython">__activateMicroPython</a></td> |
|
281 <td>Private slot to handle the activation of the MicroPython widget.</td> |
|
282 </tr> |
|
283 <tr> |
|
284 <td><a href="#UserInterface.__activateMultiProjectBrowser">__activateMultiProjectBrowser</a></td> |
|
285 <td>Private slot to handle the activation of the project browser.</td> |
|
286 </tr> |
|
287 <tr> |
|
288 <td><a href="#UserInterface.__activateNumbersViewer">__activateNumbersViewer</a></td> |
|
289 <td>Private slot to handle the activation of the Numbers Viewer.</td> |
|
290 </tr> |
|
291 <tr> |
|
292 <td><a href="#UserInterface.__activatePipWidget">__activatePipWidget</a></td> |
|
293 <td>Private slot to handle the activation of the PyPI manager widget.</td> |
|
294 </tr> |
|
295 <tr> |
|
296 <td><a href="#UserInterface.__activateProjectBrowser">__activateProjectBrowser</a></td> |
|
297 <td>Private slot to handle the activation of the project browser.</td> |
|
298 </tr> |
|
299 <tr> |
|
300 <td><a href="#UserInterface.__activateShell">__activateShell</a></td> |
|
301 <td>Private slot to handle the activation of the Shell window.</td> |
|
302 </tr> |
|
303 <tr> |
|
304 <td><a href="#UserInterface.__activateSymbolsViewer">__activateSymbolsViewer</a></td> |
|
305 <td>Private slot to handle the activation of the Symbols Viewer.</td> |
|
306 </tr> |
|
307 <tr> |
|
308 <td><a href="#UserInterface.__activateTaskViewer">__activateTaskViewer</a></td> |
|
309 <td>Private slot to handle the activation of the Task Viewer.</td> |
|
310 </tr> |
|
311 <tr> |
|
312 <td><a href="#UserInterface.__activateTemplateViewer">__activateTemplateViewer</a></td> |
|
313 <td>Private slot to handle the activation of the Template Viewer.</td> |
|
314 </tr> |
|
315 <tr> |
|
316 <td><a href="#UserInterface.__activateVcsStatusList">__activateVcsStatusList</a></td> |
|
317 <td>Private slot to activate the VCS Status List.</td> |
|
318 </tr> |
|
319 <tr> |
|
320 <td><a href="#UserInterface.__activateViewProfile">__activateViewProfile</a></td> |
|
321 <td>Private slot to activate a view profile.</td> |
|
322 </tr> |
|
323 <tr> |
|
324 <td><a href="#UserInterface.__activateViewmanager">__activateViewmanager</a></td> |
|
325 <td>Private slot to handle the activation of the current editor.</td> |
|
326 </tr> |
|
327 <tr> |
|
328 <td><a href="#UserInterface.__assistant">__assistant</a></td> |
|
329 <td>Private slot to start the Qt-Assistant executable.</td> |
|
330 </tr> |
|
331 <tr> |
|
332 <td><a href="#UserInterface.__checkActions">__checkActions</a></td> |
|
333 <td>Private slot to check some actions for their enable/disable status.</td> |
|
334 </tr> |
|
335 <tr> |
|
336 <td><a href="#UserInterface.__chmViewer">__chmViewer</a></td> |
|
337 <td>Private slot to start the win help viewer to show *.chm files.</td> |
|
338 </tr> |
|
339 <tr> |
|
340 <td><a href="#UserInterface.__clearPrivateData">__clearPrivateData</a></td> |
|
341 <td>Private slot to clear the private data lists.</td> |
|
342 </tr> |
|
343 <tr> |
|
344 <td><a href="#UserInterface.__commitData">__commitData</a></td> |
|
345 <td>Private slot to commit unsaved data when instructed by the desktop session manager.</td> |
|
346 </tr> |
|
347 <tr> |
|
348 <td><a href="#UserInterface.__compareFiles">__compareFiles</a></td> |
|
349 <td>Private slot to handle the Compare Files dialog.</td> |
|
350 </tr> |
|
351 <tr> |
|
352 <td><a href="#UserInterface.__compareFilesSbs">__compareFilesSbs</a></td> |
|
353 <td>Private slot to handle the Compare Files dialog.</td> |
|
354 </tr> |
|
355 <tr> |
|
356 <td><a href="#UserInterface.__configShortcuts">__configShortcuts</a></td> |
|
357 <td>Private slot to configure the keyboard shortcuts.</td> |
|
358 </tr> |
|
359 <tr> |
|
360 <td><a href="#UserInterface.__configToolBars">__configToolBars</a></td> |
|
361 <td>Private slot to configure the various toolbars.</td> |
|
362 </tr> |
|
363 <tr> |
|
364 <td><a href="#UserInterface.__configViewProfiles">__configViewProfiles</a></td> |
|
365 <td>Private slot to configure the various view profiles.</td> |
|
366 </tr> |
|
367 <tr> |
|
368 <td><a href="#UserInterface.__connectToWebBrowser">__connectToWebBrowser</a></td> |
|
369 <td>Private method to connect to a started web browser.</td> |
|
370 </tr> |
|
371 <tr> |
|
372 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td> |
|
373 <td>Private method to create a dock window with common properties.</td> |
|
374 </tr> |
|
375 <tr> |
|
376 <td><a href="#UserInterface.__createLayout">__createLayout</a></td> |
|
377 <td>Private method to create the layout of the various windows.</td> |
|
378 </tr> |
|
379 <tr> |
|
380 <td><a href="#UserInterface.__createObjects">__createObjects</a></td> |
|
381 <td>Private method to create the various application objects.</td> |
|
382 </tr> |
|
383 <tr> |
|
384 <td><a href="#UserInterface.__createSidebarsLayout">__createSidebarsLayout</a></td> |
|
385 <td>Private method to create the Sidebars layout.</td> |
|
386 </tr> |
|
387 <tr> |
|
388 <td><a href="#UserInterface.__createTestingDialog">__createTestingDialog</a></td> |
|
389 <td>Private slot to generate the testing dialog on demand.</td> |
|
390 </tr> |
|
391 <tr> |
|
392 <td><a href="#UserInterface.__createToolboxesLayout">__createToolboxesLayout</a></td> |
|
393 <td>Private method to create the Toolboxes layout.</td> |
|
394 </tr> |
|
395 <tr> |
|
396 <td><a href="#UserInterface.__customViewer">__customViewer</a></td> |
|
397 <td>Private slot to start a custom viewer.</td> |
|
398 </tr> |
|
399 <tr> |
|
400 <td><a href="#UserInterface.__debuggingDone">__debuggingDone</a></td> |
|
401 <td>Private slot to handle the end of a debugging session.</td> |
|
402 </tr> |
|
403 <tr> |
|
404 <td><a href="#UserInterface.__debuggingStarted">__debuggingStarted</a></td> |
|
405 <td>Private slot to handle the start of a debugging session.</td> |
|
406 </tr> |
|
407 <tr> |
|
408 <td><a href="#UserInterface.__deinstallPlugin">__deinstallPlugin</a></td> |
|
409 <td>Private slot to show a dialog to uninstall a plugin.</td> |
|
410 </tr> |
|
411 <tr> |
|
412 <td><a href="#UserInterface.__deleteCrashSession">__deleteCrashSession</a></td> |
|
413 <td>Private slot to delete the crash session file.</td> |
|
414 </tr> |
|
415 <tr> |
|
416 <td><a href="#UserInterface.__designer">__designer</a></td> |
|
417 <td>Private slot to start the Qt-Designer executable.</td> |
|
418 </tr> |
|
419 <tr> |
|
420 <td><a href="#UserInterface.__editPixmap">__editPixmap</a></td> |
|
421 <td>Private slot to show a pixmap in a dialog.</td> |
|
422 </tr> |
|
423 <tr> |
|
424 <td><a href="#UserInterface.__editorOpened">__editorOpened</a></td> |
|
425 <td>Private slot to handle the editorOpened signal.</td> |
|
426 </tr> |
|
427 <tr> |
|
428 <td><a href="#UserInterface.__exportPreferences">__exportPreferences</a></td> |
|
429 <td>Private slot to export the current preferences.</td> |
|
430 </tr> |
|
431 <tr> |
|
432 <td><a href="#UserInterface.__exportShortcuts">__exportShortcuts</a></td> |
|
433 <td>Private slot to export the keyboard shortcuts.</td> |
|
434 </tr> |
|
435 <tr> |
|
436 <td><a href="#UserInterface.__exportTheme">__exportTheme</a></td> |
|
437 <td>Private slot to export the current theme to a file.</td> |
|
438 </tr> |
|
439 <tr> |
|
440 <td><a href="#UserInterface.__getFloatingGeometry">__getFloatingGeometry</a></td> |
|
441 <td>Private method to get the geometry of a floating windows.</td> |
|
442 </tr> |
|
443 <tr> |
|
444 <td><a href="#UserInterface.__hasErrorLog">__hasErrorLog</a></td> |
|
445 <td>Private method to check, if an error log file exists.</td> |
|
446 </tr> |
|
447 <tr> |
|
448 <td><a href="#UserInterface.__helpViewer">__helpViewer</a></td> |
|
449 <td>Private slot to start an empty help viewer/web browser.</td> |
|
450 </tr> |
|
451 <tr> |
|
452 <td><a href="#UserInterface.__importPreferences">__importPreferences</a></td> |
|
453 <td>Private slot to import preferences.</td> |
|
454 </tr> |
|
455 <tr> |
|
456 <td><a href="#UserInterface.__importShortcuts">__importShortcuts</a></td> |
|
457 <td>Private slot to import the keyboard shortcuts.</td> |
|
458 </tr> |
|
459 <tr> |
|
460 <td><a href="#UserInterface.__importTheme">__importTheme</a></td> |
|
461 <td>Private slot to import a previously exported theme.</td> |
|
462 </tr> |
|
463 <tr> |
|
464 <td><a href="#UserInterface.__initActions">__initActions</a></td> |
|
465 <td>Private method to define the user interface actions.</td> |
|
466 </tr> |
|
467 <tr> |
|
468 <td><a href="#UserInterface.__initDebugToolbarsLayout">__initDebugToolbarsLayout</a></td> |
|
469 <td>Private slot to initialize the toolbars layout for the debug profile.</td> |
|
470 </tr> |
|
471 <tr> |
|
472 <td><a href="#UserInterface.__initEricDocAction">__initEricDocAction</a></td> |
|
473 <td>Private slot to initialize the action to show the eric documentation.</td> |
|
474 </tr> |
|
475 <tr> |
|
476 <td><a href="#UserInterface.__initExternalToolsActions">__initExternalToolsActions</a></td> |
|
477 <td>Private slot to create actions for the configured external tools.</td> |
|
478 </tr> |
|
479 <tr> |
|
480 <td><a href="#UserInterface.__initMenus">__initMenus</a></td> |
|
481 <td>Private slot to create the menus.</td> |
|
482 </tr> |
|
483 <tr> |
|
484 <td><a href="#UserInterface.__initPySideDocActions">__initPySideDocActions</a></td> |
|
485 <td>Private slot to initialize the actions to show the PySide documentation.</td> |
|
486 </tr> |
|
487 <tr> |
|
488 <td><a href="#UserInterface.__initPythonDocActions">__initPythonDocActions</a></td> |
|
489 <td>Private slot to initialize the actions to show the Python documentation.</td> |
|
490 </tr> |
|
491 <tr> |
|
492 <td><a href="#UserInterface.__initQtDocActions">__initQtDocActions</a></td> |
|
493 <td>Private slot to initialize the action to show the Qt documentation.</td> |
|
494 </tr> |
|
495 <tr> |
|
496 <td><a href="#UserInterface.__initStatusbar">__initStatusbar</a></td> |
|
497 <td>Private slot to set up the status bar.</td> |
|
498 </tr> |
|
499 <tr> |
|
500 <td><a href="#UserInterface.__initToolbars">__initToolbars</a></td> |
|
501 <td>Private slot to create the toolbars.</td> |
|
502 </tr> |
|
503 <tr> |
|
504 <td><a href="#UserInterface.__initToolsMenus">__initToolsMenus</a></td> |
|
505 <td>Private slot to initialize the various tool menus.</td> |
|
506 </tr> |
|
507 <tr> |
|
508 <td><a href="#UserInterface.__installDownloadedPlugins">__installDownloadedPlugins</a></td> |
|
509 <td>Private slot to handle the installation of plugins downloaded via the plugin repository viewer.</td> |
|
510 </tr> |
|
511 <tr> |
|
512 <td><a href="#UserInterface.__installPlugins">__installPlugins</a></td> |
|
513 <td>Private slot to show a dialog to install a new plugin.</td> |
|
514 </tr> |
|
515 <tr> |
|
516 <td><a href="#UserInterface.__ircAutoConnected">__ircAutoConnected</a></td> |
|
517 <td>Private slot handling the automatic connection of the IRC client.</td> |
|
518 </tr> |
|
519 <tr> |
|
520 <td><a href="#UserInterface.__lastEditorClosed">__lastEditorClosed</a></td> |
|
521 <td>Private slot to handle the lastEditorClosed signal.</td> |
|
522 </tr> |
|
523 <tr> |
|
524 <td><a href="#UserInterface.__launchExternalWebBrowser">__launchExternalWebBrowser</a></td> |
|
525 <td>Private method to start an external web browser and communicate with it.</td> |
|
526 </tr> |
|
527 <tr> |
|
528 <td><a href="#UserInterface.__linguist">__linguist</a></td> |
|
529 <td>Private slot to start the Qt-Linguist executable.</td> |
|
530 </tr> |
|
531 <tr> |
|
532 <td><a href="#UserInterface.__loadSessionFromFile">__loadSessionFromFile</a></td> |
|
533 <td>Private slot to load a session from disk.</td> |
|
534 </tr> |
|
535 <tr> |
|
536 <td><a href="#UserInterface.__masterPasswordChanged">__masterPasswordChanged</a></td> |
|
537 <td>Private slot to handle the change of the master password.</td> |
|
538 </tr> |
|
539 <tr> |
|
540 <td><a href="#UserInterface.__newProject">__newProject</a></td> |
|
541 <td>Private slot to handle the NewProject signal.</td> |
|
542 </tr> |
|
543 <tr> |
|
544 <td><a href="#UserInterface.__newWindow">__newWindow</a></td> |
|
545 <td>Private slot to start a new instance of eric.</td> |
|
546 </tr> |
|
547 <tr> |
|
548 <td><a href="#UserInterface.__onlineStateChanged">__onlineStateChanged</a></td> |
|
549 <td>Private slot handling changes in online state.</td> |
|
550 </tr> |
|
551 <tr> |
|
552 <td><a href="#UserInterface.__openHexEditor">__openHexEditor</a></td> |
|
553 <td>Private slot to open the hex editor window.</td> |
|
554 </tr> |
|
555 <tr> |
|
556 <td><a href="#UserInterface.__openMiniEditor">__openMiniEditor</a></td> |
|
557 <td>Private slot to show a mini editor window.</td> |
|
558 </tr> |
|
559 <tr> |
|
560 <td><a href="#UserInterface.__openOnStartup">__openOnStartup</a></td> |
|
561 <td>Private method to open the last file, project or multiproject.</td> |
|
562 </tr> |
|
563 <tr> |
|
564 <td><a href="#UserInterface.__performUpgrade">__performUpgrade</a></td> |
|
565 <td>Private method to perform the requested upgrade operation.</td> |
|
566 </tr> |
|
567 <tr> |
|
568 <td><a href="#UserInterface.__pluginInstallFinished">__pluginInstallFinished</a></td> |
|
569 <td>Private slot to handle the finishing of the plugin install dialog.</td> |
|
570 </tr> |
|
571 <tr> |
|
572 <td><a href="#UserInterface.__pluginsConfigure">__pluginsConfigure</a></td> |
|
573 <td>Private slot to show the plugin manager configuration page.</td> |
|
574 </tr> |
|
575 <tr> |
|
576 <td><a href="#UserInterface.__populateToolbarsMenu">__populateToolbarsMenu</a></td> |
|
577 <td>Private method to populate a toolbars menu.</td> |
|
578 </tr> |
|
579 <tr> |
|
580 <td><a href="#UserInterface.__preferencesChanged">__preferencesChanged</a></td> |
|
581 <td>Private slot to handle a change of the preferences.</td> |
|
582 </tr> |
|
583 <tr> |
|
584 <td><a href="#UserInterface.__processToolStderr">__processToolStderr</a></td> |
|
585 <td>Private slot to handle the readyReadStderr signal of a tool process.</td> |
|
586 </tr> |
|
587 <tr> |
|
588 <td><a href="#UserInterface.__processToolStdout">__processToolStdout</a></td> |
|
589 <td>Private slot to handle the readyReadStdout signal of a tool process.</td> |
|
590 </tr> |
|
591 <tr> |
|
592 <td><a href="#UserInterface.__programChange">__programChange</a></td> |
|
593 <td>Private slot to handle the programChange signal.</td> |
|
594 </tr> |
|
595 <tr> |
|
596 <td><a href="#UserInterface.__projectClosed">__projectClosed</a></td> |
|
597 <td>Private slot to handle the projectClosed signal.</td> |
|
598 </tr> |
|
599 <tr> |
|
600 <td><a href="#UserInterface.__projectOpened">__projectOpened</a></td> |
|
601 <td>Private slot to handle the projectOpened signal.</td> |
|
602 </tr> |
|
603 <tr> |
|
604 <td><a href="#UserInterface.__quit">__quit</a></td> |
|
605 <td>Private method to quit the application.</td> |
|
606 </tr> |
|
607 <tr> |
|
608 <td><a href="#UserInterface.__readCrashSession">__readCrashSession</a></td> |
|
609 <td>Private method to check for and read a crash session.</td> |
|
610 </tr> |
|
611 <tr> |
|
612 <td><a href="#UserInterface.__readSession">__readSession</a></td> |
|
613 <td>Private slot to read in the session file (.esj or .e5s).</td> |
|
614 </tr> |
|
615 <tr> |
|
616 <td><a href="#UserInterface.__readTasks">__readTasks</a></td> |
|
617 <td>Private slot to read in the tasks file (.etj or .e6t).</td> |
|
618 </tr> |
|
619 <tr> |
|
620 <td><a href="#UserInterface.__reloadAPIs">__reloadAPIs</a></td> |
|
621 <td>Private slot to reload the api information.</td> |
|
622 </tr> |
|
623 <tr> |
|
624 <td><a href="#UserInterface.__reportBug">__reportBug</a></td> |
|
625 <td>Private slot to handle the Report Bug dialog.</td> |
|
626 </tr> |
|
627 <tr> |
|
628 <td><a href="#UserInterface.__requestFeature">__requestFeature</a></td> |
|
629 <td>Private slot to handle the Feature Request dialog.</td> |
|
630 </tr> |
|
631 <tr> |
|
632 <td><a href="#UserInterface.__rerunFailedTests">__rerunFailedTests</a></td> |
|
633 <td>Private slot to display the testing dialog and rerun all failed tests of the last run.</td> |
|
634 </tr> |
|
635 <tr> |
|
636 <td><a href="#UserInterface.__restart">__restart</a></td> |
|
637 <td>Private method to restart the application.</td> |
|
638 </tr> |
|
639 <tr> |
|
640 <td><a href="#UserInterface.__restartTest">__restartTest</a></td> |
|
641 <td>Private slot to display the testing dialog and rerun the last test run.</td> |
|
642 </tr> |
|
643 <tr> |
|
644 <td><a href="#UserInterface.__saveCurrentViewProfile">__saveCurrentViewProfile</a></td> |
|
645 <td>Private slot to save the window geometries of the active profile.</td> |
|
646 </tr> |
|
647 <tr> |
|
648 <td><a href="#UserInterface.__saveSessionToFile">__saveSessionToFile</a></td> |
|
649 <td>Private slot to save a session to disk.</td> |
|
650 </tr> |
|
651 <tr> |
|
652 <td><a href="#UserInterface.__setEditProfile">__setEditProfile</a></td> |
|
653 <td>Private slot to activate the edit view profile.</td> |
|
654 </tr> |
|
655 <tr> |
|
656 <td><a href="#UserInterface.__setWindowCaption">__setWindowCaption</a></td> |
|
657 <td>Private method to set the caption of the Main Window.</td> |
|
658 </tr> |
|
659 <tr> |
|
660 <td><a href="#UserInterface.__setupDockWindow">__setupDockWindow</a></td> |
|
661 <td>Private method to configure the dock window created with __createDockWindow().</td> |
|
662 </tr> |
|
663 <tr> |
|
664 <td><a href="#UserInterface.__showCertificatesDialog">__showCertificatesDialog</a></td> |
|
665 <td>Private slot to show the certificates management dialog.</td> |
|
666 </tr> |
|
667 <tr> |
|
668 <td><a href="#UserInterface.__showEricDoc">__showEricDoc</a></td> |
|
669 <td>Private slot to show the Eric documentation.</td> |
|
670 </tr> |
|
671 <tr> |
|
672 <td><a href="#UserInterface.__showErrorLog">__showErrorLog</a></td> |
|
673 <td>Private slot to show the most recent error log message.</td> |
|
674 </tr> |
|
675 <tr> |
|
676 <td><a href="#UserInterface.__showExternalTools">__showExternalTools</a></td> |
|
677 <td>Private slot to display a dialog show a list of external tools used by eric.</td> |
|
678 </tr> |
|
679 <tr> |
|
680 <td><a href="#UserInterface.__showExtrasMenu">__showExtrasMenu</a></td> |
|
681 <td>Private slot to display the Extras menu.</td> |
|
682 </tr> |
|
683 <tr> |
|
684 <td><a href="#UserInterface.__showFileMenu">__showFileMenu</a></td> |
|
685 <td>Private slot to display the File menu.</td> |
|
686 </tr> |
|
687 <tr> |
|
688 <td><a href="#UserInterface.__showHelpMenu">__showHelpMenu</a></td> |
|
689 <td>Private slot to display the Help menu.</td> |
|
690 </tr> |
|
691 <tr> |
|
692 <td><a href="#UserInterface.__showInstallInfo">__showInstallInfo</a></td> |
|
693 <td>Private slot to show a dialog containing information about the installation process.</td> |
|
694 </tr> |
|
695 <tr> |
|
696 <td><a href="#UserInterface.__showNext">__showNext</a></td> |
|
697 <td>Private slot used to show the next tab or file.</td> |
|
698 </tr> |
|
699 <tr> |
|
700 <td><a href="#UserInterface.__showPixmap">__showPixmap</a></td> |
|
701 <td>Private slot to show a pixmap in a dialog.</td> |
|
702 </tr> |
|
703 <tr> |
|
704 <td><a href="#UserInterface.__showPluginInfo">__showPluginInfo</a></td> |
|
705 <td>Private slot to show the plugin info dialog.</td> |
|
706 </tr> |
|
707 <tr> |
|
708 <td><a href="#UserInterface.__showPluginToolsMenu">__showPluginToolsMenu</a></td> |
|
709 <td>Private slot to show the Plugin Tools menu.</td> |
|
710 </tr> |
|
711 <tr> |
|
712 <td><a href="#UserInterface.__showPluginsAvailable">__showPluginsAvailable</a></td> |
|
713 <td>Private slot to show the plugins available for download.</td> |
|
714 </tr> |
|
715 <tr> |
|
716 <td><a href="#UserInterface.__showPrevious">__showPrevious</a></td> |
|
717 <td>Private slot used to show the previous tab or file.</td> |
|
718 </tr> |
|
719 <tr> |
|
720 <td><a href="#UserInterface.__showPyQtDoc">__showPyQtDoc</a></td> |
|
721 <td>Private slot to show the PyQt5/6 documentation.</td> |
|
722 </tr> |
|
723 <tr> |
|
724 <td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td> |
|
725 <td>Private slot to show the PySide2/PySide6 documentation.</td> |
|
726 </tr> |
|
727 <tr> |
|
728 <td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td> |
|
729 <td>Private slot to show the Python 3 documentation.</td> |
|
730 </tr> |
|
731 <tr> |
|
732 <td><a href="#UserInterface.__showQtDoc">__showQtDoc</a></td> |
|
733 <td>Private method to show the Qt documentation.</td> |
|
734 </tr> |
|
735 <tr> |
|
736 <td><a href="#UserInterface.__showSettingsMenu">__showSettingsMenu</a></td> |
|
737 <td>Private slot to show the Settings menu.</td> |
|
738 </tr> |
|
739 <tr> |
|
740 <td><a href="#UserInterface.__showSubWindowMenu">__showSubWindowMenu</a></td> |
|
741 <td>Private slot to display the Window menu of the Window menu.</td> |
|
742 </tr> |
|
743 <tr> |
|
744 <td><a href="#UserInterface.__showSvg">__showSvg</a></td> |
|
745 <td>Private slot to show a SVG file in a dialog.</td> |
|
746 </tr> |
|
747 <tr> |
|
748 <td><a href="#UserInterface.__showSystemEmailClient">__showSystemEmailClient</a></td> |
|
749 <td>Private slot to show the system email dialog.</td> |
|
750 </tr> |
|
751 <tr> |
|
752 <td><a href="#UserInterface.__showToolGroupsMenu">__showToolGroupsMenu</a></td> |
|
753 <td>Private slot to display the Tool Groups menu.</td> |
|
754 </tr> |
|
755 <tr> |
|
756 <td><a href="#UserInterface.__showToolbarsMenu">__showToolbarsMenu</a></td> |
|
757 <td>Private slot to display the Toolbars menu.</td> |
|
758 </tr> |
|
759 <tr> |
|
760 <td><a href="#UserInterface.__showUml">__showUml</a></td> |
|
761 <td>Private slot to show an eric graphics file in a dialog.</td> |
|
762 </tr> |
|
763 <tr> |
|
764 <td><a href="#UserInterface.__showUserToolsMenu">__showUserToolsMenu</a></td> |
|
765 <td>Private slot to display the User Tools menu.</td> |
|
766 </tr> |
|
767 <tr> |
|
768 <td><a href="#UserInterface.__showVersions">__showVersions</a></td> |
|
769 <td>Private slot to handle the Versions dialog.</td> |
|
770 </tr> |
|
771 <tr> |
|
772 <td><a href="#UserInterface.__showWindowMenu">__showWindowMenu</a></td> |
|
773 <td>Private slot to display the Window menu.</td> |
|
774 </tr> |
|
775 <tr> |
|
776 <td><a href="#UserInterface.__showWizardsMenu">__showWizardsMenu</a></td> |
|
777 <td>Private slot to display the Wizards menu.</td> |
|
778 </tr> |
|
779 <tr> |
|
780 <td><a href="#UserInterface.__shutdown">__shutdown</a></td> |
|
781 <td>Private method to perform all necessary steps to close down the IDE.</td> |
|
782 </tr> |
|
783 <tr> |
|
784 <td><a href="#UserInterface.__snapshot">__snapshot</a></td> |
|
785 <td>Private slot to start the snapshot tool.</td> |
|
786 </tr> |
|
787 <tr> |
|
788 <td><a href="#UserInterface.__sqlBrowser">__sqlBrowser</a></td> |
|
789 <td>Private slot to start the SQL browser tool.</td> |
|
790 </tr> |
|
791 <tr> |
|
792 <td><a href="#UserInterface.__sslErrors">__sslErrors</a></td> |
|
793 <td>Private slot to handle SSL errors.</td> |
|
794 </tr> |
|
795 <tr> |
|
796 <td><a href="#UserInterface.__startTestProject">__startTestProject</a></td> |
|
797 <td>Private slot for displaying the testing dialog and run the test for the current project.</td> |
|
798 </tr> |
|
799 <tr> |
|
800 <td><a href="#UserInterface.__startTestScript">__startTestScript</a></td> |
|
801 <td>Private slot for displaying the testing dialog and run the current script.</td> |
|
802 </tr> |
|
803 <tr> |
|
804 <td><a href="#UserInterface.__startTesting">__startTesting</a></td> |
|
805 <td>Private slot for displaying the testing dialog.</td> |
|
806 </tr> |
|
807 <tr> |
|
808 <td><a href="#UserInterface.__startToolProcess">__startToolProcess</a></td> |
|
809 <td>Private slot to start an external tool process.</td> |
|
810 </tr> |
|
811 <tr> |
|
812 <td><a href="#UserInterface.__startWebBrowser">__startWebBrowser</a></td> |
|
813 <td>Private slot to start the eric web browser.</td> |
|
814 </tr> |
|
815 <tr> |
|
816 <td><a href="#UserInterface.__switchTab">__switchTab</a></td> |
|
817 <td>Private slot used to switch between the current and the previous current tab.</td> |
|
818 </tr> |
|
819 <tr> |
|
820 <td><a href="#UserInterface.__testingStopped">__testingStopped</a></td> |
|
821 <td>Private slot to handle the end of a test run.</td> |
|
822 </tr> |
|
823 <tr> |
|
824 <td><a href="#UserInterface.__toggleBottomSidebar">__toggleBottomSidebar</a></td> |
|
825 <td>Private slot to handle the toggle of the bottom sidebar window.</td> |
|
826 </tr> |
|
827 <tr> |
|
828 <td><a href="#UserInterface.__toggleHorizontalToolbox">__toggleHorizontalToolbox</a></td> |
|
829 <td>Private slot to handle the toggle of the Horizontal Toolbox window.</td> |
|
830 </tr> |
|
831 <tr> |
|
832 <td><a href="#UserInterface.__toggleLeftSidebar">__toggleLeftSidebar</a></td> |
|
833 <td>Private slot to handle the toggle of the left sidebar window.</td> |
|
834 </tr> |
|
835 <tr> |
|
836 <td><a href="#UserInterface.__toggleLeftToolbox">__toggleLeftToolbox</a></td> |
|
837 <td>Private slot to handle the toggle of the Left Toolbox window.</td> |
|
838 </tr> |
|
839 <tr> |
|
840 <td><a href="#UserInterface.__toggleRightSidebar">__toggleRightSidebar</a></td> |
|
841 <td>Private slot to handle the toggle of the right sidebar window.</td> |
|
842 </tr> |
|
843 <tr> |
|
844 <td><a href="#UserInterface.__toggleRightToolbox">__toggleRightToolbox</a></td> |
|
845 <td>Private slot to handle the toggle of the Right Toolbox window.</td> |
|
846 </tr> |
|
847 <tr> |
|
848 <td><a href="#UserInterface.__toggleWindow">__toggleWindow</a></td> |
|
849 <td>Private method to toggle a workspace editor window.</td> |
|
850 </tr> |
|
851 <tr> |
|
852 <td><a href="#UserInterface.__toolActionTriggered">__toolActionTriggered</a></td> |
|
853 <td>Private slot called by external tools toolbar actions.</td> |
|
854 </tr> |
|
855 <tr> |
|
856 <td><a href="#UserInterface.__toolExecute">__toolExecute</a></td> |
|
857 <td>Private slot to execute a particular tool.</td> |
|
858 </tr> |
|
859 <tr> |
|
860 <td><a href="#UserInterface.__toolFinished">__toolFinished</a></td> |
|
861 <td>Private slot to handle the finished signal of a tool process.</td> |
|
862 </tr> |
|
863 <tr> |
|
864 <td><a href="#UserInterface.__toolGroupSelected">__toolGroupSelected</a></td> |
|
865 <td>Private slot to set the current tool group.</td> |
|
866 </tr> |
|
867 <tr> |
|
868 <td><a href="#UserInterface.__toolGroupsConfiguration">__toolGroupsConfiguration</a></td> |
|
869 <td>Private slot to handle the tool groups configuration menu entry.</td> |
|
870 </tr> |
|
871 <tr> |
|
872 <td><a href="#UserInterface.__toolsConfiguration">__toolsConfiguration</a></td> |
|
873 <td>Private slot to handle the tools configuration menu entry.</td> |
|
874 </tr> |
|
875 <tr> |
|
876 <td><a href="#UserInterface.__updateExternalToolsActions">__updateExternalToolsActions</a></td> |
|
877 <td>Private method to update the external tools actions for the current tool group.</td> |
|
878 </tr> |
|
879 <tr> |
|
880 <td><a href="#UserInterface.__versionToTuple">__versionToTuple</a></td> |
|
881 <td>Private method to convert a version string into a tuple.</td> |
|
882 </tr> |
|
883 <tr> |
|
884 <td><a href="#UserInterface.__webBrowser">__webBrowser</a></td> |
|
885 <td>Private slot to start the eric web browser.</td> |
|
886 </tr> |
|
887 <tr> |
|
888 <td><a href="#UserInterface.__webBrowserFinished">__webBrowserFinished</a></td> |
|
889 <td>Private slot handling the end of the external web browser process.</td> |
|
890 </tr> |
|
891 <tr> |
|
892 <td><a href="#UserInterface.__webBrowserShutdown">__webBrowserShutdown</a></td> |
|
893 <td>Private method to shut down the web browser.</td> |
|
894 </tr> |
|
895 <tr> |
|
896 <td><a href="#UserInterface.__whatsThis">__whatsThis</a></td> |
|
897 <td>Private slot called in to enter Whats This mode.</td> |
|
898 </tr> |
|
899 <tr> |
|
900 <td><a href="#UserInterface.__writeCrashSession">__writeCrashSession</a></td> |
|
901 <td>Private slot to write a crash session file.</td> |
|
902 </tr> |
|
903 <tr> |
|
904 <td><a href="#UserInterface.__writeSession">__writeSession</a></td> |
|
905 <td>Private slot to write the session data to a JSON file (.esj).</td> |
|
906 </tr> |
|
907 <tr> |
|
908 <td><a href="#UserInterface.__writeTasks">__writeTasks</a></td> |
|
909 <td>Private slot to write the tasks data to a JSON file (.etj).</td> |
|
910 </tr> |
|
911 <tr> |
|
912 <td><a href="#UserInterface.activateCodeDocumentationViewer">activateCodeDocumentationViewer</a></td> |
|
913 <td>Public slot to handle the activation of the Code Documentation Viewer.</td> |
|
914 </tr> |
|
915 <tr> |
|
916 <td><a href="#UserInterface.activateCooperationViewer">activateCooperationViewer</a></td> |
|
917 <td>Public slot to handle the activation of the cooperation window.</td> |
|
918 </tr> |
|
919 <tr> |
|
920 <td><a href="#UserInterface.activateDebugViewer">activateDebugViewer</a></td> |
|
921 <td>Public slot to handle the activation of the debug viewer.</td> |
|
922 </tr> |
|
923 <tr> |
|
924 <td><a href="#UserInterface.activatePluginRepositoryViewer">activatePluginRepositoryViewer</a></td> |
|
925 <td>Public slot to activate the plugin repository viewer.</td> |
|
926 </tr> |
|
927 <tr> |
|
928 <td><a href="#UserInterface.activateVirtualenvManager">activateVirtualenvManager</a></td> |
|
929 <td>Public slot to activate the virtual environments manager widget.</td> |
|
930 </tr> |
|
931 <tr> |
|
932 <td><a href="#UserInterface.addEricActions">addEricActions</a></td> |
|
933 <td>Public method to add actions to the list of actions.</td> |
|
934 </tr> |
|
935 <tr> |
|
936 <td><a href="#UserInterface.addSideWidget">addSideWidget</a></td> |
|
937 <td>Public method to add a widget to the sides.</td> |
|
938 </tr> |
|
939 <tr> |
|
940 <td><a href="#UserInterface.appendToStderr">appendToStderr</a></td> |
|
941 <td>Public slot to append text to the stderr log viewer tab.</td> |
|
942 </tr> |
|
943 <tr> |
|
944 <td><a href="#UserInterface.appendToStdout">appendToStdout</a></td> |
|
945 <td>Public slot to append text to the stdout log viewer tab.</td> |
|
946 </tr> |
|
947 <tr> |
|
948 <td><a href="#UserInterface.autoConnectIrc">autoConnectIrc</a></td> |
|
949 <td>Public method to initiate the IRC auto connection.</td> |
|
950 </tr> |
|
951 <tr> |
|
952 <td><a href="#UserInterface.checkConfigurationStatus">checkConfigurationStatus</a></td> |
|
953 <td>Public method to check, if eric has been configured.</td> |
|
954 </tr> |
|
955 <tr> |
|
956 <td><a href="#UserInterface.checkForErrorLog">checkForErrorLog</a></td> |
|
957 <td>Public method to check for the presence of an error log and ask the user, what to do with it.</td> |
|
958 </tr> |
|
959 <tr> |
|
960 <td><a href="#UserInterface.checkPluginUpdatesAvailable">checkPluginUpdatesAvailable</a></td> |
|
961 <td>Public method to check the availability of updates of plug-ins.</td> |
|
962 </tr> |
|
963 <tr> |
|
964 <td><a href="#UserInterface.checkProjectsWorkspace">checkProjectsWorkspace</a></td> |
|
965 <td>Public method to check, if a projects workspace has been configured.</td> |
|
966 </tr> |
|
967 <tr> |
|
968 <td><a href="#UserInterface.closeEvent">closeEvent</a></td> |
|
969 <td>Protected event handler for the close event.</td> |
|
970 </tr> |
|
971 <tr> |
|
972 <td><a href="#UserInterface.createPopupMenu">createPopupMenu</a></td> |
|
973 <td>Public method to create the toolbars menu for Qt.</td> |
|
974 </tr> |
|
975 <tr> |
|
976 <td><a href="#UserInterface.documentationViewer">documentationViewer</a></td> |
|
977 <td>Public method to provide a reference to the code documentation viewer.</td> |
|
978 </tr> |
|
979 <tr> |
|
980 <td><a href="#UserInterface.dragEnterEvent">dragEnterEvent</a></td> |
|
981 <td>Protected method to handle the drag enter event.</td> |
|
982 </tr> |
|
983 <tr> |
|
984 <td><a href="#UserInterface.dragLeaveEvent">dragLeaveEvent</a></td> |
|
985 <td>Protected method to handle the drag leave event.</td> |
|
986 </tr> |
|
987 <tr> |
|
988 <td><a href="#UserInterface.dragMoveEvent">dragMoveEvent</a></td> |
|
989 <td>Protected method to handle the drag move event.</td> |
|
990 </tr> |
|
991 <tr> |
|
992 <td><a href="#UserInterface.dropEvent">dropEvent</a></td> |
|
993 <td>Protected method to handle the drop event.</td> |
|
994 </tr> |
|
995 <tr> |
|
996 <td><a href="#UserInterface.getActions">getActions</a></td> |
|
997 <td>Public method to get a list of all actions.</td> |
|
998 </tr> |
|
999 <tr> |
|
1000 <td><a href="#UserInterface.getLayoutType">getLayoutType</a></td> |
|
1001 <td>Public method to get the current layout type.</td> |
|
1002 </tr> |
|
1003 <tr> |
|
1004 <td><a href="#UserInterface.getLocale">getLocale</a></td> |
|
1005 <td>Public method to get the locale of the IDE.</td> |
|
1006 </tr> |
|
1007 <tr> |
|
1008 <td><a href="#UserInterface.getMenu">getMenu</a></td> |
|
1009 <td>Public method to get a reference to a specific menu.</td> |
|
1010 </tr> |
|
1011 <tr> |
|
1012 <td><a href="#UserInterface.getMenuAction">getMenuAction</a></td> |
|
1013 <td>Public method to get a reference to an action of a menu.</td> |
|
1014 </tr> |
|
1015 <tr> |
|
1016 <td><a href="#UserInterface.getMenuBarAction">getMenuBarAction</a></td> |
|
1017 <td>Public method to get a reference to an action of the main menu.</td> |
|
1018 </tr> |
|
1019 <tr> |
|
1020 <td><a href="#UserInterface.getOriginalPathString">getOriginalPathString</a></td> |
|
1021 <td>Public method to get the original PATH environment variable (i.e.</td> |
|
1022 </tr> |
|
1023 <tr> |
|
1024 <td><a href="#UserInterface.getToolBarIconSize">getToolBarIconSize</a></td> |
|
1025 <td>Public method to get the toolbar icon size.</td> |
|
1026 </tr> |
|
1027 <tr> |
|
1028 <td><a href="#UserInterface.getToolbar">getToolbar</a></td> |
|
1029 <td>Public method to get a reference to a specific toolbar.</td> |
|
1030 </tr> |
|
1031 <tr> |
|
1032 <td><a href="#UserInterface.getToolbarsByCategory">getToolbarsByCategory</a></td> |
|
1033 <td>Public method to get a list of toolbars belonging to a given toolbar category.</td> |
|
1034 </tr> |
|
1035 <tr> |
|
1036 <td><a href="#UserInterface.getViewProfile">getViewProfile</a></td> |
|
1037 <td>Public method to get the current view profile.</td> |
|
1038 </tr> |
|
1039 <tr> |
|
1040 <td><a href="#UserInterface.handleUrl">handleUrl</a></td> |
|
1041 <td>Public slot to handle opening a URL.</td> |
|
1042 </tr> |
|
1043 <tr> |
|
1044 <td><a href="#UserInterface.isOnline">isOnline</a></td> |
|
1045 <td>Public method to get the online state.</td> |
|
1046 </tr> |
|
1047 <tr> |
|
1048 <td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td> |
|
1049 <td>Public slot to start the help viewer/web browser.</td> |
|
1050 </tr> |
|
1051 <tr> |
|
1052 <td><a href="#UserInterface.networkAccessManager">networkAccessManager</a></td> |
|
1053 <td>Public method to get a reference to the network access manager object.</td> |
|
1054 </tr> |
|
1055 <tr> |
|
1056 <td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td> |
|
1057 <td>Public method to check for an update even if not installed via PyPI.</td> |
|
1058 </tr> |
|
1059 <tr> |
|
1060 <td><a href="#UserInterface.processArgs">processArgs</a></td> |
|
1061 <td>Public method to process the command line args passed to the UI.</td> |
|
1062 </tr> |
|
1063 <tr> |
|
1064 <td><a href="#UserInterface.processInstallInfoFile">processInstallInfoFile</a></td> |
|
1065 <td>Public method to process the file containing installation information.</td> |
|
1066 </tr> |
|
1067 <tr> |
|
1068 <td><a href="#UserInterface.registerToolbar">registerToolbar</a></td> |
|
1069 <td>Public method to register a toolbar.</td> |
|
1070 </tr> |
|
1071 <tr> |
|
1072 <td><a href="#UserInterface.removeEricActions">removeEricActions</a></td> |
|
1073 <td>Public method to remove actions from the list of actions.</td> |
|
1074 </tr> |
|
1075 <tr> |
|
1076 <td><a href="#UserInterface.removeSideWidget">removeSideWidget</a></td> |
|
1077 <td>Public method to remove a widget added using addSideWidget().</td> |
|
1078 </tr> |
|
1079 <tr> |
|
1080 <td><a href="#UserInterface.reregisterToolbar">reregisterToolbar</a></td> |
|
1081 <td>Public method to change the visible text for the named toolbar.</td> |
|
1082 </tr> |
|
1083 <tr> |
|
1084 <td><a href="#UserInterface.setDebugProfile">setDebugProfile</a></td> |
|
1085 <td>Public slot to activate the debug view profile.</td> |
|
1086 </tr> |
|
1087 <tr> |
|
1088 <td><a href="#UserInterface.showEmailDialog">showEmailDialog</a></td> |
|
1089 <td>Public slot to show the email dialog in a given mode.</td> |
|
1090 </tr> |
|
1091 <tr> |
|
1092 <td><a href="#UserInterface.showEvent">showEvent</a></td> |
|
1093 <td>Protected method to handle the show event.</td> |
|
1094 </tr> |
|
1095 <tr> |
|
1096 <td><a href="#UserInterface.showFindFileByNameDialog">showFindFileByNameDialog</a></td> |
|
1097 <td>Public slot to show the Find File by Name dialog.</td> |
|
1098 </tr> |
|
1099 <tr> |
|
1100 <td><a href="#UserInterface.showFindFilesWidget">showFindFilesWidget</a></td> |
|
1101 <td>Public slot to show the Find In Files widget.</td> |
|
1102 </tr> |
|
1103 <tr> |
|
1104 <td><a href="#UserInterface.showFindLocationWidget">showFindLocationWidget</a></td> |
|
1105 <td>Public method to show the Find File widget.</td> |
|
1106 </tr> |
|
1107 <tr> |
|
1108 <td><a href="#UserInterface.showLogViewer">showLogViewer</a></td> |
|
1109 <td>Public method to show the Log-Viewer.</td> |
|
1110 </tr> |
|
1111 <tr> |
|
1112 <td><a href="#UserInterface.showNotification">showNotification</a></td> |
|
1113 <td>Public method to show a desktop notification.</td> |
|
1114 </tr> |
|
1115 <tr> |
|
1116 <td><a href="#UserInterface.showPreferences">showPreferences</a></td> |
|
1117 <td>Public slot to set the preferences.</td> |
|
1118 </tr> |
|
1119 <tr> |
|
1120 <td><a href="#UserInterface.showReplaceFilesWidget">showReplaceFilesWidget</a></td> |
|
1121 <td>Public slot to show the Find In Files widget in replace mode.</td> |
|
1122 </tr> |
|
1123 <tr> |
|
1124 <td><a href="#UserInterface.showSideWidget">showSideWidget</a></td> |
|
1125 <td>Public method to show a specific widget placed in the side widgets.</td> |
|
1126 </tr> |
|
1127 <tr> |
|
1128 <td><a href="#UserInterface.unregisterToolbar">unregisterToolbar</a></td> |
|
1129 <td>Public method to unregister a toolbar.</td> |
|
1130 </tr> |
|
1131 <tr> |
|
1132 <td><a href="#UserInterface.upgradeEric">upgradeEric</a></td> |
|
1133 <td>Public slot to upgrade the eric-ide package of the eric7 environment.</td> |
|
1134 </tr> |
|
1135 <tr> |
|
1136 <td><a href="#UserInterface.upgradeEricPyQt">upgradeEricPyQt</a></td> |
|
1137 <td>Public slot to upgrade the eric-ide and Pyqt packages of the eric7 environment.</td> |
|
1138 </tr> |
|
1139 <tr> |
|
1140 <td><a href="#UserInterface.upgradePyQt">upgradePyQt</a></td> |
|
1141 <td>Public slot to upgrade the PyQt packages of the eric7 environment.</td> |
|
1142 </tr> |
|
1143 <tr> |
|
1144 <td><a href="#UserInterface.versionIsNewer">versionIsNewer</a></td> |
|
1145 <td>Public method to check, if the eric version is good compared to the required version.</td> |
|
1146 </tr> |
|
1147 </table> |
|
1148 <h3>Static Methods</h3> |
|
1149 |
|
1150 <table> |
|
1151 <tr><td>None</td></tr> |
|
1152 </table> |
|
1153 |
|
1154 <a NAME="UserInterface.__init__" ID="UserInterface.__init__"></a> |
|
1155 <h4>UserInterface (Constructor)</h4> |
|
1156 <b>UserInterface</b>(<i>app, locale, splash, plugin, disabledPlugins, noOpenAtStartup, noCrashOpenAtStartup, disableCrashSession, restartArguments, originalPathString</i>) |
|
1157 |
|
1158 <p> |
|
1159 Constructor |
|
1160 </p> |
|
1161 <dl> |
|
1162 |
|
1163 <dt><i>app</i> (EricApplication)</dt> |
|
1164 <dd> |
|
1165 reference to the application object |
|
1166 </dd> |
|
1167 <dt><i>locale</i> (str)</dt> |
|
1168 <dd> |
|
1169 locale to be used by the UI |
|
1170 </dd> |
|
1171 <dt><i>splash</i> (UI.SplashScreen.SplashScreen)</dt> |
|
1172 <dd> |
|
1173 reference to the splashscreen |
|
1174 </dd> |
|
1175 <dt><i>plugin</i> (str)</dt> |
|
1176 <dd> |
|
1177 filename of a plug-in to be loaded (used for plugin |
|
1178 development) |
|
1179 </dd> |
|
1180 <dt><i>disabledPlugins</i> (list of str)</dt> |
|
1181 <dd> |
|
1182 list of plug-ins that have been disabled via |
|
1183 the command line parameters '--disable-plugin=' |
|
1184 </dd> |
|
1185 <dt><i>noOpenAtStartup</i> (bool)</dt> |
|
1186 <dd> |
|
1187 flag indicating that the open at startup option |
|
1188 should not be executed |
|
1189 </dd> |
|
1190 <dt><i>noCrashOpenAtStartup</i> (bool)</dt> |
|
1191 <dd> |
|
1192 flag indicating to ignore any crash session |
|
1193 file found at statup |
|
1194 </dd> |
|
1195 <dt><i>disableCrashSession</i> (bool)</dt> |
|
1196 <dd> |
|
1197 flag indicating to disable the crash session |
|
1198 support |
|
1199 </dd> |
|
1200 <dt><i>restartArguments</i> (list of str)</dt> |
|
1201 <dd> |
|
1202 list of command line parameters to be used for |
|
1203 a restart |
|
1204 </dd> |
|
1205 <dt><i>originalPathString</i> (str)</dt> |
|
1206 <dd> |
|
1207 original PATH environment variable |
|
1208 </dd> |
|
1209 </dl> |
|
1210 <a NAME="UserInterface.__TBMenuTriggered" ID="UserInterface.__TBMenuTriggered"></a> |
|
1211 <h4>UserInterface.__TBMenuTriggered</h4> |
|
1212 <b>__TBMenuTriggered</b>(<i>act</i>) |
|
1213 |
|
1214 <p> |
|
1215 Private method to handle the toggle of a toolbar via the Window-> |
|
1216 Toolbars submenu. |
|
1217 </p> |
|
1218 <dl> |
|
1219 |
|
1220 <dt><i>act</i></dt> |
|
1221 <dd> |
|
1222 reference to the action that was triggered (QAction) |
|
1223 </dd> |
|
1224 </dl> |
|
1225 <a NAME="UserInterface.__TBPopupMenuTriggered" ID="UserInterface.__TBPopupMenuTriggered"></a> |
|
1226 <h4>UserInterface.__TBPopupMenuTriggered</h4> |
|
1227 <b>__TBPopupMenuTriggered</b>(<i>act</i>) |
|
1228 |
|
1229 <p> |
|
1230 Private method to handle the toggle of a toolbar via the QMainWindow |
|
1231 Toolbars popup menu. |
|
1232 </p> |
|
1233 <dl> |
|
1234 |
|
1235 <dt><i>act</i></dt> |
|
1236 <dd> |
|
1237 reference to the action that was triggered (QAction) |
|
1238 </dd> |
|
1239 </dl> |
|
1240 <a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a> |
|
1241 <h4>UserInterface.__TRPreviewer</h4> |
|
1242 <b>__TRPreviewer</b>(<i>fileNames=None, ignore=False</i>) |
|
1243 |
|
1244 <p> |
|
1245 Private slot to start the Translation Previewer executable. |
|
1246 </p> |
|
1247 <dl> |
|
1248 |
|
1249 <dt><i>fileNames</i></dt> |
|
1250 <dd> |
|
1251 filenames of forms and/or translations to be previewed |
|
1252 (list of strings) |
|
1253 </dd> |
|
1254 <dt><i>ignore</i></dt> |
|
1255 <dd> |
|
1256 flag indicating non existing files should be ignored |
|
1257 (boolean) |
|
1258 </dd> |
|
1259 </dl> |
|
1260 <a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a> |
|
1261 <h4>UserInterface.__UIPreviewer</h4> |
|
1262 <b>__UIPreviewer</b>(<i>fn=None</i>) |
|
1263 |
|
1264 <p> |
|
1265 Private slot to start the UI Previewer executable. |
|
1266 </p> |
|
1267 <dl> |
|
1268 |
|
1269 <dt><i>fn</i></dt> |
|
1270 <dd> |
|
1271 filename of the form to be previewed (string) |
|
1272 </dd> |
|
1273 </dl> |
|
1274 <a NAME="UserInterface.__activateBrowser" ID="UserInterface.__activateBrowser"></a> |
|
1275 <h4>UserInterface.__activateBrowser</h4> |
|
1276 <b>__activateBrowser</b>(<i></i>) |
|
1277 |
|
1278 <p> |
|
1279 Private slot to handle the activation of the file browser. |
|
1280 </p> |
|
1281 <a NAME="UserInterface.__activateCondaWidget" ID="UserInterface.__activateCondaWidget"></a> |
|
1282 <h4>UserInterface.__activateCondaWidget</h4> |
|
1283 <b>__activateCondaWidget</b>(<i></i>) |
|
1284 |
|
1285 <p> |
|
1286 Private slot to handle the activation of the Conda manager widget. |
|
1287 </p> |
|
1288 <a NAME="UserInterface.__activateFindFileWidget" ID="UserInterface.__activateFindFileWidget"></a> |
|
1289 <h4>UserInterface.__activateFindFileWidget</h4> |
|
1290 <b>__activateFindFileWidget</b>(<i></i>) |
|
1291 |
|
1292 <p> |
|
1293 Private slot to activate the Find In Files widget. |
|
1294 </p> |
|
1295 <a NAME="UserInterface.__activateFindLocationWidget" ID="UserInterface.__activateFindLocationWidget"></a> |
|
1296 <h4>UserInterface.__activateFindLocationWidget</h4> |
|
1297 <b>__activateFindLocationWidget</b>(<i></i>) |
|
1298 |
|
1299 <p> |
|
1300 Private method to activate the Find File widget. |
|
1301 </p> |
|
1302 <a NAME="UserInterface.__activateHelpViewerWidget" ID="UserInterface.__activateHelpViewerWidget"></a> |
|
1303 <h4>UserInterface.__activateHelpViewerWidget</h4> |
|
1304 <b>__activateHelpViewerWidget</b>(<i>urlStr=None</i>) |
|
1305 |
|
1306 <p> |
|
1307 Private method to activate the embedded Help Viewer window. |
|
1308 </p> |
|
1309 <dl> |
|
1310 |
|
1311 <dt><i>urlStr</i> (str)</dt> |
|
1312 <dd> |
|
1313 URL to be shown |
|
1314 </dd> |
|
1315 </dl> |
|
1316 <a NAME="UserInterface.__activateIRC" ID="UserInterface.__activateIRC"></a> |
|
1317 <h4>UserInterface.__activateIRC</h4> |
|
1318 <b>__activateIRC</b>(<i></i>) |
|
1319 |
|
1320 <p> |
|
1321 Private slot to handle the activation of the IRC window. |
|
1322 </p> |
|
1323 <a NAME="UserInterface.__activateLeftRightSidebarWidget" ID="UserInterface.__activateLeftRightSidebarWidget"></a> |
|
1324 <h4>UserInterface.__activateLeftRightSidebarWidget</h4> |
|
1325 <b>__activateLeftRightSidebarWidget</b>(<i>widget</i>) |
|
1326 |
|
1327 <p> |
|
1328 Private method to activate the given widget in the left or right |
|
1329 sidebar. |
|
1330 </p> |
|
1331 <dl> |
|
1332 |
|
1333 <dt><i>widget</i> (QWidget)</dt> |
|
1334 <dd> |
|
1335 reference to the widget to be activated |
|
1336 </dd> |
|
1337 </dl> |
|
1338 <a NAME="UserInterface.__activateLogViewer" ID="UserInterface.__activateLogViewer"></a> |
|
1339 <h4>UserInterface.__activateLogViewer</h4> |
|
1340 <b>__activateLogViewer</b>(<i></i>) |
|
1341 |
|
1342 <p> |
|
1343 Private slot to handle the activation of the Log Viewer. |
|
1344 </p> |
|
1345 <a NAME="UserInterface.__activateMicroPython" ID="UserInterface.__activateMicroPython"></a> |
|
1346 <h4>UserInterface.__activateMicroPython</h4> |
|
1347 <b>__activateMicroPython</b>(<i></i>) |
|
1348 |
|
1349 <p> |
|
1350 Private slot to handle the activation of the MicroPython widget. |
|
1351 </p> |
|
1352 <a NAME="UserInterface.__activateMultiProjectBrowser" ID="UserInterface.__activateMultiProjectBrowser"></a> |
|
1353 <h4>UserInterface.__activateMultiProjectBrowser</h4> |
|
1354 <b>__activateMultiProjectBrowser</b>(<i></i>) |
|
1355 |
|
1356 <p> |
|
1357 Private slot to handle the activation of the project browser. |
|
1358 </p> |
|
1359 <a NAME="UserInterface.__activateNumbersViewer" ID="UserInterface.__activateNumbersViewer"></a> |
|
1360 <h4>UserInterface.__activateNumbersViewer</h4> |
|
1361 <b>__activateNumbersViewer</b>(<i></i>) |
|
1362 |
|
1363 <p> |
|
1364 Private slot to handle the activation of the Numbers Viewer. |
|
1365 </p> |
|
1366 <a NAME="UserInterface.__activatePipWidget" ID="UserInterface.__activatePipWidget"></a> |
|
1367 <h4>UserInterface.__activatePipWidget</h4> |
|
1368 <b>__activatePipWidget</b>(<i></i>) |
|
1369 |
|
1370 <p> |
|
1371 Private slot to handle the activation of the PyPI manager widget. |
|
1372 </p> |
|
1373 <a NAME="UserInterface.__activateProjectBrowser" ID="UserInterface.__activateProjectBrowser"></a> |
|
1374 <h4>UserInterface.__activateProjectBrowser</h4> |
|
1375 <b>__activateProjectBrowser</b>(<i></i>) |
|
1376 |
|
1377 <p> |
|
1378 Private slot to handle the activation of the project browser. |
|
1379 </p> |
|
1380 <a NAME="UserInterface.__activateShell" ID="UserInterface.__activateShell"></a> |
|
1381 <h4>UserInterface.__activateShell</h4> |
|
1382 <b>__activateShell</b>(<i></i>) |
|
1383 |
|
1384 <p> |
|
1385 Private slot to handle the activation of the Shell window. |
|
1386 </p> |
|
1387 <a NAME="UserInterface.__activateSymbolsViewer" ID="UserInterface.__activateSymbolsViewer"></a> |
|
1388 <h4>UserInterface.__activateSymbolsViewer</h4> |
|
1389 <b>__activateSymbolsViewer</b>(<i></i>) |
|
1390 |
|
1391 <p> |
|
1392 Private slot to handle the activation of the Symbols Viewer. |
|
1393 </p> |
|
1394 <a NAME="UserInterface.__activateTaskViewer" ID="UserInterface.__activateTaskViewer"></a> |
|
1395 <h4>UserInterface.__activateTaskViewer</h4> |
|
1396 <b>__activateTaskViewer</b>(<i></i>) |
|
1397 |
|
1398 <p> |
|
1399 Private slot to handle the activation of the Task Viewer. |
|
1400 </p> |
|
1401 <a NAME="UserInterface.__activateTemplateViewer" ID="UserInterface.__activateTemplateViewer"></a> |
|
1402 <h4>UserInterface.__activateTemplateViewer</h4> |
|
1403 <b>__activateTemplateViewer</b>(<i></i>) |
|
1404 |
|
1405 <p> |
|
1406 Private slot to handle the activation of the Template Viewer. |
|
1407 </p> |
|
1408 <a NAME="UserInterface.__activateVcsStatusList" ID="UserInterface.__activateVcsStatusList"></a> |
|
1409 <h4>UserInterface.__activateVcsStatusList</h4> |
|
1410 <b>__activateVcsStatusList</b>(<i></i>) |
|
1411 |
|
1412 <p> |
|
1413 Private slot to activate the VCS Status List. |
|
1414 </p> |
|
1415 <a NAME="UserInterface.__activateViewProfile" ID="UserInterface.__activateViewProfile"></a> |
|
1416 <h4>UserInterface.__activateViewProfile</h4> |
|
1417 <b>__activateViewProfile</b>(<i>name, save=True</i>) |
|
1418 |
|
1419 <p> |
|
1420 Private slot to activate a view profile. |
|
1421 </p> |
|
1422 <dl> |
|
1423 |
|
1424 <dt><i>name</i></dt> |
|
1425 <dd> |
|
1426 name of the profile to be activated (string) |
|
1427 </dd> |
|
1428 <dt><i>save</i></dt> |
|
1429 <dd> |
|
1430 flag indicating that the current profile should |
|
1431 be saved (boolean) |
|
1432 </dd> |
|
1433 </dl> |
|
1434 <a NAME="UserInterface.__activateViewmanager" ID="UserInterface.__activateViewmanager"></a> |
|
1435 <h4>UserInterface.__activateViewmanager</h4> |
|
1436 <b>__activateViewmanager</b>(<i></i>) |
|
1437 |
|
1438 <p> |
|
1439 Private slot to handle the activation of the current editor. |
|
1440 </p> |
|
1441 <a NAME="UserInterface.__assistant" ID="UserInterface.__assistant"></a> |
|
1442 <h4>UserInterface.__assistant</h4> |
|
1443 <b>__assistant</b>(<i>home=None</i>) |
|
1444 |
|
1445 <p> |
|
1446 Private slot to start the Qt-Assistant executable. |
|
1447 </p> |
|
1448 <dl> |
|
1449 |
|
1450 <dt><i>home</i> (str)</dt> |
|
1451 <dd> |
|
1452 full pathname of a file to display |
|
1453 </dd> |
|
1454 </dl> |
|
1455 <a NAME="UserInterface.__checkActions" ID="UserInterface.__checkActions"></a> |
|
1456 <h4>UserInterface.__checkActions</h4> |
|
1457 <b>__checkActions</b>(<i>editor</i>) |
|
1458 |
|
1459 <p> |
|
1460 Private slot to check some actions for their enable/disable status. |
|
1461 </p> |
|
1462 <dl> |
|
1463 |
|
1464 <dt><i>editor</i></dt> |
|
1465 <dd> |
|
1466 editor window |
|
1467 </dd> |
|
1468 </dl> |
|
1469 <a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a> |
|
1470 <h4>UserInterface.__chmViewer</h4> |
|
1471 <b>__chmViewer</b>(<i>home=None</i>) |
|
1472 |
|
1473 <p> |
|
1474 Private slot to start the win help viewer to show *.chm files. |
|
1475 </p> |
|
1476 <dl> |
|
1477 |
|
1478 <dt><i>home</i></dt> |
|
1479 <dd> |
|
1480 full pathname of a file to display (string) |
|
1481 </dd> |
|
1482 </dl> |
|
1483 <a NAME="UserInterface.__clearPrivateData" ID="UserInterface.__clearPrivateData"></a> |
|
1484 <h4>UserInterface.__clearPrivateData</h4> |
|
1485 <b>__clearPrivateData</b>(<i></i>) |
|
1486 |
|
1487 <p> |
|
1488 Private slot to clear the private data lists. |
|
1489 </p> |
|
1490 <a NAME="UserInterface.__commitData" ID="UserInterface.__commitData"></a> |
|
1491 <h4>UserInterface.__commitData</h4> |
|
1492 <b>__commitData</b>(<i>manager: QSessionManager</i>) |
|
1493 |
|
1494 <p> |
|
1495 Private slot to commit unsaved data when instructed by the desktop |
|
1496 session manager. |
|
1497 </p> |
|
1498 <dl> |
|
1499 |
|
1500 <dt><i>manager</i> (QSessionManager)</dt> |
|
1501 <dd> |
|
1502 reference to the desktop session manager |
|
1503 </dd> |
|
1504 </dl> |
|
1505 <a NAME="UserInterface.__compareFiles" ID="UserInterface.__compareFiles"></a> |
|
1506 <h4>UserInterface.__compareFiles</h4> |
|
1507 <b>__compareFiles</b>(<i></i>) |
|
1508 |
|
1509 <p> |
|
1510 Private slot to handle the Compare Files dialog. |
|
1511 </p> |
|
1512 <a NAME="UserInterface.__compareFilesSbs" ID="UserInterface.__compareFilesSbs"></a> |
|
1513 <h4>UserInterface.__compareFilesSbs</h4> |
|
1514 <b>__compareFilesSbs</b>(<i></i>) |
|
1515 |
|
1516 <p> |
|
1517 Private slot to handle the Compare Files dialog. |
|
1518 </p> |
|
1519 <a NAME="UserInterface.__configShortcuts" ID="UserInterface.__configShortcuts"></a> |
|
1520 <h4>UserInterface.__configShortcuts</h4> |
|
1521 <b>__configShortcuts</b>(<i></i>) |
|
1522 |
|
1523 <p> |
|
1524 Private slot to configure the keyboard shortcuts. |
|
1525 </p> |
|
1526 <a NAME="UserInterface.__configToolBars" ID="UserInterface.__configToolBars"></a> |
|
1527 <h4>UserInterface.__configToolBars</h4> |
|
1528 <b>__configToolBars</b>(<i></i>) |
|
1529 |
|
1530 <p> |
|
1531 Private slot to configure the various toolbars. |
|
1532 </p> |
|
1533 <a NAME="UserInterface.__configViewProfiles" ID="UserInterface.__configViewProfiles"></a> |
|
1534 <h4>UserInterface.__configViewProfiles</h4> |
|
1535 <b>__configViewProfiles</b>(<i></i>) |
|
1536 |
|
1537 <p> |
|
1538 Private slot to configure the various view profiles. |
|
1539 </p> |
|
1540 <a NAME="UserInterface.__connectToWebBrowser" ID="UserInterface.__connectToWebBrowser"></a> |
|
1541 <h4>UserInterface.__connectToWebBrowser</h4> |
|
1542 <b>__connectToWebBrowser</b>(<i>process</i>) |
|
1543 |
|
1544 <p> |
|
1545 Private method to connect to a started web browser. |
|
1546 </p> |
|
1547 <dl> |
|
1548 |
|
1549 <dt><i>process</i> (QProcess)</dt> |
|
1550 <dd> |
|
1551 reference to the started web browser process |
|
1552 </dd> |
|
1553 </dl> |
|
1554 <dl> |
|
1555 <dt>Return:</dt> |
|
1556 <dd> |
|
1557 error indication (1 = connection not possible, 0 = ok, |
|
1558 -1 = server exited with an error code) |
|
1559 </dd> |
|
1560 </dl> |
|
1561 <dl> |
|
1562 <dt>Return Type:</dt> |
|
1563 <dd> |
|
1564 int |
|
1565 </dd> |
|
1566 </dl> |
|
1567 <a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a> |
|
1568 <h4>UserInterface.__createDockWindow</h4> |
|
1569 <b>__createDockWindow</b>(<i>name</i>) |
|
1570 |
|
1571 <p> |
|
1572 Private method to create a dock window with common properties. |
|
1573 </p> |
|
1574 <dl> |
|
1575 |
|
1576 <dt><i>name</i></dt> |
|
1577 <dd> |
|
1578 object name of the new dock window (string) |
|
1579 </dd> |
|
1580 </dl> |
|
1581 <dl> |
|
1582 <dt>Return:</dt> |
|
1583 <dd> |
|
1584 the generated dock window (QDockWindow) |
|
1585 </dd> |
|
1586 </dl> |
|
1587 <a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a> |
|
1588 <h4>UserInterface.__createLayout</h4> |
|
1589 <b>__createLayout</b>(<i></i>) |
|
1590 |
|
1591 <p> |
|
1592 Private method to create the layout of the various windows. |
|
1593 </p> |
|
1594 <dl> |
|
1595 |
|
1596 <dt>Raises <b>ValueError</b>:</dt> |
|
1597 <dd> |
|
1598 raised to indicate an invalid layout type |
|
1599 </dd> |
|
1600 </dl> |
|
1601 <a NAME="UserInterface.__createObjects" ID="UserInterface.__createObjects"></a> |
|
1602 <h4>UserInterface.__createObjects</h4> |
|
1603 <b>__createObjects</b>(<i></i>) |
|
1604 |
|
1605 <p> |
|
1606 Private method to create the various application objects. |
|
1607 </p> |
|
1608 <a NAME="UserInterface.__createSidebarsLayout" ID="UserInterface.__createSidebarsLayout"></a> |
|
1609 <h4>UserInterface.__createSidebarsLayout</h4> |
|
1610 <b>__createSidebarsLayout</b>(<i></i>) |
|
1611 |
|
1612 <p> |
|
1613 Private method to create the Sidebars layout. |
|
1614 </p> |
|
1615 <a NAME="UserInterface.__createTestingDialog" ID="UserInterface.__createTestingDialog"></a> |
|
1616 <h4>UserInterface.__createTestingDialog</h4> |
|
1617 <b>__createTestingDialog</b>(<i></i>) |
|
1618 |
|
1619 <p> |
|
1620 Private slot to generate the testing dialog on demand. |
|
1621 </p> |
|
1622 <a NAME="UserInterface.__createToolboxesLayout" ID="UserInterface.__createToolboxesLayout"></a> |
|
1623 <h4>UserInterface.__createToolboxesLayout</h4> |
|
1624 <b>__createToolboxesLayout</b>(<i></i>) |
|
1625 |
|
1626 <p> |
|
1627 Private method to create the Toolboxes layout. |
|
1628 </p> |
|
1629 <a NAME="UserInterface.__customViewer" ID="UserInterface.__customViewer"></a> |
|
1630 <h4>UserInterface.__customViewer</h4> |
|
1631 <b>__customViewer</b>(<i>home=None</i>) |
|
1632 |
|
1633 <p> |
|
1634 Private slot to start a custom viewer. |
|
1635 </p> |
|
1636 <dl> |
|
1637 |
|
1638 <dt><i>home</i></dt> |
|
1639 <dd> |
|
1640 full pathname of a file to display (string) |
|
1641 </dd> |
|
1642 </dl> |
|
1643 <a NAME="UserInterface.__debuggingDone" ID="UserInterface.__debuggingDone"></a> |
|
1644 <h4>UserInterface.__debuggingDone</h4> |
|
1645 <b>__debuggingDone</b>(<i></i>) |
|
1646 |
|
1647 <p> |
|
1648 Private slot to handle the end of a debugging session. |
|
1649 </p> |
|
1650 <a NAME="UserInterface.__debuggingStarted" ID="UserInterface.__debuggingStarted"></a> |
|
1651 <h4>UserInterface.__debuggingStarted</h4> |
|
1652 <b>__debuggingStarted</b>(<i></i>) |
|
1653 |
|
1654 <p> |
|
1655 Private slot to handle the start of a debugging session. |
|
1656 </p> |
|
1657 <a NAME="UserInterface.__deinstallPlugin" ID="UserInterface.__deinstallPlugin"></a> |
|
1658 <h4>UserInterface.__deinstallPlugin</h4> |
|
1659 <b>__deinstallPlugin</b>(<i></i>) |
|
1660 |
|
1661 <p> |
|
1662 Private slot to show a dialog to uninstall a plugin. |
|
1663 </p> |
|
1664 <a NAME="UserInterface.__deleteCrashSession" ID="UserInterface.__deleteCrashSession"></a> |
|
1665 <h4>UserInterface.__deleteCrashSession</h4> |
|
1666 <b>__deleteCrashSession</b>(<i></i>) |
|
1667 |
|
1668 <p> |
|
1669 Private slot to delete the crash session file. |
|
1670 </p> |
|
1671 <a NAME="UserInterface.__designer" ID="UserInterface.__designer"></a> |
|
1672 <h4>UserInterface.__designer</h4> |
|
1673 <b>__designer</b>(<i>fn=None</i>) |
|
1674 |
|
1675 <p> |
|
1676 Private slot to start the Qt-Designer executable. |
|
1677 </p> |
|
1678 <dl> |
|
1679 |
|
1680 <dt><i>fn</i> (str)</dt> |
|
1681 <dd> |
|
1682 filename of the form to be opened |
|
1683 </dd> |
|
1684 </dl> |
|
1685 <a NAME="UserInterface.__editPixmap" ID="UserInterface.__editPixmap"></a> |
|
1686 <h4>UserInterface.__editPixmap</h4> |
|
1687 <b>__editPixmap</b>(<i>fn=""</i>) |
|
1688 |
|
1689 <p> |
|
1690 Private slot to show a pixmap in a dialog. |
|
1691 </p> |
|
1692 <dl> |
|
1693 |
|
1694 <dt><i>fn</i></dt> |
|
1695 <dd> |
|
1696 filename of the file to show (string) |
|
1697 </dd> |
|
1698 </dl> |
|
1699 <a NAME="UserInterface.__editorOpened" ID="UserInterface.__editorOpened"></a> |
|
1700 <h4>UserInterface.__editorOpened</h4> |
|
1701 <b>__editorOpened</b>(<i>fn</i>) |
|
1702 |
|
1703 <p> |
|
1704 Private slot to handle the editorOpened signal. |
|
1705 </p> |
|
1706 <dl> |
|
1707 |
|
1708 <dt><i>fn</i></dt> |
|
1709 <dd> |
|
1710 filename of the opened editor (string) |
|
1711 </dd> |
|
1712 </dl> |
|
1713 <a NAME="UserInterface.__exportPreferences" ID="UserInterface.__exportPreferences"></a> |
|
1714 <h4>UserInterface.__exportPreferences</h4> |
|
1715 <b>__exportPreferences</b>(<i></i>) |
|
1716 |
|
1717 <p> |
|
1718 Private slot to export the current preferences. |
|
1719 </p> |
|
1720 <a NAME="UserInterface.__exportShortcuts" ID="UserInterface.__exportShortcuts"></a> |
|
1721 <h4>UserInterface.__exportShortcuts</h4> |
|
1722 <b>__exportShortcuts</b>(<i></i>) |
|
1723 |
|
1724 <p> |
|
1725 Private slot to export the keyboard shortcuts. |
|
1726 </p> |
|
1727 <a NAME="UserInterface.__exportTheme" ID="UserInterface.__exportTheme"></a> |
|
1728 <h4>UserInterface.__exportTheme</h4> |
|
1729 <b>__exportTheme</b>(<i></i>) |
|
1730 |
|
1731 <p> |
|
1732 Private slot to export the current theme to a file. |
|
1733 </p> |
|
1734 <a NAME="UserInterface.__getFloatingGeometry" ID="UserInterface.__getFloatingGeometry"></a> |
|
1735 <h4>UserInterface.__getFloatingGeometry</h4> |
|
1736 <b>__getFloatingGeometry</b>(<i>w</i>) |
|
1737 |
|
1738 <p> |
|
1739 Private method to get the geometry of a floating windows. |
|
1740 </p> |
|
1741 <dl> |
|
1742 |
|
1743 <dt><i>w</i></dt> |
|
1744 <dd> |
|
1745 reference to the widget to be saved (QWidget) |
|
1746 </dd> |
|
1747 </dl> |
|
1748 <dl> |
|
1749 <dt>Return:</dt> |
|
1750 <dd> |
|
1751 list giving the widget's geometry and its visibility |
|
1752 </dd> |
|
1753 </dl> |
|
1754 <a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a> |
|
1755 <h4>UserInterface.__hasErrorLog</h4> |
|
1756 <b>__hasErrorLog</b>(<i></i>) |
|
1757 |
|
1758 <p> |
|
1759 Private method to check, if an error log file exists. |
|
1760 </p> |
|
1761 <dl> |
|
1762 <dt>Return:</dt> |
|
1763 <dd> |
|
1764 flag indicating the existence of an error log file (boolean) |
|
1765 </dd> |
|
1766 </dl> |
|
1767 <a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a> |
|
1768 <h4>UserInterface.__helpViewer</h4> |
|
1769 <b>__helpViewer</b>(<i></i>) |
|
1770 |
|
1771 <p> |
|
1772 Private slot to start an empty help viewer/web browser. |
|
1773 </p> |
|
1774 <a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a> |
|
1775 <h4>UserInterface.__importPreferences</h4> |
|
1776 <b>__importPreferences</b>(<i></i>) |
|
1777 |
|
1778 <p> |
|
1779 Private slot to import preferences. |
|
1780 </p> |
|
1781 <a NAME="UserInterface.__importShortcuts" ID="UserInterface.__importShortcuts"></a> |
|
1782 <h4>UserInterface.__importShortcuts</h4> |
|
1783 <b>__importShortcuts</b>(<i></i>) |
|
1784 |
|
1785 <p> |
|
1786 Private slot to import the keyboard shortcuts. |
|
1787 </p> |
|
1788 <a NAME="UserInterface.__importTheme" ID="UserInterface.__importTheme"></a> |
|
1789 <h4>UserInterface.__importTheme</h4> |
|
1790 <b>__importTheme</b>(<i></i>) |
|
1791 |
|
1792 <p> |
|
1793 Private slot to import a previously exported theme. |
|
1794 </p> |
|
1795 <a NAME="UserInterface.__initActions" ID="UserInterface.__initActions"></a> |
|
1796 <h4>UserInterface.__initActions</h4> |
|
1797 <b>__initActions</b>(<i></i>) |
|
1798 |
|
1799 <p> |
|
1800 Private method to define the user interface actions. |
|
1801 </p> |
|
1802 <a NAME="UserInterface.__initDebugToolbarsLayout" ID="UserInterface.__initDebugToolbarsLayout"></a> |
|
1803 <h4>UserInterface.__initDebugToolbarsLayout</h4> |
|
1804 <b>__initDebugToolbarsLayout</b>(<i></i>) |
|
1805 |
|
1806 <p> |
|
1807 Private slot to initialize the toolbars layout for the debug profile. |
|
1808 </p> |
|
1809 <a NAME="UserInterface.__initEricDocAction" ID="UserInterface.__initEricDocAction"></a> |
|
1810 <h4>UserInterface.__initEricDocAction</h4> |
|
1811 <b>__initEricDocAction</b>(<i></i>) |
|
1812 |
|
1813 <p> |
|
1814 Private slot to initialize the action to show the eric documentation. |
|
1815 </p> |
|
1816 <a NAME="UserInterface.__initExternalToolsActions" ID="UserInterface.__initExternalToolsActions"></a> |
|
1817 <h4>UserInterface.__initExternalToolsActions</h4> |
|
1818 <b>__initExternalToolsActions</b>(<i></i>) |
|
1819 |
|
1820 <p> |
|
1821 Private slot to create actions for the configured external tools. |
|
1822 </p> |
|
1823 <a NAME="UserInterface.__initMenus" ID="UserInterface.__initMenus"></a> |
|
1824 <h4>UserInterface.__initMenus</h4> |
|
1825 <b>__initMenus</b>(<i></i>) |
|
1826 |
|
1827 <p> |
|
1828 Private slot to create the menus. |
|
1829 </p> |
|
1830 <a NAME="UserInterface.__initPySideDocActions" ID="UserInterface.__initPySideDocActions"></a> |
|
1831 <h4>UserInterface.__initPySideDocActions</h4> |
|
1832 <b>__initPySideDocActions</b>(<i></i>) |
|
1833 |
|
1834 <p> |
|
1835 Private slot to initialize the actions to show the PySide |
|
1836 documentation. |
|
1837 </p> |
|
1838 <a NAME="UserInterface.__initPythonDocActions" ID="UserInterface.__initPythonDocActions"></a> |
|
1839 <h4>UserInterface.__initPythonDocActions</h4> |
|
1840 <b>__initPythonDocActions</b>(<i></i>) |
|
1841 |
|
1842 <p> |
|
1843 Private slot to initialize the actions to show the Python |
|
1844 documentation. |
|
1845 </p> |
|
1846 <a NAME="UserInterface.__initQtDocActions" ID="UserInterface.__initQtDocActions"></a> |
|
1847 <h4>UserInterface.__initQtDocActions</h4> |
|
1848 <b>__initQtDocActions</b>(<i></i>) |
|
1849 |
|
1850 <p> |
|
1851 Private slot to initialize the action to show the Qt documentation. |
|
1852 </p> |
|
1853 <a NAME="UserInterface.__initStatusbar" ID="UserInterface.__initStatusbar"></a> |
|
1854 <h4>UserInterface.__initStatusbar</h4> |
|
1855 <b>__initStatusbar</b>(<i></i>) |
|
1856 |
|
1857 <p> |
|
1858 Private slot to set up the status bar. |
|
1859 </p> |
|
1860 <a NAME="UserInterface.__initToolbars" ID="UserInterface.__initToolbars"></a> |
|
1861 <h4>UserInterface.__initToolbars</h4> |
|
1862 <b>__initToolbars</b>(<i></i>) |
|
1863 |
|
1864 <p> |
|
1865 Private slot to create the toolbars. |
|
1866 </p> |
|
1867 <a NAME="UserInterface.__initToolsMenus" ID="UserInterface.__initToolsMenus"></a> |
|
1868 <h4>UserInterface.__initToolsMenus</h4> |
|
1869 <b>__initToolsMenus</b>(<i>menu</i>) |
|
1870 |
|
1871 <p> |
|
1872 Private slot to initialize the various tool menus. |
|
1873 </p> |
|
1874 <dl> |
|
1875 |
|
1876 <dt><i>menu</i> (QMenu)</dt> |
|
1877 <dd> |
|
1878 reference to the parent menu |
|
1879 </dd> |
|
1880 </dl> |
|
1881 <a NAME="UserInterface.__installDownloadedPlugins" ID="UserInterface.__installDownloadedPlugins"></a> |
|
1882 <h4>UserInterface.__installDownloadedPlugins</h4> |
|
1883 <b>__installDownloadedPlugins</b>(<i></i>) |
|
1884 |
|
1885 <p> |
|
1886 Private slot to handle the installation of plugins downloaded via the |
|
1887 plugin repository viewer. |
|
1888 </p> |
|
1889 <a NAME="UserInterface.__installPlugins" ID="UserInterface.__installPlugins"></a> |
|
1890 <h4>UserInterface.__installPlugins</h4> |
|
1891 <b>__installPlugins</b>(<i>pluginFileNames=None</i>) |
|
1892 |
|
1893 <p> |
|
1894 Private slot to show a dialog to install a new plugin. |
|
1895 </p> |
|
1896 <dl> |
|
1897 |
|
1898 <dt><i>pluginFileNames</i></dt> |
|
1899 <dd> |
|
1900 list of plugin files suggested for |
|
1901 installation list of strings |
|
1902 </dd> |
|
1903 </dl> |
|
1904 <a NAME="UserInterface.__ircAutoConnected" ID="UserInterface.__ircAutoConnected"></a> |
|
1905 <h4>UserInterface.__ircAutoConnected</h4> |
|
1906 <b>__ircAutoConnected</b>(<i></i>) |
|
1907 |
|
1908 <p> |
|
1909 Private slot handling the automatic connection of the IRC client. |
|
1910 </p> |
|
1911 <a NAME="UserInterface.__lastEditorClosed" ID="UserInterface.__lastEditorClosed"></a> |
|
1912 <h4>UserInterface.__lastEditorClosed</h4> |
|
1913 <b>__lastEditorClosed</b>(<i></i>) |
|
1914 |
|
1915 <p> |
|
1916 Private slot to handle the lastEditorClosed signal. |
|
1917 </p> |
|
1918 <a NAME="UserInterface.__launchExternalWebBrowser" ID="UserInterface.__launchExternalWebBrowser"></a> |
|
1919 <h4>UserInterface.__launchExternalWebBrowser</h4> |
|
1920 <b>__launchExternalWebBrowser</b>(<i>home, searchWord=None</i>) |
|
1921 |
|
1922 <p> |
|
1923 Private method to start an external web browser and communicate with |
|
1924 it. |
|
1925 </p> |
|
1926 <dl> |
|
1927 |
|
1928 <dt><i>home</i> (str)</dt> |
|
1929 <dd> |
|
1930 filename of file to be shown or URL to be opened |
|
1931 </dd> |
|
1932 <dt><i>searchWord</i> (str)</dt> |
|
1933 <dd> |
|
1934 word to search for |
|
1935 </dd> |
|
1936 </dl> |
|
1937 <dl> |
|
1938 <dt>Return:</dt> |
|
1939 <dd> |
|
1940 flag indicating a successful launch |
|
1941 </dd> |
|
1942 </dl> |
|
1943 <dl> |
|
1944 <dt>Return Type:</dt> |
|
1945 <dd> |
|
1946 bool |
|
1947 </dd> |
|
1948 </dl> |
|
1949 <a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a> |
|
1950 <h4>UserInterface.__linguist</h4> |
|
1951 <b>__linguist</b>(<i>fn=None</i>) |
|
1952 |
|
1953 <p> |
|
1954 Private slot to start the Qt-Linguist executable. |
|
1955 </p> |
|
1956 <dl> |
|
1957 |
|
1958 <dt><i>fn</i> (str)</dt> |
|
1959 <dd> |
|
1960 filename of the translation file to be opened |
|
1961 </dd> |
|
1962 </dl> |
|
1963 <a NAME="UserInterface.__loadSessionFromFile" ID="UserInterface.__loadSessionFromFile"></a> |
|
1964 <h4>UserInterface.__loadSessionFromFile</h4> |
|
1965 <b>__loadSessionFromFile</b>(<i></i>) |
|
1966 |
|
1967 <p> |
|
1968 Private slot to load a session from disk. |
|
1969 </p> |
|
1970 <a NAME="UserInterface.__masterPasswordChanged" ID="UserInterface.__masterPasswordChanged"></a> |
|
1971 <h4>UserInterface.__masterPasswordChanged</h4> |
|
1972 <b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>) |
|
1973 |
|
1974 <p> |
|
1975 Private slot to handle the change of the master password. |
|
1976 </p> |
|
1977 <dl> |
|
1978 |
|
1979 <dt><i>oldPassword</i></dt> |
|
1980 <dd> |
|
1981 current master password (string) |
|
1982 </dd> |
|
1983 <dt><i>newPassword</i></dt> |
|
1984 <dd> |
|
1985 new master password (string) |
|
1986 </dd> |
|
1987 </dl> |
|
1988 <a NAME="UserInterface.__newProject" ID="UserInterface.__newProject"></a> |
|
1989 <h4>UserInterface.__newProject</h4> |
|
1990 <b>__newProject</b>(<i></i>) |
|
1991 |
|
1992 <p> |
|
1993 Private slot to handle the NewProject signal. |
|
1994 </p> |
|
1995 <a NAME="UserInterface.__newWindow" ID="UserInterface.__newWindow"></a> |
|
1996 <h4>UserInterface.__newWindow</h4> |
|
1997 <b>__newWindow</b>(<i></i>) |
|
1998 |
|
1999 <p> |
|
2000 Private slot to start a new instance of eric. |
|
2001 </p> |
|
2002 <a NAME="UserInterface.__onlineStateChanged" ID="UserInterface.__onlineStateChanged"></a> |
|
2003 <h4>UserInterface.__onlineStateChanged</h4> |
|
2004 <b>__onlineStateChanged</b>(<i>online</i>) |
|
2005 |
|
2006 <p> |
|
2007 Private slot handling changes in online state. |
|
2008 </p> |
|
2009 <dl> |
|
2010 |
|
2011 <dt><i>online</i> (bool)</dt> |
|
2012 <dd> |
|
2013 flag indicating the online state |
|
2014 </dd> |
|
2015 </dl> |
|
2016 <a NAME="UserInterface.__openHexEditor" ID="UserInterface.__openHexEditor"></a> |
|
2017 <h4>UserInterface.__openHexEditor</h4> |
|
2018 <b>__openHexEditor</b>(<i>fn=""</i>) |
|
2019 |
|
2020 <p> |
|
2021 Private slot to open the hex editor window. |
|
2022 </p> |
|
2023 <dl> |
|
2024 |
|
2025 <dt><i>fn</i></dt> |
|
2026 <dd> |
|
2027 filename of the file to show (string) |
|
2028 </dd> |
|
2029 </dl> |
|
2030 <a NAME="UserInterface.__openMiniEditor" ID="UserInterface.__openMiniEditor"></a> |
|
2031 <h4>UserInterface.__openMiniEditor</h4> |
|
2032 <b>__openMiniEditor</b>(<i></i>) |
|
2033 |
|
2034 <p> |
|
2035 Private slot to show a mini editor window. |
|
2036 </p> |
|
2037 <a NAME="UserInterface.__openOnStartup" ID="UserInterface.__openOnStartup"></a> |
|
2038 <h4>UserInterface.__openOnStartup</h4> |
|
2039 <b>__openOnStartup</b>(<i>startupType=None</i>) |
|
2040 |
|
2041 <p> |
|
2042 Private method to open the last file, project or multiproject. |
|
2043 </p> |
|
2044 <dl> |
|
2045 |
|
2046 <dt><i>startupType</i></dt> |
|
2047 <dd> |
|
2048 type of startup requested (string, one of |
|
2049 "Nothing", "File", "Project", "MultiProject" or "Session") |
|
2050 </dd> |
|
2051 </dl> |
|
2052 <a NAME="UserInterface.__performUpgrade" ID="UserInterface.__performUpgrade"></a> |
|
2053 <h4>UserInterface.__performUpgrade</h4> |
|
2054 <b>__performUpgrade</b>(<i>upgradeType</i>) |
|
2055 |
|
2056 <p> |
|
2057 Private method to perform the requested upgrade operation. |
|
2058 </p> |
|
2059 <p> |
|
2060 This action needs to shut down eric first, start a non-PyQt application |
|
2061 performing the upgrade of the PyQt packages via pip and restart eric |
|
2062 with the passed arguments. The upgrade process is not visible. |
|
2063 </p> |
|
2064 <dl> |
|
2065 |
|
2066 <dt><i>upgradeType</i> (str)</dt> |
|
2067 <dd> |
|
2068 upgrade operation (one of 'eric', 'ericpyqt', |
|
2069 'pyqt') |
|
2070 </dd> |
|
2071 </dl> |
|
2072 <a NAME="UserInterface.__pluginInstallFinished" ID="UserInterface.__pluginInstallFinished"></a> |
|
2073 <h4>UserInterface.__pluginInstallFinished</h4> |
|
2074 <b>__pluginInstallFinished</b>(<i></i>) |
|
2075 |
|
2076 <p> |
|
2077 Private slot to handle the finishing of the plugin install dialog. |
|
2078 </p> |
|
2079 <a NAME="UserInterface.__pluginsConfigure" ID="UserInterface.__pluginsConfigure"></a> |
|
2080 <h4>UserInterface.__pluginsConfigure</h4> |
|
2081 <b>__pluginsConfigure</b>(<i></i>) |
|
2082 |
|
2083 <p> |
|
2084 Private slot to show the plugin manager configuration page. |
|
2085 </p> |
|
2086 <a NAME="UserInterface.__populateToolbarsMenu" ID="UserInterface.__populateToolbarsMenu"></a> |
|
2087 <h4>UserInterface.__populateToolbarsMenu</h4> |
|
2088 <b>__populateToolbarsMenu</b>(<i>menu</i>) |
|
2089 |
|
2090 <p> |
|
2091 Private method to populate a toolbars menu. |
|
2092 </p> |
|
2093 <dl> |
|
2094 |
|
2095 <dt><i>menu</i></dt> |
|
2096 <dd> |
|
2097 reference to the menu to be populated (QMenu) |
|
2098 </dd> |
|
2099 </dl> |
|
2100 <a NAME="UserInterface.__preferencesChanged" ID="UserInterface.__preferencesChanged"></a> |
|
2101 <h4>UserInterface.__preferencesChanged</h4> |
|
2102 <b>__preferencesChanged</b>(<i></i>) |
|
2103 |
|
2104 <p> |
|
2105 Private slot to handle a change of the preferences. |
|
2106 </p> |
|
2107 <a NAME="UserInterface.__processToolStderr" ID="UserInterface.__processToolStderr"></a> |
|
2108 <h4>UserInterface.__processToolStderr</h4> |
|
2109 <b>__processToolStderr</b>(<i></i>) |
|
2110 |
|
2111 <p> |
|
2112 Private slot to handle the readyReadStderr signal of a tool process. |
|
2113 </p> |
|
2114 <a NAME="UserInterface.__processToolStdout" ID="UserInterface.__processToolStdout"></a> |
|
2115 <h4>UserInterface.__processToolStdout</h4> |
|
2116 <b>__processToolStdout</b>(<i></i>) |
|
2117 |
|
2118 <p> |
|
2119 Private slot to handle the readyReadStdout signal of a tool process. |
|
2120 </p> |
|
2121 <a NAME="UserInterface.__programChange" ID="UserInterface.__programChange"></a> |
|
2122 <h4>UserInterface.__programChange</h4> |
|
2123 <b>__programChange</b>(<i>fn</i>) |
|
2124 |
|
2125 <p> |
|
2126 Private slot to handle the programChange signal. |
|
2127 </p> |
|
2128 <p> |
|
2129 This primarily is here to set the currentProg variable. |
|
2130 </p> |
|
2131 <dl> |
|
2132 |
|
2133 <dt><i>fn</i></dt> |
|
2134 <dd> |
|
2135 filename to be set as current prog (string) |
|
2136 </dd> |
|
2137 </dl> |
|
2138 <a NAME="UserInterface.__projectClosed" ID="UserInterface.__projectClosed"></a> |
|
2139 <h4>UserInterface.__projectClosed</h4> |
|
2140 <b>__projectClosed</b>(<i></i>) |
|
2141 |
|
2142 <p> |
|
2143 Private slot to handle the projectClosed signal. |
|
2144 </p> |
|
2145 <a NAME="UserInterface.__projectOpened" ID="UserInterface.__projectOpened"></a> |
|
2146 <h4>UserInterface.__projectOpened</h4> |
|
2147 <b>__projectOpened</b>(<i></i>) |
|
2148 |
|
2149 <p> |
|
2150 Private slot to handle the projectOpened signal. |
|
2151 </p> |
|
2152 <a NAME="UserInterface.__quit" ID="UserInterface.__quit"></a> |
|
2153 <h4>UserInterface.__quit</h4> |
|
2154 <b>__quit</b>(<i></i>) |
|
2155 |
|
2156 <p> |
|
2157 Private method to quit the application. |
|
2158 </p> |
|
2159 <a NAME="UserInterface.__readCrashSession" ID="UserInterface.__readCrashSession"></a> |
|
2160 <h4>UserInterface.__readCrashSession</h4> |
|
2161 <b>__readCrashSession</b>(<i></i>) |
|
2162 |
|
2163 <p> |
|
2164 Private method to check for and read a crash session. |
|
2165 </p> |
|
2166 <dl> |
|
2167 <dt>Return:</dt> |
|
2168 <dd> |
|
2169 flag indicating a crash session file was found and read |
|
2170 </dd> |
|
2171 </dl> |
|
2172 <dl> |
|
2173 <dt>Return Type:</dt> |
|
2174 <dd> |
|
2175 bool |
|
2176 </dd> |
|
2177 </dl> |
|
2178 <a NAME="UserInterface.__readSession" ID="UserInterface.__readSession"></a> |
|
2179 <h4>UserInterface.__readSession</h4> |
|
2180 <b>__readSession</b>(<i>filename=""</i>) |
|
2181 |
|
2182 <p> |
|
2183 Private slot to read in the session file (.esj or .e5s). |
|
2184 </p> |
|
2185 <dl> |
|
2186 |
|
2187 <dt><i>filename</i> (str)</dt> |
|
2188 <dd> |
|
2189 name of a session file to read |
|
2190 </dd> |
|
2191 </dl> |
|
2192 <dl> |
|
2193 <dt>Return:</dt> |
|
2194 <dd> |
|
2195 flag indicating success |
|
2196 </dd> |
|
2197 </dl> |
|
2198 <dl> |
|
2199 <dt>Return Type:</dt> |
|
2200 <dd> |
|
2201 bool |
|
2202 </dd> |
|
2203 </dl> |
|
2204 <a NAME="UserInterface.__readTasks" ID="UserInterface.__readTasks"></a> |
|
2205 <h4>UserInterface.__readTasks</h4> |
|
2206 <b>__readTasks</b>(<i></i>) |
|
2207 |
|
2208 <p> |
|
2209 Private slot to read in the tasks file (.etj or .e6t). |
|
2210 </p> |
|
2211 <a NAME="UserInterface.__reloadAPIs" ID="UserInterface.__reloadAPIs"></a> |
|
2212 <h4>UserInterface.__reloadAPIs</h4> |
|
2213 <b>__reloadAPIs</b>(<i></i>) |
|
2214 |
|
2215 <p> |
|
2216 Private slot to reload the api information. |
|
2217 </p> |
|
2218 <a NAME="UserInterface.__reportBug" ID="UserInterface.__reportBug"></a> |
|
2219 <h4>UserInterface.__reportBug</h4> |
|
2220 <b>__reportBug</b>(<i></i>) |
|
2221 |
|
2222 <p> |
|
2223 Private slot to handle the Report Bug dialog. |
|
2224 </p> |
|
2225 <a NAME="UserInterface.__requestFeature" ID="UserInterface.__requestFeature"></a> |
|
2226 <h4>UserInterface.__requestFeature</h4> |
|
2227 <b>__requestFeature</b>(<i></i>) |
|
2228 |
|
2229 <p> |
|
2230 Private slot to handle the Feature Request dialog. |
|
2231 </p> |
|
2232 <a NAME="UserInterface.__rerunFailedTests" ID="UserInterface.__rerunFailedTests"></a> |
|
2233 <h4>UserInterface.__rerunFailedTests</h4> |
|
2234 <b>__rerunFailedTests</b>(<i></i>) |
|
2235 |
|
2236 <p> |
|
2237 Private slot to display the testing dialog and rerun all failed tests |
|
2238 of the last run. |
|
2239 </p> |
|
2240 <a NAME="UserInterface.__restart" ID="UserInterface.__restart"></a> |
|
2241 <h4>UserInterface.__restart</h4> |
|
2242 <b>__restart</b>(<i>ask=False</i>) |
|
2243 |
|
2244 <p> |
|
2245 Private method to restart the application. |
|
2246 </p> |
|
2247 <dl> |
|
2248 |
|
2249 <dt><i>ask</i> (bool)</dt> |
|
2250 <dd> |
|
2251 flag indicating to ask the user for permission |
|
2252 </dd> |
|
2253 </dl> |
|
2254 <a NAME="UserInterface.__restartTest" ID="UserInterface.__restartTest"></a> |
|
2255 <h4>UserInterface.__restartTest</h4> |
|
2256 <b>__restartTest</b>(<i></i>) |
|
2257 |
|
2258 <p> |
|
2259 Private slot to display the testing dialog and rerun the last |
|
2260 test run. |
|
2261 </p> |
|
2262 <a NAME="UserInterface.__saveCurrentViewProfile" ID="UserInterface.__saveCurrentViewProfile"></a> |
|
2263 <h4>UserInterface.__saveCurrentViewProfile</h4> |
|
2264 <b>__saveCurrentViewProfile</b>(<i>save</i>) |
|
2265 |
|
2266 <p> |
|
2267 Private slot to save the window geometries of the active profile. |
|
2268 </p> |
|
2269 <dl> |
|
2270 |
|
2271 <dt><i>save</i></dt> |
|
2272 <dd> |
|
2273 flag indicating that the current profile should |
|
2274 be saved (boolean) |
|
2275 </dd> |
|
2276 </dl> |
|
2277 <a NAME="UserInterface.__saveSessionToFile" ID="UserInterface.__saveSessionToFile"></a> |
|
2278 <h4>UserInterface.__saveSessionToFile</h4> |
|
2279 <b>__saveSessionToFile</b>(<i></i>) |
|
2280 |
|
2281 <p> |
|
2282 Private slot to save a session to disk. |
|
2283 </p> |
|
2284 <a NAME="UserInterface.__setEditProfile" ID="UserInterface.__setEditProfile"></a> |
|
2285 <h4>UserInterface.__setEditProfile</h4> |
|
2286 <b>__setEditProfile</b>(<i>save=True</i>) |
|
2287 |
|
2288 <p> |
|
2289 Private slot to activate the edit view profile. |
|
2290 </p> |
|
2291 <dl> |
|
2292 |
|
2293 <dt><i>save</i></dt> |
|
2294 <dd> |
|
2295 flag indicating that the current profile should |
|
2296 be saved (boolean) |
|
2297 </dd> |
|
2298 </dl> |
|
2299 <a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a> |
|
2300 <h4>UserInterface.__setWindowCaption</h4> |
|
2301 <b>__setWindowCaption</b>(<i>editor=None, project=None</i>) |
|
2302 |
|
2303 <p> |
|
2304 Private method to set the caption of the Main Window. |
|
2305 </p> |
|
2306 <dl> |
|
2307 |
|
2308 <dt><i>editor</i></dt> |
|
2309 <dd> |
|
2310 filename to be displayed (string) |
|
2311 </dd> |
|
2312 <dt><i>project</i></dt> |
|
2313 <dd> |
|
2314 project name to be displayed (string) |
|
2315 </dd> |
|
2316 </dl> |
|
2317 <a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a> |
|
2318 <h4>UserInterface.__setupDockWindow</h4> |
|
2319 <b>__setupDockWindow</b>(<i>dock, where, widget, caption</i>) |
|
2320 |
|
2321 <p> |
|
2322 Private method to configure the dock window created with |
|
2323 __createDockWindow(). |
|
2324 </p> |
|
2325 <dl> |
|
2326 |
|
2327 <dt><i>dock</i></dt> |
|
2328 <dd> |
|
2329 the dock window (QDockWindow) |
|
2330 </dd> |
|
2331 <dt><i>where</i></dt> |
|
2332 <dd> |
|
2333 dock area to be docked to (Qt.DockWidgetArea) |
|
2334 </dd> |
|
2335 <dt><i>widget</i></dt> |
|
2336 <dd> |
|
2337 widget to be shown in the dock window (QWidget) |
|
2338 </dd> |
|
2339 <dt><i>caption</i></dt> |
|
2340 <dd> |
|
2341 caption of the dock window (string) |
|
2342 </dd> |
|
2343 </dl> |
|
2344 <a NAME="UserInterface.__showCertificatesDialog" ID="UserInterface.__showCertificatesDialog"></a> |
|
2345 <h4>UserInterface.__showCertificatesDialog</h4> |
|
2346 <b>__showCertificatesDialog</b>(<i></i>) |
|
2347 |
|
2348 <p> |
|
2349 Private slot to show the certificates management dialog. |
|
2350 </p> |
|
2351 <a NAME="UserInterface.__showEricDoc" ID="UserInterface.__showEricDoc"></a> |
|
2352 <h4>UserInterface.__showEricDoc</h4> |
|
2353 <b>__showEricDoc</b>(<i></i>) |
|
2354 |
|
2355 <p> |
|
2356 Private slot to show the Eric documentation. |
|
2357 </p> |
|
2358 <a NAME="UserInterface.__showErrorLog" ID="UserInterface.__showErrorLog"></a> |
|
2359 <h4>UserInterface.__showErrorLog</h4> |
|
2360 <b>__showErrorLog</b>(<i></i>) |
|
2361 |
|
2362 <p> |
|
2363 Private slot to show the most recent error log message. |
|
2364 </p> |
|
2365 <a NAME="UserInterface.__showExternalTools" ID="UserInterface.__showExternalTools"></a> |
|
2366 <h4>UserInterface.__showExternalTools</h4> |
|
2367 <b>__showExternalTools</b>(<i></i>) |
|
2368 |
|
2369 <p> |
|
2370 Private slot to display a dialog show a list of external tools used |
|
2371 by eric. |
|
2372 </p> |
|
2373 <a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a> |
|
2374 <h4>UserInterface.__showExtrasMenu</h4> |
|
2375 <b>__showExtrasMenu</b>(<i></i>) |
|
2376 |
|
2377 <p> |
|
2378 Private slot to display the Extras menu. |
|
2379 </p> |
|
2380 <a NAME="UserInterface.__showFileMenu" ID="UserInterface.__showFileMenu"></a> |
|
2381 <h4>UserInterface.__showFileMenu</h4> |
|
2382 <b>__showFileMenu</b>(<i></i>) |
|
2383 |
|
2384 <p> |
|
2385 Private slot to display the File menu. |
|
2386 </p> |
|
2387 <a NAME="UserInterface.__showHelpMenu" ID="UserInterface.__showHelpMenu"></a> |
|
2388 <h4>UserInterface.__showHelpMenu</h4> |
|
2389 <b>__showHelpMenu</b>(<i></i>) |
|
2390 |
|
2391 <p> |
|
2392 Private slot to display the Help menu. |
|
2393 </p> |
|
2394 <a NAME="UserInterface.__showInstallInfo" ID="UserInterface.__showInstallInfo"></a> |
|
2395 <h4>UserInterface.__showInstallInfo</h4> |
|
2396 <b>__showInstallInfo</b>(<i></i>) |
|
2397 |
|
2398 <p> |
|
2399 Private slot to show a dialog containing information about the |
|
2400 installation process. |
|
2401 </p> |
|
2402 <a NAME="UserInterface.__showNext" ID="UserInterface.__showNext"></a> |
|
2403 <h4>UserInterface.__showNext</h4> |
|
2404 <b>__showNext</b>(<i></i>) |
|
2405 |
|
2406 <p> |
|
2407 Private slot used to show the next tab or file. |
|
2408 </p> |
|
2409 <a NAME="UserInterface.__showPixmap" ID="UserInterface.__showPixmap"></a> |
|
2410 <h4>UserInterface.__showPixmap</h4> |
|
2411 <b>__showPixmap</b>(<i>fn</i>) |
|
2412 |
|
2413 <p> |
|
2414 Private slot to show a pixmap in a dialog. |
|
2415 </p> |
|
2416 <dl> |
|
2417 |
|
2418 <dt><i>fn</i></dt> |
|
2419 <dd> |
|
2420 filename of the file to show (string) |
|
2421 </dd> |
|
2422 </dl> |
|
2423 <a NAME="UserInterface.__showPluginInfo" ID="UserInterface.__showPluginInfo"></a> |
|
2424 <h4>UserInterface.__showPluginInfo</h4> |
|
2425 <b>__showPluginInfo</b>(<i></i>) |
|
2426 |
|
2427 <p> |
|
2428 Private slot to show the plugin info dialog. |
|
2429 </p> |
|
2430 <a NAME="UserInterface.__showPluginToolsMenu" ID="UserInterface.__showPluginToolsMenu"></a> |
|
2431 <h4>UserInterface.__showPluginToolsMenu</h4> |
|
2432 <b>__showPluginToolsMenu</b>(<i></i>) |
|
2433 |
|
2434 <p> |
|
2435 Private slot to show the Plugin Tools menu. |
|
2436 </p> |
|
2437 <a NAME="UserInterface.__showPluginsAvailable" ID="UserInterface.__showPluginsAvailable"></a> |
|
2438 <h4>UserInterface.__showPluginsAvailable</h4> |
|
2439 <b>__showPluginsAvailable</b>(<i></i>) |
|
2440 |
|
2441 <p> |
|
2442 Private slot to show the plugins available for download. |
|
2443 </p> |
|
2444 <a NAME="UserInterface.__showPrevious" ID="UserInterface.__showPrevious"></a> |
|
2445 <h4>UserInterface.__showPrevious</h4> |
|
2446 <b>__showPrevious</b>(<i></i>) |
|
2447 |
|
2448 <p> |
|
2449 Private slot used to show the previous tab or file. |
|
2450 </p> |
|
2451 <a NAME="UserInterface.__showPyQtDoc" ID="UserInterface.__showPyQtDoc"></a> |
|
2452 <h4>UserInterface.__showPyQtDoc</h4> |
|
2453 <b>__showPyQtDoc</b>(<i>variant=5</i>) |
|
2454 |
|
2455 <p> |
|
2456 Private slot to show the PyQt5/6 documentation. |
|
2457 </p> |
|
2458 <dl> |
|
2459 |
|
2460 <dt><i>variant</i> (int or str)</dt> |
|
2461 <dd> |
|
2462 PyQt variant to show documentation for (5 or 6) |
|
2463 </dd> |
|
2464 </dl> |
|
2465 <a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a> |
|
2466 <h4>UserInterface.__showPySideDoc</h4> |
|
2467 <b>__showPySideDoc</b>(<i>variant=2</i>) |
|
2468 |
|
2469 <p> |
|
2470 Private slot to show the PySide2/PySide6 documentation. |
|
2471 </p> |
|
2472 <dl> |
|
2473 |
|
2474 <dt><i>variant</i> (int or str)</dt> |
|
2475 <dd> |
|
2476 PySide variant (2 or 6) |
|
2477 </dd> |
|
2478 </dl> |
|
2479 <a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a> |
|
2480 <h4>UserInterface.__showPythonDoc</h4> |
|
2481 <b>__showPythonDoc</b>(<i></i>) |
|
2482 |
|
2483 <p> |
|
2484 Private slot to show the Python 3 documentation. |
|
2485 </p> |
|
2486 <a NAME="UserInterface.__showQtDoc" ID="UserInterface.__showQtDoc"></a> |
|
2487 <h4>UserInterface.__showQtDoc</h4> |
|
2488 <b>__showQtDoc</b>(<i>version</i>) |
|
2489 |
|
2490 <p> |
|
2491 Private method to show the Qt documentation. |
|
2492 </p> |
|
2493 <dl> |
|
2494 |
|
2495 <dt><i>version</i> (int)</dt> |
|
2496 <dd> |
|
2497 Qt version to show documentation for |
|
2498 </dd> |
|
2499 </dl> |
|
2500 <a NAME="UserInterface.__showSettingsMenu" ID="UserInterface.__showSettingsMenu"></a> |
|
2501 <h4>UserInterface.__showSettingsMenu</h4> |
|
2502 <b>__showSettingsMenu</b>(<i></i>) |
|
2503 |
|
2504 <p> |
|
2505 Private slot to show the Settings menu. |
|
2506 </p> |
|
2507 <a NAME="UserInterface.__showSubWindowMenu" ID="UserInterface.__showSubWindowMenu"></a> |
|
2508 <h4>UserInterface.__showSubWindowMenu</h4> |
|
2509 <b>__showSubWindowMenu</b>(<i></i>) |
|
2510 |
|
2511 <p> |
|
2512 Private slot to display the Window menu of the Window menu. |
|
2513 </p> |
|
2514 <a NAME="UserInterface.__showSvg" ID="UserInterface.__showSvg"></a> |
|
2515 <h4>UserInterface.__showSvg</h4> |
|
2516 <b>__showSvg</b>(<i>fn</i>) |
|
2517 |
|
2518 <p> |
|
2519 Private slot to show a SVG file in a dialog. |
|
2520 </p> |
|
2521 <dl> |
|
2522 |
|
2523 <dt><i>fn</i></dt> |
|
2524 <dd> |
|
2525 filename of the file to show (string) |
|
2526 </dd> |
|
2527 </dl> |
|
2528 <a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a> |
|
2529 <h4>UserInterface.__showSystemEmailClient</h4> |
|
2530 <b>__showSystemEmailClient</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>) |
|
2531 |
|
2532 <p> |
|
2533 Private slot to show the system email dialog. |
|
2534 </p> |
|
2535 <dl> |
|
2536 |
|
2537 <dt><i>mode</i></dt> |
|
2538 <dd> |
|
2539 mode of the email dialog (string, "bug" or "feature") |
|
2540 </dd> |
|
2541 <dt><i>attachFile</i></dt> |
|
2542 <dd> |
|
2543 name of a file to put into the body of the |
|
2544 email (string) |
|
2545 </dd> |
|
2546 <dt><i>deleteAttachFile</i></dt> |
|
2547 <dd> |
|
2548 flag indicating to delete the file after |
|
2549 it has been read (boolean) |
|
2550 </dd> |
|
2551 </dl> |
|
2552 <a NAME="UserInterface.__showToolGroupsMenu" ID="UserInterface.__showToolGroupsMenu"></a> |
|
2553 <h4>UserInterface.__showToolGroupsMenu</h4> |
|
2554 <b>__showToolGroupsMenu</b>(<i></i>) |
|
2555 |
|
2556 <p> |
|
2557 Private slot to display the Tool Groups menu. |
|
2558 </p> |
|
2559 <a NAME="UserInterface.__showToolbarsMenu" ID="UserInterface.__showToolbarsMenu"></a> |
|
2560 <h4>UserInterface.__showToolbarsMenu</h4> |
|
2561 <b>__showToolbarsMenu</b>(<i></i>) |
|
2562 |
|
2563 <p> |
|
2564 Private slot to display the Toolbars menu. |
|
2565 </p> |
|
2566 <a NAME="UserInterface.__showUml" ID="UserInterface.__showUml"></a> |
|
2567 <h4>UserInterface.__showUml</h4> |
|
2568 <b>__showUml</b>(<i>fn</i>) |
|
2569 |
|
2570 <p> |
|
2571 Private slot to show an eric graphics file in a dialog. |
|
2572 </p> |
|
2573 <dl> |
|
2574 |
|
2575 <dt><i>fn</i> (str)</dt> |
|
2576 <dd> |
|
2577 name of the file to be shown |
|
2578 </dd> |
|
2579 </dl> |
|
2580 <a NAME="UserInterface.__showUserToolsMenu" ID="UserInterface.__showUserToolsMenu"></a> |
|
2581 <h4>UserInterface.__showUserToolsMenu</h4> |
|
2582 <b>__showUserToolsMenu</b>(<i></i>) |
|
2583 |
|
2584 <p> |
|
2585 Private slot to display the User Tools menu. |
|
2586 </p> |
|
2587 <a NAME="UserInterface.__showVersions" ID="UserInterface.__showVersions"></a> |
|
2588 <h4>UserInterface.__showVersions</h4> |
|
2589 <b>__showVersions</b>(<i></i>) |
|
2590 |
|
2591 <p> |
|
2592 Private slot to handle the Versions dialog. |
|
2593 </p> |
|
2594 <a NAME="UserInterface.__showWindowMenu" ID="UserInterface.__showWindowMenu"></a> |
|
2595 <h4>UserInterface.__showWindowMenu</h4> |
|
2596 <b>__showWindowMenu</b>(<i></i>) |
|
2597 |
|
2598 <p> |
|
2599 Private slot to display the Window menu. |
|
2600 </p> |
|
2601 <a NAME="UserInterface.__showWizardsMenu" ID="UserInterface.__showWizardsMenu"></a> |
|
2602 <h4>UserInterface.__showWizardsMenu</h4> |
|
2603 <b>__showWizardsMenu</b>(<i></i>) |
|
2604 |
|
2605 <p> |
|
2606 Private slot to display the Wizards menu. |
|
2607 </p> |
|
2608 <a NAME="UserInterface.__shutdown" ID="UserInterface.__shutdown"></a> |
|
2609 <h4>UserInterface.__shutdown</h4> |
|
2610 <b>__shutdown</b>(<i></i>) |
|
2611 |
|
2612 <p> |
|
2613 Private method to perform all necessary steps to close down the IDE. |
|
2614 </p> |
|
2615 <dl> |
|
2616 <dt>Return:</dt> |
|
2617 <dd> |
|
2618 flag indicating success |
|
2619 </dd> |
|
2620 </dl> |
|
2621 <a NAME="UserInterface.__snapshot" ID="UserInterface.__snapshot"></a> |
|
2622 <h4>UserInterface.__snapshot</h4> |
|
2623 <b>__snapshot</b>(<i></i>) |
|
2624 |
|
2625 <p> |
|
2626 Private slot to start the snapshot tool. |
|
2627 </p> |
|
2628 <a NAME="UserInterface.__sqlBrowser" ID="UserInterface.__sqlBrowser"></a> |
|
2629 <h4>UserInterface.__sqlBrowser</h4> |
|
2630 <b>__sqlBrowser</b>(<i></i>) |
|
2631 |
|
2632 <p> |
|
2633 Private slot to start the SQL browser tool. |
|
2634 </p> |
|
2635 <a NAME="UserInterface.__sslErrors" ID="UserInterface.__sslErrors"></a> |
|
2636 <h4>UserInterface.__sslErrors</h4> |
|
2637 <b>__sslErrors</b>(<i>reply, errors</i>) |
|
2638 |
|
2639 <p> |
|
2640 Private slot to handle SSL errors. |
|
2641 </p> |
|
2642 <dl> |
|
2643 |
|
2644 <dt><i>reply</i></dt> |
|
2645 <dd> |
|
2646 reference to the reply object (QNetworkReply) |
|
2647 </dd> |
|
2648 <dt><i>errors</i></dt> |
|
2649 <dd> |
|
2650 list of SSL errors (list of QSslError) |
|
2651 </dd> |
|
2652 </dl> |
|
2653 <a NAME="UserInterface.__startTestProject" ID="UserInterface.__startTestProject"></a> |
|
2654 <h4>UserInterface.__startTestProject</h4> |
|
2655 <b>__startTestProject</b>(<i></i>) |
|
2656 |
|
2657 <p> |
|
2658 Private slot for displaying the testing dialog and run the test for |
|
2659 the current project. |
|
2660 </p> |
|
2661 <a NAME="UserInterface.__startTestScript" ID="UserInterface.__startTestScript"></a> |
|
2662 <h4>UserInterface.__startTestScript</h4> |
|
2663 <b>__startTestScript</b>(<i>testFile=None</i>) |
|
2664 |
|
2665 <p> |
|
2666 Private slot for displaying the testing dialog and run the current |
|
2667 script. |
|
2668 </p> |
|
2669 <dl> |
|
2670 |
|
2671 <dt><i>testFile</i> (str)</dt> |
|
2672 <dd> |
|
2673 file containing the tests to be run |
|
2674 </dd> |
|
2675 </dl> |
|
2676 <a NAME="UserInterface.__startTesting" ID="UserInterface.__startTesting"></a> |
|
2677 <h4>UserInterface.__startTesting</h4> |
|
2678 <b>__startTesting</b>(<i></i>) |
|
2679 |
|
2680 <p> |
|
2681 Private slot for displaying the testing dialog. |
|
2682 </p> |
|
2683 <a NAME="UserInterface.__startToolProcess" ID="UserInterface.__startToolProcess"></a> |
|
2684 <h4>UserInterface.__startToolProcess</h4> |
|
2685 <b>__startToolProcess</b>(<i>tool</i>) |
|
2686 |
|
2687 <p> |
|
2688 Private slot to start an external tool process. |
|
2689 </p> |
|
2690 <dl> |
|
2691 |
|
2692 <dt><i>tool</i></dt> |
|
2693 <dd> |
|
2694 list of tool entries |
|
2695 </dd> |
|
2696 </dl> |
|
2697 <a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a> |
|
2698 <h4>UserInterface.__startWebBrowser</h4> |
|
2699 <b>__startWebBrowser</b>(<i></i>) |
|
2700 |
|
2701 <p> |
|
2702 Private slot to start the eric web browser. |
|
2703 </p> |
|
2704 <a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a> |
|
2705 <h4>UserInterface.__switchTab</h4> |
|
2706 <b>__switchTab</b>(<i></i>) |
|
2707 |
|
2708 <p> |
|
2709 Private slot used to switch between the current and the previous |
|
2710 current tab. |
|
2711 </p> |
|
2712 <a NAME="UserInterface.__testingStopped" ID="UserInterface.__testingStopped"></a> |
|
2713 <h4>UserInterface.__testingStopped</h4> |
|
2714 <b>__testingStopped</b>(<i></i>) |
|
2715 |
|
2716 <p> |
|
2717 Private slot to handle the end of a test run. |
|
2718 </p> |
|
2719 <a NAME="UserInterface.__toggleBottomSidebar" ID="UserInterface.__toggleBottomSidebar"></a> |
|
2720 <h4>UserInterface.__toggleBottomSidebar</h4> |
|
2721 <b>__toggleBottomSidebar</b>(<i></i>) |
|
2722 |
|
2723 <p> |
|
2724 Private slot to handle the toggle of the bottom sidebar window. |
|
2725 </p> |
|
2726 <a NAME="UserInterface.__toggleHorizontalToolbox" ID="UserInterface.__toggleHorizontalToolbox"></a> |
|
2727 <h4>UserInterface.__toggleHorizontalToolbox</h4> |
|
2728 <b>__toggleHorizontalToolbox</b>(<i></i>) |
|
2729 |
|
2730 <p> |
|
2731 Private slot to handle the toggle of the Horizontal Toolbox window. |
|
2732 </p> |
|
2733 <a NAME="UserInterface.__toggleLeftSidebar" ID="UserInterface.__toggleLeftSidebar"></a> |
|
2734 <h4>UserInterface.__toggleLeftSidebar</h4> |
|
2735 <b>__toggleLeftSidebar</b>(<i></i>) |
|
2736 |
|
2737 <p> |
|
2738 Private slot to handle the toggle of the left sidebar window. |
|
2739 </p> |
|
2740 <a NAME="UserInterface.__toggleLeftToolbox" ID="UserInterface.__toggleLeftToolbox"></a> |
|
2741 <h4>UserInterface.__toggleLeftToolbox</h4> |
|
2742 <b>__toggleLeftToolbox</b>(<i></i>) |
|
2743 |
|
2744 <p> |
|
2745 Private slot to handle the toggle of the Left Toolbox window. |
|
2746 </p> |
|
2747 <a NAME="UserInterface.__toggleRightSidebar" ID="UserInterface.__toggleRightSidebar"></a> |
|
2748 <h4>UserInterface.__toggleRightSidebar</h4> |
|
2749 <b>__toggleRightSidebar</b>(<i></i>) |
|
2750 |
|
2751 <p> |
|
2752 Private slot to handle the toggle of the right sidebar window. |
|
2753 </p> |
|
2754 <a NAME="UserInterface.__toggleRightToolbox" ID="UserInterface.__toggleRightToolbox"></a> |
|
2755 <h4>UserInterface.__toggleRightToolbox</h4> |
|
2756 <b>__toggleRightToolbox</b>(<i></i>) |
|
2757 |
|
2758 <p> |
|
2759 Private slot to handle the toggle of the Right Toolbox window. |
|
2760 </p> |
|
2761 <a NAME="UserInterface.__toggleWindow" ID="UserInterface.__toggleWindow"></a> |
|
2762 <h4>UserInterface.__toggleWindow</h4> |
|
2763 <b>__toggleWindow</b>(<i>w</i>) |
|
2764 |
|
2765 <p> |
|
2766 Private method to toggle a workspace editor window. |
|
2767 </p> |
|
2768 <dl> |
|
2769 |
|
2770 <dt><i>w</i></dt> |
|
2771 <dd> |
|
2772 reference to the workspace editor window |
|
2773 </dd> |
|
2774 </dl> |
|
2775 <dl> |
|
2776 <dt>Return:</dt> |
|
2777 <dd> |
|
2778 flag indicating, if the window was shown (boolean) |
|
2779 </dd> |
|
2780 </dl> |
|
2781 <a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a> |
|
2782 <h4>UserInterface.__toolActionTriggered</h4> |
|
2783 <b>__toolActionTriggered</b>(<i>act</i>) |
|
2784 |
|
2785 <p> |
|
2786 Private slot called by external tools toolbar actions. |
|
2787 </p> |
|
2788 <dl> |
|
2789 |
|
2790 <dt><i>act</i> (QAction)</dt> |
|
2791 <dd> |
|
2792 reference to the action that triggered the slot |
|
2793 </dd> |
|
2794 </dl> |
|
2795 <a NAME="UserInterface.__toolExecute" ID="UserInterface.__toolExecute"></a> |
|
2796 <h4>UserInterface.__toolExecute</h4> |
|
2797 <b>__toolExecute</b>(<i>act</i>) |
|
2798 |
|
2799 <p> |
|
2800 Private slot to execute a particular tool. |
|
2801 </p> |
|
2802 <dl> |
|
2803 |
|
2804 <dt><i>act</i></dt> |
|
2805 <dd> |
|
2806 reference to the action that was triggered (QAction) |
|
2807 </dd> |
|
2808 </dl> |
|
2809 <a NAME="UserInterface.__toolFinished" ID="UserInterface.__toolFinished"></a> |
|
2810 <h4>UserInterface.__toolFinished</h4> |
|
2811 <b>__toolFinished</b>(<i>exitCode, exitStatus</i>) |
|
2812 |
|
2813 <p> |
|
2814 Private slot to handle the finished signal of a tool process. |
|
2815 </p> |
|
2816 <dl> |
|
2817 |
|
2818 <dt><i>exitCode</i></dt> |
|
2819 <dd> |
|
2820 exit code of the process (integer) |
|
2821 </dd> |
|
2822 <dt><i>exitStatus</i></dt> |
|
2823 <dd> |
|
2824 exit status of the process (QProcess.ExitStatus) |
|
2825 </dd> |
|
2826 </dl> |
|
2827 <a NAME="UserInterface.__toolGroupSelected" ID="UserInterface.__toolGroupSelected"></a> |
|
2828 <h4>UserInterface.__toolGroupSelected</h4> |
|
2829 <b>__toolGroupSelected</b>(<i>act</i>) |
|
2830 |
|
2831 <p> |
|
2832 Private slot to set the current tool group. |
|
2833 </p> |
|
2834 <dl> |
|
2835 |
|
2836 <dt><i>act</i></dt> |
|
2837 <dd> |
|
2838 reference to the action that was triggered (QAction) |
|
2839 </dd> |
|
2840 </dl> |
|
2841 <a NAME="UserInterface.__toolGroupsConfiguration" ID="UserInterface.__toolGroupsConfiguration"></a> |
|
2842 <h4>UserInterface.__toolGroupsConfiguration</h4> |
|
2843 <b>__toolGroupsConfiguration</b>(<i></i>) |
|
2844 |
|
2845 <p> |
|
2846 Private slot to handle the tool groups configuration menu entry. |
|
2847 </p> |
|
2848 <a NAME="UserInterface.__toolsConfiguration" ID="UserInterface.__toolsConfiguration"></a> |
|
2849 <h4>UserInterface.__toolsConfiguration</h4> |
|
2850 <b>__toolsConfiguration</b>(<i></i>) |
|
2851 |
|
2852 <p> |
|
2853 Private slot to handle the tools configuration menu entry. |
|
2854 </p> |
|
2855 <a NAME="UserInterface.__updateExternalToolsActions" ID="UserInterface.__updateExternalToolsActions"></a> |
|
2856 <h4>UserInterface.__updateExternalToolsActions</h4> |
|
2857 <b>__updateExternalToolsActions</b>(<i></i>) |
|
2858 |
|
2859 <p> |
|
2860 Private method to update the external tools actions for the current |
|
2861 tool group. |
|
2862 </p> |
|
2863 <a NAME="UserInterface.__versionToTuple" ID="UserInterface.__versionToTuple"></a> |
|
2864 <h4>UserInterface.__versionToTuple</h4> |
|
2865 <b>__versionToTuple</b>(<i>version</i>) |
|
2866 |
|
2867 <p> |
|
2868 Private method to convert a version string into a tuple. |
|
2869 </p> |
|
2870 <dl> |
|
2871 |
|
2872 <dt><i>version</i> (str)</dt> |
|
2873 <dd> |
|
2874 version string |
|
2875 </dd> |
|
2876 </dl> |
|
2877 <dl> |
|
2878 <dt>Return:</dt> |
|
2879 <dd> |
|
2880 version tuple |
|
2881 </dd> |
|
2882 </dl> |
|
2883 <dl> |
|
2884 <dt>Return Type:</dt> |
|
2885 <dd> |
|
2886 tuple of int |
|
2887 </dd> |
|
2888 </dl> |
|
2889 <a NAME="UserInterface.__webBrowser" ID="UserInterface.__webBrowser"></a> |
|
2890 <h4>UserInterface.__webBrowser</h4> |
|
2891 <b>__webBrowser</b>(<i>home=""</i>) |
|
2892 |
|
2893 <p> |
|
2894 Private slot to start the eric web browser. |
|
2895 </p> |
|
2896 <dl> |
|
2897 |
|
2898 <dt><i>home</i></dt> |
|
2899 <dd> |
|
2900 full pathname of a file to display (string) |
|
2901 </dd> |
|
2902 </dl> |
|
2903 <a NAME="UserInterface.__webBrowserFinished" ID="UserInterface.__webBrowserFinished"></a> |
|
2904 <h4>UserInterface.__webBrowserFinished</h4> |
|
2905 <b>__webBrowserFinished</b>(<i></i>) |
|
2906 |
|
2907 <p> |
|
2908 Private slot handling the end of the external web browser process. |
|
2909 </p> |
|
2910 <a NAME="UserInterface.__webBrowserShutdown" ID="UserInterface.__webBrowserShutdown"></a> |
|
2911 <h4>UserInterface.__webBrowserShutdown</h4> |
|
2912 <b>__webBrowserShutdown</b>(<i></i>) |
|
2913 |
|
2914 <p> |
|
2915 Private method to shut down the web browser. |
|
2916 </p> |
|
2917 <a NAME="UserInterface.__whatsThis" ID="UserInterface.__whatsThis"></a> |
|
2918 <h4>UserInterface.__whatsThis</h4> |
|
2919 <b>__whatsThis</b>(<i></i>) |
|
2920 |
|
2921 <p> |
|
2922 Private slot called in to enter Whats This mode. |
|
2923 </p> |
|
2924 <a NAME="UserInterface.__writeCrashSession" ID="UserInterface.__writeCrashSession"></a> |
|
2925 <h4>UserInterface.__writeCrashSession</h4> |
|
2926 <b>__writeCrashSession</b>(<i></i>) |
|
2927 |
|
2928 <p> |
|
2929 Private slot to write a crash session file. |
|
2930 </p> |
|
2931 <a NAME="UserInterface.__writeSession" ID="UserInterface.__writeSession"></a> |
|
2932 <h4>UserInterface.__writeSession</h4> |
|
2933 <b>__writeSession</b>(<i>filename="", crashSession=False</i>) |
|
2934 |
|
2935 <p> |
|
2936 Private slot to write the session data to a JSON file (.esj). |
|
2937 </p> |
|
2938 <dl> |
|
2939 |
|
2940 <dt><i>filename</i> (str)</dt> |
|
2941 <dd> |
|
2942 name of a session file to write |
|
2943 </dd> |
|
2944 <dt><i>crashSession</i> (bool)</dt> |
|
2945 <dd> |
|
2946 flag indicating to write a crash session file |
|
2947 </dd> |
|
2948 </dl> |
|
2949 <dl> |
|
2950 <dt>Return:</dt> |
|
2951 <dd> |
|
2952 flag indicating success |
|
2953 </dd> |
|
2954 </dl> |
|
2955 <dl> |
|
2956 <dt>Return Type:</dt> |
|
2957 <dd> |
|
2958 bool |
|
2959 </dd> |
|
2960 </dl> |
|
2961 <a NAME="UserInterface.__writeTasks" ID="UserInterface.__writeTasks"></a> |
|
2962 <h4>UserInterface.__writeTasks</h4> |
|
2963 <b>__writeTasks</b>(<i></i>) |
|
2964 |
|
2965 <p> |
|
2966 Private slot to write the tasks data to a JSON file (.etj). |
|
2967 </p> |
|
2968 <a NAME="UserInterface.activateCodeDocumentationViewer" ID="UserInterface.activateCodeDocumentationViewer"></a> |
|
2969 <h4>UserInterface.activateCodeDocumentationViewer</h4> |
|
2970 <b>activateCodeDocumentationViewer</b>(<i>switchFocus=True</i>) |
|
2971 |
|
2972 <p> |
|
2973 Public slot to handle the activation of the Code Documentation Viewer. |
|
2974 </p> |
|
2975 <dl> |
|
2976 |
|
2977 <dt><i>switchFocus</i> (bool)</dt> |
|
2978 <dd> |
|
2979 flag indicating to transfer the input focus |
|
2980 </dd> |
|
2981 </dl> |
|
2982 <a NAME="UserInterface.activateCooperationViewer" ID="UserInterface.activateCooperationViewer"></a> |
|
2983 <h4>UserInterface.activateCooperationViewer</h4> |
|
2984 <b>activateCooperationViewer</b>(<i></i>) |
|
2985 |
|
2986 <p> |
|
2987 Public slot to handle the activation of the cooperation window. |
|
2988 </p> |
|
2989 <a NAME="UserInterface.activateDebugViewer" ID="UserInterface.activateDebugViewer"></a> |
|
2990 <h4>UserInterface.activateDebugViewer</h4> |
|
2991 <b>activateDebugViewer</b>(<i></i>) |
|
2992 |
|
2993 <p> |
|
2994 Public slot to handle the activation of the debug viewer. |
|
2995 </p> |
|
2996 <a NAME="UserInterface.activatePluginRepositoryViewer" ID="UserInterface.activatePluginRepositoryViewer"></a> |
|
2997 <h4>UserInterface.activatePluginRepositoryViewer</h4> |
|
2998 <b>activatePluginRepositoryViewer</b>(<i></i>) |
|
2999 |
|
3000 <p> |
|
3001 Public slot to activate the plugin repository viewer. |
|
3002 </p> |
|
3003 <a NAME="UserInterface.activateVirtualenvManager" ID="UserInterface.activateVirtualenvManager"></a> |
|
3004 <h4>UserInterface.activateVirtualenvManager</h4> |
|
3005 <b>activateVirtualenvManager</b>(<i></i>) |
|
3006 |
|
3007 <p> |
|
3008 Public slot to activate the virtual environments manager widget. |
|
3009 </p> |
|
3010 <a NAME="UserInterface.addEricActions" ID="UserInterface.addEricActions"></a> |
|
3011 <h4>UserInterface.addEricActions</h4> |
|
3012 <b>addEricActions</b>(<i>actions, actionType</i>) |
|
3013 |
|
3014 <p> |
|
3015 Public method to add actions to the list of actions. |
|
3016 </p> |
|
3017 <dl> |
|
3018 |
|
3019 <dt><i>actions</i></dt> |
|
3020 <dd> |
|
3021 list of actions to be added (list of EricAction) |
|
3022 </dd> |
|
3023 <dt><i>actionType</i></dt> |
|
3024 <dd> |
|
3025 string denoting the action set to add to. |
|
3026 It must be one of "ui" or "wizards". |
|
3027 </dd> |
|
3028 </dl> |
|
3029 <a NAME="UserInterface.addSideWidget" ID="UserInterface.addSideWidget"></a> |
|
3030 <h4>UserInterface.addSideWidget</h4> |
|
3031 <b>addSideWidget</b>(<i>side, widget, icon, label</i>) |
|
3032 |
|
3033 <p> |
|
3034 Public method to add a widget to the sides. |
|
3035 </p> |
|
3036 <dl> |
|
3037 |
|
3038 <dt><i>side</i> (int (one of UserInterface.LeftSide, UserInterface.BottomSide,)</dt> |
|
3039 <dd> |
|
3040 side to add the widget to |
|
3041 UserInterface.RightSide) |
|
3042 </dd> |
|
3043 <dt><i>widget</i> (QWidget)</dt> |
|
3044 <dd> |
|
3045 reference to the widget to add |
|
3046 </dd> |
|
3047 <dt><i>icon</i> (QIcon)</dt> |
|
3048 <dd> |
|
3049 icon to be used |
|
3050 </dd> |
|
3051 <dt><i>label</i> (str)</dt> |
|
3052 <dd> |
|
3053 label text to be shown |
|
3054 </dd> |
|
3055 </dl> |
|
3056 <a NAME="UserInterface.appendToStderr" ID="UserInterface.appendToStderr"></a> |
|
3057 <h4>UserInterface.appendToStderr</h4> |
|
3058 <b>appendToStderr</b>(<i>s</i>) |
|
3059 |
|
3060 <p> |
|
3061 Public slot to append text to the stderr log viewer tab. |
|
3062 </p> |
|
3063 <dl> |
|
3064 |
|
3065 <dt><i>s</i></dt> |
|
3066 <dd> |
|
3067 output to be appended (string) |
|
3068 </dd> |
|
3069 </dl> |
|
3070 <a NAME="UserInterface.appendToStdout" ID="UserInterface.appendToStdout"></a> |
|
3071 <h4>UserInterface.appendToStdout</h4> |
|
3072 <b>appendToStdout</b>(<i>s</i>) |
|
3073 |
|
3074 <p> |
|
3075 Public slot to append text to the stdout log viewer tab. |
|
3076 </p> |
|
3077 <dl> |
|
3078 |
|
3079 <dt><i>s</i></dt> |
|
3080 <dd> |
|
3081 output to be appended (string) |
|
3082 </dd> |
|
3083 </dl> |
|
3084 <a NAME="UserInterface.autoConnectIrc" ID="UserInterface.autoConnectIrc"></a> |
|
3085 <h4>UserInterface.autoConnectIrc</h4> |
|
3086 <b>autoConnectIrc</b>(<i></i>) |
|
3087 |
|
3088 <p> |
|
3089 Public method to initiate the IRC auto connection. |
|
3090 </p> |
|
3091 <a NAME="UserInterface.checkConfigurationStatus" ID="UserInterface.checkConfigurationStatus"></a> |
|
3092 <h4>UserInterface.checkConfigurationStatus</h4> |
|
3093 <b>checkConfigurationStatus</b>(<i></i>) |
|
3094 |
|
3095 <p> |
|
3096 Public method to check, if eric has been configured. If it is not, |
|
3097 the configuration dialog is shown. |
|
3098 </p> |
|
3099 <a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a> |
|
3100 <h4>UserInterface.checkForErrorLog</h4> |
|
3101 <b>checkForErrorLog</b>(<i></i>) |
|
3102 |
|
3103 <p> |
|
3104 Public method to check for the presence of an error log and ask the |
|
3105 user, what to do with it. |
|
3106 </p> |
|
3107 <a NAME="UserInterface.checkPluginUpdatesAvailable" ID="UserInterface.checkPluginUpdatesAvailable"></a> |
|
3108 <h4>UserInterface.checkPluginUpdatesAvailable</h4> |
|
3109 <b>checkPluginUpdatesAvailable</b>(<i></i>) |
|
3110 |
|
3111 <p> |
|
3112 Public method to check the availability of updates of plug-ins. |
|
3113 </p> |
|
3114 <a NAME="UserInterface.checkProjectsWorkspace" ID="UserInterface.checkProjectsWorkspace"></a> |
|
3115 <h4>UserInterface.checkProjectsWorkspace</h4> |
|
3116 <b>checkProjectsWorkspace</b>(<i></i>) |
|
3117 |
|
3118 <p> |
|
3119 Public method to check, if a projects workspace has been configured. If |
|
3120 it has not, a dialog is shown. |
|
3121 </p> |
|
3122 <a NAME="UserInterface.closeEvent" ID="UserInterface.closeEvent"></a> |
|
3123 <h4>UserInterface.closeEvent</h4> |
|
3124 <b>closeEvent</b>(<i>event</i>) |
|
3125 |
|
3126 <p> |
|
3127 Protected event handler for the close event. |
|
3128 </p> |
|
3129 <p> |
|
3130 This event handler saves the preferences. |
|
3131 </p> |
|
3132 <dl> |
|
3133 |
|
3134 <dt><i>event</i></dt> |
|
3135 <dd> |
|
3136 close event (QCloseEvent) |
|
3137 </dd> |
|
3138 </dl> |
|
3139 <a NAME="UserInterface.createPopupMenu" ID="UserInterface.createPopupMenu"></a> |
|
3140 <h4>UserInterface.createPopupMenu</h4> |
|
3141 <b>createPopupMenu</b>(<i></i>) |
|
3142 |
|
3143 <p> |
|
3144 Public method to create the toolbars menu for Qt. |
|
3145 </p> |
|
3146 <dl> |
|
3147 <dt>Return:</dt> |
|
3148 <dd> |
|
3149 toolbars menu (QMenu) |
|
3150 </dd> |
|
3151 </dl> |
|
3152 <a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a> |
|
3153 <h4>UserInterface.documentationViewer</h4> |
|
3154 <b>documentationViewer</b>(<i></i>) |
|
3155 |
|
3156 <p> |
|
3157 Public method to provide a reference to the code documentation viewer. |
|
3158 </p> |
|
3159 <dl> |
|
3160 <dt>Return:</dt> |
|
3161 <dd> |
|
3162 reference to the code documentation viewer |
|
3163 </dd> |
|
3164 </dl> |
|
3165 <dl> |
|
3166 <dt>Return Type:</dt> |
|
3167 <dd> |
|
3168 CodeDocumentationViewer |
|
3169 </dd> |
|
3170 </dl> |
|
3171 <a NAME="UserInterface.dragEnterEvent" ID="UserInterface.dragEnterEvent"></a> |
|
3172 <h4>UserInterface.dragEnterEvent</h4> |
|
3173 <b>dragEnterEvent</b>(<i>event</i>) |
|
3174 |
|
3175 <p> |
|
3176 Protected method to handle the drag enter event. |
|
3177 </p> |
|
3178 <dl> |
|
3179 |
|
3180 <dt><i>event</i></dt> |
|
3181 <dd> |
|
3182 the drag enter event (QDragEnterEvent) |
|
3183 </dd> |
|
3184 </dl> |
|
3185 <a NAME="UserInterface.dragLeaveEvent" ID="UserInterface.dragLeaveEvent"></a> |
|
3186 <h4>UserInterface.dragLeaveEvent</h4> |
|
3187 <b>dragLeaveEvent</b>(<i>event</i>) |
|
3188 |
|
3189 <p> |
|
3190 Protected method to handle the drag leave event. |
|
3191 </p> |
|
3192 <dl> |
|
3193 |
|
3194 <dt><i>event</i></dt> |
|
3195 <dd> |
|
3196 the drag leave event (QDragLeaveEvent) |
|
3197 </dd> |
|
3198 </dl> |
|
3199 <a NAME="UserInterface.dragMoveEvent" ID="UserInterface.dragMoveEvent"></a> |
|
3200 <h4>UserInterface.dragMoveEvent</h4> |
|
3201 <b>dragMoveEvent</b>(<i>event</i>) |
|
3202 |
|
3203 <p> |
|
3204 Protected method to handle the drag move event. |
|
3205 </p> |
|
3206 <dl> |
|
3207 |
|
3208 <dt><i>event</i></dt> |
|
3209 <dd> |
|
3210 the drag move event (QDragMoveEvent) |
|
3211 </dd> |
|
3212 </dl> |
|
3213 <a NAME="UserInterface.dropEvent" ID="UserInterface.dropEvent"></a> |
|
3214 <h4>UserInterface.dropEvent</h4> |
|
3215 <b>dropEvent</b>(<i>event</i>) |
|
3216 |
|
3217 <p> |
|
3218 Protected method to handle the drop event. |
|
3219 </p> |
|
3220 <dl> |
|
3221 |
|
3222 <dt><i>event</i></dt> |
|
3223 <dd> |
|
3224 the drop event (QDropEvent) |
|
3225 </dd> |
|
3226 </dl> |
|
3227 <a NAME="UserInterface.getActions" ID="UserInterface.getActions"></a> |
|
3228 <h4>UserInterface.getActions</h4> |
|
3229 <b>getActions</b>(<i>actionType</i>) |
|
3230 |
|
3231 <p> |
|
3232 Public method to get a list of all actions. |
|
3233 </p> |
|
3234 <dl> |
|
3235 |
|
3236 <dt><i>actionType</i></dt> |
|
3237 <dd> |
|
3238 string denoting the action set to get. |
|
3239 It must be one of "ui" or "wizards". |
|
3240 </dd> |
|
3241 </dl> |
|
3242 <dl> |
|
3243 <dt>Return:</dt> |
|
3244 <dd> |
|
3245 list of all actions (list of EricAction) |
|
3246 </dd> |
|
3247 </dl> |
|
3248 <a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a> |
|
3249 <h4>UserInterface.getLayoutType</h4> |
|
3250 <b>getLayoutType</b>(<i></i>) |
|
3251 |
|
3252 <p> |
|
3253 Public method to get the current layout type. |
|
3254 </p> |
|
3255 <dl> |
|
3256 <dt>Return:</dt> |
|
3257 <dd> |
|
3258 current layout type |
|
3259 </dd> |
|
3260 </dl> |
|
3261 <dl> |
|
3262 <dt>Return Type:</dt> |
|
3263 <dd> |
|
3264 str |
|
3265 </dd> |
|
3266 </dl> |
|
3267 <a NAME="UserInterface.getLocale" ID="UserInterface.getLocale"></a> |
|
3268 <h4>UserInterface.getLocale</h4> |
|
3269 <b>getLocale</b>(<i></i>) |
|
3270 |
|
3271 <p> |
|
3272 Public method to get the locale of the IDE. |
|
3273 </p> |
|
3274 <dl> |
|
3275 <dt>Return:</dt> |
|
3276 <dd> |
|
3277 locale of the IDE (string or None) |
|
3278 </dd> |
|
3279 </dl> |
|
3280 <a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a> |
|
3281 <h4>UserInterface.getMenu</h4> |
|
3282 <b>getMenu</b>(<i>name</i>) |
|
3283 |
|
3284 <p> |
|
3285 Public method to get a reference to a specific menu. |
|
3286 </p> |
|
3287 <dl> |
|
3288 |
|
3289 <dt><i>name</i></dt> |
|
3290 <dd> |
|
3291 name of the menu (string) |
|
3292 </dd> |
|
3293 </dl> |
|
3294 <dl> |
|
3295 <dt>Return:</dt> |
|
3296 <dd> |
|
3297 reference to the menu (QMenu) |
|
3298 </dd> |
|
3299 </dl> |
|
3300 <a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a> |
|
3301 <h4>UserInterface.getMenuAction</h4> |
|
3302 <b>getMenuAction</b>(<i>menuName, actionName</i>) |
|
3303 |
|
3304 <p> |
|
3305 Public method to get a reference to an action of a menu. |
|
3306 </p> |
|
3307 <dl> |
|
3308 |
|
3309 <dt><i>menuName</i></dt> |
|
3310 <dd> |
|
3311 name of the menu to search in (string) |
|
3312 </dd> |
|
3313 <dt><i>actionName</i></dt> |
|
3314 <dd> |
|
3315 object name of the action to search for |
|
3316 (string) |
|
3317 </dd> |
|
3318 </dl> |
|
3319 <dl> |
|
3320 <dt>Return:</dt> |
|
3321 <dd> |
|
3322 reference to the menu action (QAction) |
|
3323 </dd> |
|
3324 </dl> |
|
3325 <a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a> |
|
3326 <h4>UserInterface.getMenuBarAction</h4> |
|
3327 <b>getMenuBarAction</b>(<i>menuName</i>) |
|
3328 |
|
3329 <p> |
|
3330 Public method to get a reference to an action of the main menu. |
|
3331 </p> |
|
3332 <dl> |
|
3333 |
|
3334 <dt><i>menuName</i></dt> |
|
3335 <dd> |
|
3336 name of the menu to search in (string) |
|
3337 </dd> |
|
3338 </dl> |
|
3339 <dl> |
|
3340 <dt>Return:</dt> |
|
3341 <dd> |
|
3342 reference to the menu bar action (QAction) |
|
3343 </dd> |
|
3344 </dl> |
|
3345 <a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a> |
|
3346 <h4>UserInterface.getOriginalPathString</h4> |
|
3347 <b>getOriginalPathString</b>(<i></i>) |
|
3348 |
|
3349 <p> |
|
3350 Public method to get the original PATH environment variable |
|
3351 (i.e. before modifications by eric and PyQt5). |
|
3352 </p> |
|
3353 <dl> |
|
3354 <dt>Return:</dt> |
|
3355 <dd> |
|
3356 original PATH environment variable |
|
3357 </dd> |
|
3358 </dl> |
|
3359 <dl> |
|
3360 <dt>Return Type:</dt> |
|
3361 <dd> |
|
3362 str |
|
3363 </dd> |
|
3364 </dl> |
|
3365 <a NAME="UserInterface.getToolBarIconSize" ID="UserInterface.getToolBarIconSize"></a> |
|
3366 <h4>UserInterface.getToolBarIconSize</h4> |
|
3367 <b>getToolBarIconSize</b>(<i></i>) |
|
3368 |
|
3369 <p> |
|
3370 Public method to get the toolbar icon size. |
|
3371 </p> |
|
3372 <dl> |
|
3373 <dt>Return:</dt> |
|
3374 <dd> |
|
3375 toolbar icon size (QSize) |
|
3376 </dd> |
|
3377 </dl> |
|
3378 <a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a> |
|
3379 <h4>UserInterface.getToolbar</h4> |
|
3380 <b>getToolbar</b>(<i>name</i>) |
|
3381 |
|
3382 <p> |
|
3383 Public method to get a reference to a specific toolbar. |
|
3384 </p> |
|
3385 <dl> |
|
3386 |
|
3387 <dt><i>name</i></dt> |
|
3388 <dd> |
|
3389 name of the toolbar (string) |
|
3390 </dd> |
|
3391 </dl> |
|
3392 <dl> |
|
3393 <dt>Return:</dt> |
|
3394 <dd> |
|
3395 reference to the toolbar entry (tuple of string and QToolBar) |
|
3396 </dd> |
|
3397 </dl> |
|
3398 <a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a> |
|
3399 <h4>UserInterface.getToolbarsByCategory</h4> |
|
3400 <b>getToolbarsByCategory</b>(<i>category</i>) |
|
3401 |
|
3402 <p> |
|
3403 Public method to get a list of toolbars belonging to a given toolbar |
|
3404 category. |
|
3405 </p> |
|
3406 <dl> |
|
3407 |
|
3408 <dt><i>category</i> (str)</dt> |
|
3409 <dd> |
|
3410 toolbar category |
|
3411 </dd> |
|
3412 </dl> |
|
3413 <dl> |
|
3414 <dt>Return:</dt> |
|
3415 <dd> |
|
3416 list of toolbars |
|
3417 </dd> |
|
3418 </dl> |
|
3419 <dl> |
|
3420 <dt>Return Type:</dt> |
|
3421 <dd> |
|
3422 list of QToolBar |
|
3423 </dd> |
|
3424 </dl> |
|
3425 <a NAME="UserInterface.getViewProfile" ID="UserInterface.getViewProfile"></a> |
|
3426 <h4>UserInterface.getViewProfile</h4> |
|
3427 <b>getViewProfile</b>(<i></i>) |
|
3428 |
|
3429 <p> |
|
3430 Public method to get the current view profile. |
|
3431 </p> |
|
3432 <dl> |
|
3433 <dt>Return:</dt> |
|
3434 <dd> |
|
3435 the name of the current view profile (string) |
|
3436 </dd> |
|
3437 </dl> |
|
3438 <a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a> |
|
3439 <h4>UserInterface.handleUrl</h4> |
|
3440 <b>handleUrl</b>(<i>url</i>) |
|
3441 |
|
3442 <p> |
|
3443 Public slot to handle opening a URL. |
|
3444 </p> |
|
3445 <dl> |
|
3446 |
|
3447 <dt><i>url</i> (QUrl)</dt> |
|
3448 <dd> |
|
3449 URL to be shown |
|
3450 </dd> |
|
3451 </dl> |
|
3452 <a NAME="UserInterface.isOnline" ID="UserInterface.isOnline"></a> |
|
3453 <h4>UserInterface.isOnline</h4> |
|
3454 <b>isOnline</b>(<i></i>) |
|
3455 |
|
3456 <p> |
|
3457 Public method to get the online state. |
|
3458 </p> |
|
3459 <dl> |
|
3460 <dt>Return:</dt> |
|
3461 <dd> |
|
3462 online state |
|
3463 </dd> |
|
3464 </dl> |
|
3465 <dl> |
|
3466 <dt>Return Type:</dt> |
|
3467 <dd> |
|
3468 bool |
|
3469 </dd> |
|
3470 </dl> |
|
3471 <a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a> |
|
3472 <h4>UserInterface.launchHelpViewer</h4> |
|
3473 <b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>) |
|
3474 |
|
3475 <p> |
|
3476 Public slot to start the help viewer/web browser. |
|
3477 </p> |
|
3478 <dl> |
|
3479 |
|
3480 <dt><i>home</i> (str or QUrl)</dt> |
|
3481 <dd> |
|
3482 filename of file to be shown or URL to be opened |
|
3483 </dd> |
|
3484 <dt><i>searchWord</i> (str)</dt> |
|
3485 <dd> |
|
3486 word to search for |
|
3487 </dd> |
|
3488 <dt><i>useSingle</i> (bool)</dt> |
|
3489 <dd> |
|
3490 flag indicating to use a single browser window |
|
3491 </dd> |
|
3492 </dl> |
|
3493 <a NAME="UserInterface.networkAccessManager" ID="UserInterface.networkAccessManager"></a> |
|
3494 <h4>UserInterface.networkAccessManager</h4> |
|
3495 <b>networkAccessManager</b>(<i></i>) |
|
3496 |
|
3497 <p> |
|
3498 Public method to get a reference to the network access manager object. |
|
3499 </p> |
|
3500 <dl> |
|
3501 <dt>Return:</dt> |
|
3502 <dd> |
|
3503 reference to the network access manager object |
|
3504 </dd> |
|
3505 </dl> |
|
3506 <dl> |
|
3507 <dt>Return Type:</dt> |
|
3508 <dd> |
|
3509 QNetworkAccessManager |
|
3510 </dd> |
|
3511 </dl> |
|
3512 <a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a> |
|
3513 <h4>UserInterface.performVersionCheck</h4> |
|
3514 <b>performVersionCheck</b>(<i></i>) |
|
3515 |
|
3516 <p> |
|
3517 Public method to check for an update even if not installed via PyPI. |
|
3518 </p> |
|
3519 <a NAME="UserInterface.processArgs" ID="UserInterface.processArgs"></a> |
|
3520 <h4>UserInterface.processArgs</h4> |
|
3521 <b>processArgs</b>(<i>args</i>) |
|
3522 |
|
3523 <p> |
|
3524 Public method to process the command line args passed to the UI. |
|
3525 </p> |
|
3526 <dl> |
|
3527 |
|
3528 <dt><i>args</i></dt> |
|
3529 <dd> |
|
3530 list of files to open<br /> |
|
3531 The args are processed one at a time. All arguments after a |
|
3532 '--' option are considered debug arguments to the program |
|
3533 for the debugger. All files named before the '--' option |
|
3534 are opened in a text editor, unless the argument ends in |
|
3535 .epj or .e4p, then it is opened as a project file. If it |
|
3536 ends in .emj, .e4m or .e5m, it is opened as a multi project. |
|
3537 </dd> |
|
3538 </dl> |
|
3539 <a NAME="UserInterface.processInstallInfoFile" ID="UserInterface.processInstallInfoFile"></a> |
|
3540 <h4>UserInterface.processInstallInfoFile</h4> |
|
3541 <b>processInstallInfoFile</b>(<i></i>) |
|
3542 |
|
3543 <p> |
|
3544 Public method to process the file containing installation information. |
|
3545 </p> |
|
3546 <a NAME="UserInterface.registerToolbar" ID="UserInterface.registerToolbar"></a> |
|
3547 <h4>UserInterface.registerToolbar</h4> |
|
3548 <b>registerToolbar</b>(<i>name, text, toolbar, category=""</i>) |
|
3549 |
|
3550 <p> |
|
3551 Public method to register a toolbar. |
|
3552 </p> |
|
3553 <p> |
|
3554 This method must be called in order to make a toolbar manageable by the |
|
3555 UserInterface object. |
|
3556 </p> |
|
3557 <dl> |
|
3558 |
|
3559 <dt><i>name</i> (str)</dt> |
|
3560 <dd> |
|
3561 name of the toolbar. This is used as the key into |
|
3562 the dictionary of toolbar references. |
|
3563 </dd> |
|
3564 <dt><i>text</i> (str)</dt> |
|
3565 <dd> |
|
3566 user visible text for the toolbar entry |
|
3567 </dd> |
|
3568 <dt><i>toolbar</i> (QToolBar)</dt> |
|
3569 <dd> |
|
3570 reference to the toolbar to be registered |
|
3571 </dd> |
|
3572 <dt><i>category</i> (str)</dt> |
|
3573 <dd> |
|
3574 toolbar category |
|
3575 </dd> |
|
3576 </dl> |
|
3577 <dl> |
|
3578 |
|
3579 <dt>Raises <b>KeyError</b>:</dt> |
|
3580 <dd> |
|
3581 raised, if a toolbar with the given name was |
|
3582 already registered |
|
3583 </dd> |
|
3584 </dl> |
|
3585 <a NAME="UserInterface.removeEricActions" ID="UserInterface.removeEricActions"></a> |
|
3586 <h4>UserInterface.removeEricActions</h4> |
|
3587 <b>removeEricActions</b>(<i>actions, actionType='ui'</i>) |
|
3588 |
|
3589 <p> |
|
3590 Public method to remove actions from the list of actions. |
|
3591 </p> |
|
3592 <dl> |
|
3593 |
|
3594 <dt><i>actions</i></dt> |
|
3595 <dd> |
|
3596 list of actions (list of EricAction) |
|
3597 </dd> |
|
3598 <dt><i>actionType</i></dt> |
|
3599 <dd> |
|
3600 string denoting the action set to remove from. |
|
3601 It must be one of "ui" or "wizards". |
|
3602 </dd> |
|
3603 </dl> |
|
3604 <a NAME="UserInterface.removeSideWidget" ID="UserInterface.removeSideWidget"></a> |
|
3605 <h4>UserInterface.removeSideWidget</h4> |
|
3606 <b>removeSideWidget</b>(<i>widget</i>) |
|
3607 |
|
3608 <p> |
|
3609 Public method to remove a widget added using addSideWidget(). |
|
3610 </p> |
|
3611 <dl> |
|
3612 |
|
3613 <dt><i>widget</i> (QWidget)</dt> |
|
3614 <dd> |
|
3615 reference to the widget to remove |
|
3616 </dd> |
|
3617 </dl> |
|
3618 <a NAME="UserInterface.reregisterToolbar" ID="UserInterface.reregisterToolbar"></a> |
|
3619 <h4>UserInterface.reregisterToolbar</h4> |
|
3620 <b>reregisterToolbar</b>(<i>name, text, category=""</i>) |
|
3621 |
|
3622 <p> |
|
3623 Public method to change the visible text for the named toolbar. |
|
3624 </p> |
|
3625 <dl> |
|
3626 |
|
3627 <dt><i>name</i> (str)</dt> |
|
3628 <dd> |
|
3629 name of the toolbar to be changed |
|
3630 </dd> |
|
3631 <dt><i>text</i> (str)</dt> |
|
3632 <dd> |
|
3633 new user visible text for the toolbar entry |
|
3634 </dd> |
|
3635 <dt><i>category</i> (str)</dt> |
|
3636 <dd> |
|
3637 new toolbar category for the toolbar entry |
|
3638 </dd> |
|
3639 </dl> |
|
3640 <a NAME="UserInterface.setDebugProfile" ID="UserInterface.setDebugProfile"></a> |
|
3641 <h4>UserInterface.setDebugProfile</h4> |
|
3642 <b>setDebugProfile</b>(<i>save=True</i>) |
|
3643 |
|
3644 <p> |
|
3645 Public slot to activate the debug view profile. |
|
3646 </p> |
|
3647 <dl> |
|
3648 |
|
3649 <dt><i>save</i></dt> |
|
3650 <dd> |
|
3651 flag indicating that the current profile should |
|
3652 be saved (boolean) |
|
3653 </dd> |
|
3654 </dl> |
|
3655 <a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a> |
|
3656 <h4>UserInterface.showEmailDialog</h4> |
|
3657 <b>showEmailDialog</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>) |
|
3658 |
|
3659 <p> |
|
3660 Public slot to show the email dialog in a given mode. |
|
3661 </p> |
|
3662 <dl> |
|
3663 |
|
3664 <dt><i>mode</i></dt> |
|
3665 <dd> |
|
3666 mode of the email dialog (string, "bug" or "feature") |
|
3667 </dd> |
|
3668 <dt><i>attachFile</i></dt> |
|
3669 <dd> |
|
3670 name of a file to attach to the email (string) |
|
3671 </dd> |
|
3672 <dt><i>deleteAttachFile</i></dt> |
|
3673 <dd> |
|
3674 flag indicating to delete the attached file |
|
3675 after it has been sent (boolean) |
|
3676 </dd> |
|
3677 </dl> |
|
3678 <a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a> |
|
3679 <h4>UserInterface.showEvent</h4> |
|
3680 <b>showEvent</b>(<i>evt</i>) |
|
3681 |
|
3682 <p> |
|
3683 Protected method to handle the show event. |
|
3684 </p> |
|
3685 <dl> |
|
3686 |
|
3687 <dt><i>evt</i></dt> |
|
3688 <dd> |
|
3689 reference to the show event (QShowEvent) |
|
3690 </dd> |
|
3691 </dl> |
|
3692 <a NAME="UserInterface.showFindFileByNameDialog" ID="UserInterface.showFindFileByNameDialog"></a> |
|
3693 <h4>UserInterface.showFindFileByNameDialog</h4> |
|
3694 <b>showFindFileByNameDialog</b>(<i></i>) |
|
3695 |
|
3696 <p> |
|
3697 Public slot to show the Find File by Name dialog. |
|
3698 </p> |
|
3699 <a NAME="UserInterface.showFindFilesWidget" ID="UserInterface.showFindFilesWidget"></a> |
|
3700 <h4>UserInterface.showFindFilesWidget</h4> |
|
3701 <b>showFindFilesWidget</b>(<i>txt="", searchDir="", openFiles=False</i>) |
|
3702 |
|
3703 <p> |
|
3704 Public slot to show the Find In Files widget. |
|
3705 </p> |
|
3706 <dl> |
|
3707 |
|
3708 <dt><i>txt</i> (str (optional))</dt> |
|
3709 <dd> |
|
3710 text to search for (defaults to "") |
|
3711 </dd> |
|
3712 <dt><i>searchDir</i> (str (optional))</dt> |
|
3713 <dd> |
|
3714 directory to search in (defaults to "") |
|
3715 </dd> |
|
3716 <dt><i>openFiles</i> (bool (optional))</dt> |
|
3717 <dd> |
|
3718 flag indicating to operate on open files only |
|
3719 (defaults to False) |
|
3720 </dd> |
|
3721 </dl> |
|
3722 <a NAME="UserInterface.showFindLocationWidget" ID="UserInterface.showFindLocationWidget"></a> |
|
3723 <h4>UserInterface.showFindLocationWidget</h4> |
|
3724 <b>showFindLocationWidget</b>(<i></i>) |
|
3725 |
|
3726 <p> |
|
3727 Public method to show the Find File widget. |
|
3728 </p> |
|
3729 <a NAME="UserInterface.showLogViewer" ID="UserInterface.showLogViewer"></a> |
|
3730 <h4>UserInterface.showLogViewer</h4> |
|
3731 <b>showLogViewer</b>(<i></i>) |
|
3732 |
|
3733 <p> |
|
3734 Public method to show the Log-Viewer. |
|
3735 </p> |
|
3736 <a NAME="UserInterface.showNotification" ID="UserInterface.showNotification"></a> |
|
3737 <h4>UserInterface.showNotification</h4> |
|
3738 <b>showNotification</b>(<i>icon, heading, text, kind=NotificationTypes.INFORMATION, timeout=None</i>) |
|
3739 |
|
3740 <p> |
|
3741 Public method to show a desktop notification. |
|
3742 </p> |
|
3743 <dl> |
|
3744 |
|
3745 <dt><i>icon</i> (QPixmap)</dt> |
|
3746 <dd> |
|
3747 icon to be shown in the notification |
|
3748 </dd> |
|
3749 <dt><i>heading</i> (str)</dt> |
|
3750 <dd> |
|
3751 heading of the notification |
|
3752 </dd> |
|
3753 <dt><i>text</i> (str)</dt> |
|
3754 <dd> |
|
3755 text of the notification |
|
3756 </dd> |
|
3757 <dt><i>kind</i> (NotificationTypes)</dt> |
|
3758 <dd> |
|
3759 kind of notification to be shown |
|
3760 </dd> |
|
3761 <dt><i>timeout</i> (int)</dt> |
|
3762 <dd> |
|
3763 time in seconds the notification should be shown |
|
3764 (None = use configured timeout, 0 = indefinitely) |
|
3765 </dd> |
|
3766 </dl> |
|
3767 <a NAME="UserInterface.showPreferences" ID="UserInterface.showPreferences"></a> |
|
3768 <h4>UserInterface.showPreferences</h4> |
|
3769 <b>showPreferences</b>(<i>pageName=None</i>) |
|
3770 |
|
3771 <p> |
|
3772 Public slot to set the preferences. |
|
3773 </p> |
|
3774 <dl> |
|
3775 |
|
3776 <dt><i>pageName</i></dt> |
|
3777 <dd> |
|
3778 name of the configuration page to show (string) |
|
3779 </dd> |
|
3780 </dl> |
|
3781 <a NAME="UserInterface.showReplaceFilesWidget" ID="UserInterface.showReplaceFilesWidget"></a> |
|
3782 <h4>UserInterface.showReplaceFilesWidget</h4> |
|
3783 <b>showReplaceFilesWidget</b>(<i>txt="", searchDir="", openFiles=False</i>) |
|
3784 |
|
3785 <p> |
|
3786 Public slot to show the Find In Files widget in replace mode. |
|
3787 </p> |
|
3788 <dl> |
|
3789 |
|
3790 <dt><i>txt</i> (str (optional))</dt> |
|
3791 <dd> |
|
3792 text to search for (defaults to "") |
|
3793 </dd> |
|
3794 <dt><i>searchDir</i> (str (optional))</dt> |
|
3795 <dd> |
|
3796 directory to search in (defaults to "") |
|
3797 </dd> |
|
3798 <dt><i>openFiles</i> (bool (optional))</dt> |
|
3799 <dd> |
|
3800 flag indicating to operate on open files only |
|
3801 (defaults to False) |
|
3802 </dd> |
|
3803 </dl> |
|
3804 <a NAME="UserInterface.showSideWidget" ID="UserInterface.showSideWidget"></a> |
|
3805 <h4>UserInterface.showSideWidget</h4> |
|
3806 <b>showSideWidget</b>(<i>widget</i>) |
|
3807 |
|
3808 <p> |
|
3809 Public method to show a specific widget placed in the side widgets. |
|
3810 </p> |
|
3811 <dl> |
|
3812 |
|
3813 <dt><i>widget</i> (QWidget)</dt> |
|
3814 <dd> |
|
3815 reference to the widget to be shown |
|
3816 </dd> |
|
3817 </dl> |
|
3818 <a NAME="UserInterface.unregisterToolbar" ID="UserInterface.unregisterToolbar"></a> |
|
3819 <h4>UserInterface.unregisterToolbar</h4> |
|
3820 <b>unregisterToolbar</b>(<i>name</i>) |
|
3821 |
|
3822 <p> |
|
3823 Public method to unregister a toolbar. |
|
3824 </p> |
|
3825 <dl> |
|
3826 |
|
3827 <dt><i>name</i></dt> |
|
3828 <dd> |
|
3829 name of the toolbar (string). |
|
3830 </dd> |
|
3831 </dl> |
|
3832 <a NAME="UserInterface.upgradeEric" ID="UserInterface.upgradeEric"></a> |
|
3833 <h4>UserInterface.upgradeEric</h4> |
|
3834 <b>upgradeEric</b>(<i></i>) |
|
3835 |
|
3836 <p> |
|
3837 Public slot to upgrade the eric-ide package of the eric7 environment. |
|
3838 </p> |
|
3839 <dl> |
|
3840 <dt>Return:</dt> |
|
3841 <dd> |
|
3842 flag indicating a successful upgrade |
|
3843 </dd> |
|
3844 </dl> |
|
3845 <dl> |
|
3846 <dt>Return Type:</dt> |
|
3847 <dd> |
|
3848 bool |
|
3849 </dd> |
|
3850 </dl> |
|
3851 <a NAME="UserInterface.upgradeEricPyQt" ID="UserInterface.upgradeEricPyQt"></a> |
|
3852 <h4>UserInterface.upgradeEricPyQt</h4> |
|
3853 <b>upgradeEricPyQt</b>(<i></i>) |
|
3854 |
|
3855 <p> |
|
3856 Public slot to upgrade the eric-ide and Pyqt packages of the eric7 |
|
3857 environment. |
|
3858 </p> |
|
3859 <dl> |
|
3860 <dt>Return:</dt> |
|
3861 <dd> |
|
3862 flag indicating a successful upgrade |
|
3863 </dd> |
|
3864 </dl> |
|
3865 <dl> |
|
3866 <dt>Return Type:</dt> |
|
3867 <dd> |
|
3868 bool |
|
3869 </dd> |
|
3870 </dl> |
|
3871 <a NAME="UserInterface.upgradePyQt" ID="UserInterface.upgradePyQt"></a> |
|
3872 <h4>UserInterface.upgradePyQt</h4> |
|
3873 <b>upgradePyQt</b>(<i></i>) |
|
3874 |
|
3875 <p> |
|
3876 Public slot to upgrade the PyQt packages of the eric7 environment. |
|
3877 </p> |
|
3878 <dl> |
|
3879 <dt>Return:</dt> |
|
3880 <dd> |
|
3881 flag indicating a successful upgrade |
|
3882 </dd> |
|
3883 </dl> |
|
3884 <dl> |
|
3885 <dt>Return Type:</dt> |
|
3886 <dd> |
|
3887 bool |
|
3888 </dd> |
|
3889 </dl> |
|
3890 <a NAME="UserInterface.versionIsNewer" ID="UserInterface.versionIsNewer"></a> |
|
3891 <h4>UserInterface.versionIsNewer</h4> |
|
3892 <b>versionIsNewer</b>(<i>required, snapshot=None</i>) |
|
3893 |
|
3894 <p> |
|
3895 Public method to check, if the eric version is good compared to |
|
3896 the required version. |
|
3897 </p> |
|
3898 <dl> |
|
3899 |
|
3900 <dt><i>required</i></dt> |
|
3901 <dd> |
|
3902 required version (string) |
|
3903 </dd> |
|
3904 <dt><i>snapshot</i></dt> |
|
3905 <dd> |
|
3906 required snapshot version (string) |
|
3907 </dd> |
|
3908 </dl> |
|
3909 <dl> |
|
3910 <dt>Return:</dt> |
|
3911 <dd> |
|
3912 flag indicating, that the version is newer than the required |
|
3913 one (boolean) |
|
3914 </dd> |
|
3915 </dl> |
|
3916 <div align="right"><a href="#top">Up</a></div> |
|
3917 <hr /> |
|
3918 </body></html> |