Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.UI.UserInterface.html

eric7/Documentation/Source/eric7.UI.UserInterface.html

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

Mercurial Repository: eric

eric ide

mercurial