Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.UI.UserInterface.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6987
3371a03ed0a7
child 7005
342819f05839
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.UI.UserInterface</h1>
23 <p>
24 Module implementing the main user interface.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#Redirector">Redirector</a></td>
34 <td>Helper class used to redirect stdout and stderr to the log window.</td>
35 </tr><tr>
36 <td><a href="#UserInterface">UserInterface</a></td>
37 <td>Class implementing the main user interface.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="Redirector" ID="Redirector"></a>
46 <h2>Redirector</h2>
47 <p>
48 Helper class used to redirect stdout and stderr to the log window.
49 </p><h3>Signals</h3>
50 <dl>
51 <dt>appendStderr(str)</dt>
52 <dd>
53 emitted to write data to stderr logger
54 </dd><dt>appendStdout(str)</dt>
55 <dd>
56 emitted to write data to stdout logger
57 </dd>
58 </dl>
59 <h3>Derived from</h3>
60 QObject
61 <h3>Class Attributes</h3>
62 <table>
63 <tr><td>None</td></tr>
64 </table>
65 <h3>Class Methods</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70 <table>
71 <tr>
72 <td><a href="#Redirector.__init__">Redirector</a></td>
73 <td>Constructor</td>
74 </tr><tr>
75 <td><a href="#Redirector.__bufferedWrite">__bufferedWrite</a></td>
76 <td>Private method returning number of characters to write.</td>
77 </tr><tr>
78 <td><a href="#Redirector.__nWrite">__nWrite</a></td>
79 <td>Private method used to write data.</td>
80 </tr><tr>
81 <td><a href="#Redirector.flush">flush</a></td>
82 <td>Public method used to flush the buffered data.</td>
83 </tr><tr>
84 <td><a href="#Redirector.write">write</a></td>
85 <td>Public method used to write data.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89 <table>
90 <tr><td>None</td></tr>
91 </table>
92 <a NAME="Redirector.__init__" ID="Redirector.__init__"></a>
93 <h4>Redirector (Constructor)</h4>
94 <b>Redirector</b>(<i>stderr</i>)
95 <p>
96 Constructor
97 </p><dl>
98 <dt><i>stderr</i></dt>
99 <dd>
100 flag indicating stderr is being redirected
101 </dd>
102 </dl><a NAME="Redirector.__bufferedWrite" ID="Redirector.__bufferedWrite"></a>
103 <h4>Redirector.__bufferedWrite</h4>
104 <b>__bufferedWrite</b>(<i></i>)
105 <p>
106 Private method returning number of characters to write.
107 </p><dl>
108 <dt>Returns:</dt>
109 <dd>
110 number of characters buffered or length of buffered line
111 (integer)
112 </dd>
113 </dl><a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a>
114 <h4>Redirector.__nWrite</h4>
115 <b>__nWrite</b>(<i>n</i>)
116 <p>
117 Private method used to write data.
118 </p><dl>
119 <dt><i>n</i></dt>
120 <dd>
121 max number of bytes to write
122 </dd>
123 </dl><a NAME="Redirector.flush" ID="Redirector.flush"></a>
124 <h4>Redirector.flush</h4>
125 <b>flush</b>(<i></i>)
126 <p>
127 Public method used to flush the buffered data.
128 </p><a NAME="Redirector.write" ID="Redirector.write"></a>
129 <h4>Redirector.write</h4>
130 <b>write</b>(<i>s</i>)
131 <p>
132 Public method used to write data.
133 </p><dl>
134 <dt><i>s</i></dt>
135 <dd>
136 data to be written (it must support the str-method)
137 </dd>
138 </dl>
139 <div align="right"><a href="#top">Up</a></div>
140 <hr /><hr />
141 <a NAME="UserInterface" ID="UserInterface"></a>
142 <h2>UserInterface</h2>
143 <p>
144 Class implementing the main user interface.
145 </p><h3>Signals</h3>
146 <dl>
147 <dt>appendStderr(str)</dt>
148 <dd>
149 emitted to write data to stderr logger
150 </dd><dt>appendStdout(str)</dt>
151 <dd>
152 emitted to write data to stdout logger
153 </dd><dt>masterPasswordChanged(str, str)</dt>
154 <dd>
155 emitted after the master
156 password has been changed with the old and the new password
157 </dd><dt>onlineStateChanged(online)</dt>
158 <dd>
159 emitted to indicate a change of the
160 network state
161 </dd><dt>preferencesChanged()</dt>
162 <dd>
163 emitted after the preferences were changed
164 </dd><dt>reloadAPIs()</dt>
165 <dd>
166 emitted to reload the api information
167 </dd><dt>showMenu(str, QMenu)</dt>
168 <dd>
169 emitted when a menu is about to be shown. The
170 name of the menu and a reference to the menu are given.
171 </dd>
172 </dl>
173 <h3>Derived from</h3>
174 E5MainWindow
175 <h3>Class Attributes</h3>
176 <table>
177 <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>
178 </table>
179 <h3>Class Methods</h3>
180 <table>
181 <tr><td>None</td></tr>
182 </table>
183 <h3>Methods</h3>
184 <table>
185 <tr>
186 <td><a href="#UserInterface.__init__">UserInterface</a></td>
187 <td>Constructor</td>
188 </tr><tr>
189 <td><a href="#UserInterface.__TBMenuTriggered">__TBMenuTriggered</a></td>
190 <td>Private method to handle the toggle of a toolbar via the Window-> Toolbars submenu.</td>
191 </tr><tr>
192 <td><a href="#UserInterface.__TBPopupMenuTriggered">__TBPopupMenuTriggered</a></td>
193 <td>Private method to handle the toggle of a toolbar via the QMainWindow Toolbars popup menu.</td>
194 </tr><tr>
195 <td><a href="#UserInterface.__TRPreviewer">__TRPreviewer</a></td>
196 <td>Private slot to start the Translation Previewer executable.</td>
197 </tr><tr>
198 <td><a href="#UserInterface.__UIPreviewer">__UIPreviewer</a></td>
199 <td>Private slot to start the UI Previewer executable.</td>
200 </tr><tr>
201 <td><a href="#UserInterface.__activateBrowser">__activateBrowser</a></td>
202 <td>Private slot to handle the activation of the file browser.</td>
203 </tr><tr>
204 <td><a href="#UserInterface.__activateCondaWidget">__activateCondaWidget</a></td>
205 <td>Private slot to handle the activation of the Conda manager widget.</td>
206 </tr><tr>
207 <td><a href="#UserInterface.__activateIRC">__activateIRC</a></td>
208 <td>Private slot to handle the activation of the IRC window.</td>
209 </tr><tr>
210 <td><a href="#UserInterface.__activateLogViewer">__activateLogViewer</a></td>
211 <td>Private slot to handle the activation of the Log Viewer.</td>
212 </tr><tr>
213 <td><a href="#UserInterface.__activateMultiProjectBrowser">__activateMultiProjectBrowser</a></td>
214 <td>Private slot to handle the activation of the project browser.</td>
215 </tr><tr>
216 <td><a href="#UserInterface.__activateNumbersViewer">__activateNumbersViewer</a></td>
217 <td>Private slot to handle the activation of the Numbers Viewer.</td>
218 </tr><tr>
219 <td><a href="#UserInterface.__activatePipWidget">__activatePipWidget</a></td>
220 <td>Private slot to handle the activation of the PyPI manager widget.</td>
221 </tr><tr>
222 <td><a href="#UserInterface.__activateProjectBrowser">__activateProjectBrowser</a></td>
223 <td>Private slot to handle the activation of the project browser.</td>
224 </tr><tr>
225 <td><a href="#UserInterface.__activateShell">__activateShell</a></td>
226 <td>Private slot to handle the activation of the Shell window.</td>
227 </tr><tr>
228 <td><a href="#UserInterface.__activateSymbolsViewer">__activateSymbolsViewer</a></td>
229 <td>Private slot to handle the activation of the Symbols Viewer.</td>
230 </tr><tr>
231 <td><a href="#UserInterface.__activateTaskViewer">__activateTaskViewer</a></td>
232 <td>Private slot to handle the activation of the Task Viewer.</td>
233 </tr><tr>
234 <td><a href="#UserInterface.__activateTemplateViewer">__activateTemplateViewer</a></td>
235 <td>Private slot to handle the activation of the Template Viewer.</td>
236 </tr><tr>
237 <td><a href="#UserInterface.__activateViewProfile">__activateViewProfile</a></td>
238 <td>Private slot to activate a view profile.</td>
239 </tr><tr>
240 <td><a href="#UserInterface.__activateViewmanager">__activateViewmanager</a></td>
241 <td>Private slot to handle the activation of the current editor.</td>
242 </tr><tr>
243 <td><a href="#UserInterface.__assistant">__assistant</a></td>
244 <td>Private slot to start the Qt-Assistant executable.</td>
245 </tr><tr>
246 <td><a href="#UserInterface.__assistant4">__assistant4</a></td>
247 <td>Private slot to start the Qt-Assistant 4/5 executable.</td>
248 </tr><tr>
249 <td><a href="#UserInterface.__checkActions">__checkActions</a></td>
250 <td>Private slot to check some actions for their enable/disable status.</td>
251 </tr><tr>
252 <td><a href="#UserInterface.__chmViewer">__chmViewer</a></td>
253 <td>Private slot to start the win help viewer to show *.chm files.</td>
254 </tr><tr>
255 <td><a href="#UserInterface.__clearPrivateData">__clearPrivateData</a></td>
256 <td>Private slot to clear the private data lists.</td>
257 </tr><tr>
258 <td><a href="#UserInterface.__compareFiles">__compareFiles</a></td>
259 <td>Private slot to handle the Compare Files dialog.</td>
260 </tr><tr>
261 <td><a href="#UserInterface.__compareFilesSbs">__compareFilesSbs</a></td>
262 <td>Private slot to handle the Compare Files dialog.</td>
263 </tr><tr>
264 <td><a href="#UserInterface.__configShortcuts">__configShortcuts</a></td>
265 <td>Private slot to configure the keyboard shortcuts.</td>
266 </tr><tr>
267 <td><a href="#UserInterface.__configToolBars">__configToolBars</a></td>
268 <td>Private slot to configure the various toolbars.</td>
269 </tr><tr>
270 <td><a href="#UserInterface.__configViewProfiles">__configViewProfiles</a></td>
271 <td>Private slot to configure the various view profiles.</td>
272 </tr><tr>
273 <td><a href="#UserInterface.__connectToWebBrowser">__connectToWebBrowser</a></td>
274 <td>Private method to connect to a started web browser.</td>
275 </tr><tr>
276 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td>
277 <td>Private method to create a dock window with common properties.</td>
278 </tr><tr>
279 <td><a href="#UserInterface.__createLayout">__createLayout</a></td>
280 <td>Private method to create the layout of the various windows.</td>
281 </tr><tr>
282 <td><a href="#UserInterface.__createSidebarsLayout">__createSidebarsLayout</a></td>
283 <td>Private method to create the Sidebars layout.</td>
284 </tr><tr>
285 <td><a href="#UserInterface.__createToolboxesLayout">__createToolboxesLayout</a></td>
286 <td>Private method to create the Toolboxes layout.</td>
287 </tr><tr>
288 <td><a href="#UserInterface.__createUnitTestDialog">__createUnitTestDialog</a></td>
289 <td>Private slot to generate the unit test dialog on demand.</td>
290 </tr><tr>
291 <td><a href="#UserInterface.__customViewer">__customViewer</a></td>
292 <td>Private slot to start a custom viewer.</td>
293 </tr><tr>
294 <td><a href="#UserInterface.__debuggingDone">__debuggingDone</a></td>
295 <td>Private slot to handle the end of a debugging session.</td>
296 </tr><tr>
297 <td><a href="#UserInterface.__debuggingStarted">__debuggingStarted</a></td>
298 <td>Private slot to handle the start of a debugging session.</td>
299 </tr><tr>
300 <td><a href="#UserInterface.__deinstallPlugin">__deinstallPlugin</a></td>
301 <td>Private slot to show a dialog to uninstall a plugin.</td>
302 </tr><tr>
303 <td><a href="#UserInterface.__deleteCrashSession">__deleteCrashSession</a></td>
304 <td>Private slot to delete the crash session file.</td>
305 </tr><tr>
306 <td><a href="#UserInterface.__designer">__designer</a></td>
307 <td>Private slot to start the Qt-Designer executable.</td>
308 </tr><tr>
309 <td><a href="#UserInterface.__designer4">__designer4</a></td>
310 <td>Private slot to start the Qt-Designer 4/5 executable.</td>
311 </tr><tr>
312 <td><a href="#UserInterface.__editPixmap">__editPixmap</a></td>
313 <td>Private slot to show a pixmap in a dialog.</td>
314 </tr><tr>
315 <td><a href="#UserInterface.__editorOpened">__editorOpened</a></td>
316 <td>Private slot to handle the editorOpened signal.</td>
317 </tr><tr>
318 <td><a href="#UserInterface.__exportPreferences">__exportPreferences</a></td>
319 <td>Private slot to export the current preferences.</td>
320 </tr><tr>
321 <td><a href="#UserInterface.__exportShortcuts">__exportShortcuts</a></td>
322 <td>Private slot to export the keyboard shortcuts.</td>
323 </tr><tr>
324 <td><a href="#UserInterface.__getFloatingGeometry">__getFloatingGeometry</a></td>
325 <td>Private method to get the geometry of a floating windows.</td>
326 </tr><tr>
327 <td><a href="#UserInterface.__hasErrorLog">__hasErrorLog</a></td>
328 <td>Private method to check, if an error log file exists.</td>
329 </tr><tr>
330 <td><a href="#UserInterface.__helpViewer">__helpViewer</a></td>
331 <td>Private slot to start an empty help viewer/web browser.</td>
332 </tr><tr>
333 <td><a href="#UserInterface.__importPreferences">__importPreferences</a></td>
334 <td>Private slot to import preferences.</td>
335 </tr><tr>
336 <td><a href="#UserInterface.__importShortcuts">__importShortcuts</a></td>
337 <td>Private slot to import the keyboard shortcuts.</td>
338 </tr><tr>
339 <td><a href="#UserInterface.__initActions">__initActions</a></td>
340 <td>Private method to define the user interface actions.</td>
341 </tr><tr>
342 <td><a href="#UserInterface.__initDebugToolbarsLayout">__initDebugToolbarsLayout</a></td>
343 <td>Private slot to initialize the toolbars layout for the debug profile.</td>
344 </tr><tr>
345 <td><a href="#UserInterface.__initEricDocAction">__initEricDocAction</a></td>
346 <td>Private slot to initialize the action to show the eric6 documentation.</td>
347 </tr><tr>
348 <td><a href="#UserInterface.__initExternalToolsActions">__initExternalToolsActions</a></td>
349 <td>Private slot to create actions for the configured external tools.</td>
350 </tr><tr>
351 <td><a href="#UserInterface.__initMenus">__initMenus</a></td>
352 <td>Private slot to create the menus.</td>
353 </tr><tr>
354 <td><a href="#UserInterface.__initPySideDocActions">__initPySideDocActions</a></td>
355 <td>Private slot to initialize the actions to show the PySide documentation.</td>
356 </tr><tr>
357 <td><a href="#UserInterface.__initPythonDocActions">__initPythonDocActions</a></td>
358 <td>Private slot to initialize the actions to show the Python documentation.</td>
359 </tr><tr>
360 <td><a href="#UserInterface.__initQtDocActions">__initQtDocActions</a></td>
361 <td>Private slot to initialize the action to show the Qt documentation.</td>
362 </tr><tr>
363 <td><a href="#UserInterface.__initStatusbar">__initStatusbar</a></td>
364 <td>Private slot to set up the status bar.</td>
365 </tr><tr>
366 <td><a href="#UserInterface.__initToolbars">__initToolbars</a></td>
367 <td>Private slot to create the toolbars.</td>
368 </tr><tr>
369 <td><a href="#UserInterface.__initToolsMenus">__initToolsMenus</a></td>
370 <td>Private slot to initialize the various tool menus.</td>
371 </tr><tr>
372 <td><a href="#UserInterface.__installPlugins">__installPlugins</a></td>
373 <td>Private slot to show a dialog to install a new plugin.</td>
374 </tr><tr>
375 <td><a href="#UserInterface.__ircAutoConnected">__ircAutoConnected</a></td>
376 <td>Private slot handling the automatic connection of the IRC client.</td>
377 </tr><tr>
378 <td><a href="#UserInterface.__lastEditorClosed">__lastEditorClosed</a></td>
379 <td>Private slot to handle the lastEditorClosed signal.</td>
380 </tr><tr>
381 <td><a href="#UserInterface.__launchExternalWebBrowser">__launchExternalWebBrowser</a></td>
382 <td>Private method to start an external web browser and communicate with it.</td>
383 </tr><tr>
384 <td><a href="#UserInterface.__linguist">__linguist</a></td>
385 <td>Private slot to start the Qt-Linguist executable.</td>
386 </tr><tr>
387 <td><a href="#UserInterface.__linguist4">__linguist4</a></td>
388 <td>Private slot to start the Qt-Linguist 4/5 executable.</td>
389 </tr><tr>
390 <td><a href="#UserInterface.__loadSessionFromFile">__loadSessionFromFile</a></td>
391 <td>Private slot to load a session from disk.</td>
392 </tr><tr>
393 <td><a href="#UserInterface.__masterPasswordChanged">__masterPasswordChanged</a></td>
394 <td>Private slot to handle the change of the master password.</td>
395 </tr><tr>
396 <td><a href="#UserInterface.__newProject">__newProject</a></td>
397 <td>Private slot to handle the NewProject signal.</td>
398 </tr><tr>
399 <td><a href="#UserInterface.__newWindow">__newWindow</a></td>
400 <td>Private slot to start a new instance of eric6.</td>
401 </tr><tr>
402 <td><a href="#UserInterface.__onlineStateChanged">__onlineStateChanged</a></td>
403 <td>Private slot handling changes in online state.</td>
404 </tr><tr>
405 <td><a href="#UserInterface.__openHexEditor">__openHexEditor</a></td>
406 <td>Private slot to open the hex editor window.</td>
407 </tr><tr>
408 <td><a href="#UserInterface.__openMiniEditor">__openMiniEditor</a></td>
409 <td>Private slot to show a mini editor window.</td>
410 </tr><tr>
411 <td><a href="#UserInterface.__openOnStartup">__openOnStartup</a></td>
412 <td>Private method to open the last file, project or multiproject.</td>
413 </tr><tr>
414 <td><a href="#UserInterface.__pluginsConfigure">__pluginsConfigure</a></td>
415 <td>Private slot to show the plugin manager configuration page.</td>
416 </tr><tr>
417 <td><a href="#UserInterface.__populateToolbarsMenu">__populateToolbarsMenu</a></td>
418 <td>Private method to populate a toolbars menu.</td>
419 </tr><tr>
420 <td><a href="#UserInterface.__preferencesChanged">__preferencesChanged</a></td>
421 <td>Private slot to handle a change of the preferences.</td>
422 </tr><tr>
423 <td><a href="#UserInterface.__processToolStderr">__processToolStderr</a></td>
424 <td>Private slot to handle the readyReadStderr signal of a tool process.</td>
425 </tr><tr>
426 <td><a href="#UserInterface.__processToolStdout">__processToolStdout</a></td>
427 <td>Private slot to handle the readyReadStdout signal of a tool process.</td>
428 </tr><tr>
429 <td><a href="#UserInterface.__programChange">__programChange</a></td>
430 <td>Private slot to handle the programChange signal.</td>
431 </tr><tr>
432 <td><a href="#UserInterface.__projectClosed">__projectClosed</a></td>
433 <td>Private slot to handle the projectClosed signal.</td>
434 </tr><tr>
435 <td><a href="#UserInterface.__projectOpened">__projectOpened</a></td>
436 <td>Private slot to handle the projectOpened signal.</td>
437 </tr><tr>
438 <td><a href="#UserInterface.__quit">__quit</a></td>
439 <td>Private method to quit the application.</td>
440 </tr><tr>
441 <td><a href="#UserInterface.__readCrashSession">__readCrashSession</a></td>
442 <td>Private method to check for and read a crash session.</td>
443 </tr><tr>
444 <td><a href="#UserInterface.__readSession">__readSession</a></td>
445 <td>Private slot to read in the session file (.e5s or .e4s).</td>
446 </tr><tr>
447 <td><a href="#UserInterface.__readTasks">__readTasks</a></td>
448 <td>Private slot to read in the tasks file (.e6t).</td>
449 </tr><tr>
450 <td><a href="#UserInterface.__reloadAPIs">__reloadAPIs</a></td>
451 <td>Private slot to reload the api information.</td>
452 </tr><tr>
453 <td><a href="#UserInterface.__reportBug">__reportBug</a></td>
454 <td>Private slot to handle the Report Bug dialog.</td>
455 </tr><tr>
456 <td><a href="#UserInterface.__requestFeature">__requestFeature</a></td>
457 <td>Private slot to handle the Feature Request dialog.</td>
458 </tr><tr>
459 <td><a href="#UserInterface.__restart">__restart</a></td>
460 <td>Private method to restart the application.</td>
461 </tr><tr>
462 <td><a href="#UserInterface.__saveCurrentViewProfile">__saveCurrentViewProfile</a></td>
463 <td>Private slot to save the window geometries of the active profile.</td>
464 </tr><tr>
465 <td><a href="#UserInterface.__saveSessionToFile">__saveSessionToFile</a></td>
466 <td>Private slot to save a session to disk.</td>
467 </tr><tr>
468 <td><a href="#UserInterface.__setEditProfile">__setEditProfile</a></td>
469 <td>Private slot to activate the edit view profile.</td>
470 </tr><tr>
471 <td><a href="#UserInterface.__setWindowCaption">__setWindowCaption</a></td>
472 <td>Private method to set the caption of the Main Window.</td>
473 </tr><tr>
474 <td><a href="#UserInterface.__setupDockWindow">__setupDockWindow</a></td>
475 <td>Private method to configure the dock window created with __createDockWindow().</td>
476 </tr><tr>
477 <td><a href="#UserInterface.__showAvailableVersionInfos">__showAvailableVersionInfos</a></td>
478 <td>Private method to show the versions available for download.</td>
479 </tr><tr>
480 <td><a href="#UserInterface.__showCertificatesDialog">__showCertificatesDialog</a></td>
481 <td>Private slot to show the certificates management dialog.</td>
482 </tr><tr>
483 <td><a href="#UserInterface.__showEricDoc">__showEricDoc</a></td>
484 <td>Private slot to show the Eric documentation.</td>
485 </tr><tr>
486 <td><a href="#UserInterface.__showErrorLog">__showErrorLog</a></td>
487 <td>Private slot to show the most recent error log message.</td>
488 </tr><tr>
489 <td><a href="#UserInterface.__showExternalTools">__showExternalTools</a></td>
490 <td>Private slot to display a dialog show a list of external tools used by eric6.</td>
491 </tr><tr>
492 <td><a href="#UserInterface.__showExtrasMenu">__showExtrasMenu</a></td>
493 <td>Private slot to display the Extras menu.</td>
494 </tr><tr>
495 <td><a href="#UserInterface.__showFileMenu">__showFileMenu</a></td>
496 <td>Private slot to display the File menu.</td>
497 </tr><tr>
498 <td><a href="#UserInterface.__showHelpMenu">__showHelpMenu</a></td>
499 <td>Private slot to display the Help menu.</td>
500 </tr><tr>
501 <td><a href="#UserInterface.__showNext">__showNext</a></td>
502 <td>Private slot used to show the next tab or file.</td>
503 </tr><tr>
504 <td><a href="#UserInterface.__showPixmap">__showPixmap</a></td>
505 <td>Private slot to show a pixmap in a dialog.</td>
506 </tr><tr>
507 <td><a href="#UserInterface.__showPluginInfo">__showPluginInfo</a></td>
508 <td>Private slot to show the plugin info dialog.</td>
509 </tr><tr>
510 <td><a href="#UserInterface.__showPluginToolsMenu">__showPluginToolsMenu</a></td>
511 <td>Private slot to show the Plugin Tools menu.</td>
512 </tr><tr>
513 <td><a href="#UserInterface.__showPrevious">__showPrevious</a></td>
514 <td>Private slot used to show the previous tab or file.</td>
515 </tr><tr>
516 <td><a href="#UserInterface.__showPyQt4Doc">__showPyQt4Doc</a></td>
517 <td>Private slot to show the PyQt4 documentation.</td>
518 </tr><tr>
519 <td><a href="#UserInterface.__showPyQt5Doc">__showPyQt5Doc</a></td>
520 <td>Private slot to show the PyQt5 documentation.</td>
521 </tr><tr>
522 <td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td>
523 <td>Private slot to show the PySide/PySide2 documentation.</td>
524 </tr><tr>
525 <td><a href="#UserInterface.__showPython2Doc">__showPython2Doc</a></td>
526 <td>Private slot to show the Python 2 documentation.</td>
527 </tr><tr>
528 <td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td>
529 <td>Private slot to show the Python 3 documentation.</td>
530 </tr><tr>
531 <td><a href="#UserInterface.__showQt4Doc">__showQt4Doc</a></td>
532 <td>Private slot to show the Qt4 documentation.</td>
533 </tr><tr>
534 <td><a href="#UserInterface.__showQt5Doc">__showQt5Doc</a></td>
535 <td>Private slot to show the Qt5 documentation.</td>
536 </tr><tr>
537 <td><a href="#UserInterface.__showQtDoc">__showQtDoc</a></td>
538 <td>Private method to show the Qt documentation.</td>
539 </tr><tr>
540 <td><a href="#UserInterface.__showSettingsMenu">__showSettingsMenu</a></td>
541 <td>Private slot to show the Settings menu.</td>
542 </tr><tr>
543 <td><a href="#UserInterface.__showSubWindowMenu">__showSubWindowMenu</a></td>
544 <td>Private slot to display the Window menu of the Window menu.</td>
545 </tr><tr>
546 <td><a href="#UserInterface.__showSvg">__showSvg</a></td>
547 <td>Private slot to show a SVG file in a dialog.</td>
548 </tr><tr>
549 <td><a href="#UserInterface.__showSystemEmailClient">__showSystemEmailClient</a></td>
550 <td>Private slot to show the system email dialog.</td>
551 </tr><tr>
552 <td><a href="#UserInterface.__showToolGroupsMenu">__showToolGroupsMenu</a></td>
553 <td>Private slot to display the Tool Groups menu.</td>
554 </tr><tr>
555 <td><a href="#UserInterface.__showToolbarsMenu">__showToolbarsMenu</a></td>
556 <td>Private slot to display the Toolbars menu.</td>
557 </tr><tr>
558 <td><a href="#UserInterface.__showUserToolsMenu">__showUserToolsMenu</a></td>
559 <td>Private slot to display the User Tools menu.</td>
560 </tr><tr>
561 <td><a href="#UserInterface.__showVersions">__showVersions</a></td>
562 <td>Private slot to handle the Versions dialog.</td>
563 </tr><tr>
564 <td><a href="#UserInterface.__showWindowMenu">__showWindowMenu</a></td>
565 <td>Private slot to display the Window menu.</td>
566 </tr><tr>
567 <td><a href="#UserInterface.__showWizardsMenu">__showWizardsMenu</a></td>
568 <td>Private slot to display the Wizards menu.</td>
569 </tr><tr>
570 <td><a href="#UserInterface.__shutdown">__shutdown</a></td>
571 <td>Private method to perform all necessary steps to close down the IDE.</td>
572 </tr><tr>
573 <td><a href="#UserInterface.__snapshot">__snapshot</a></td>
574 <td>Private slot to start the snapshot tool.</td>
575 </tr><tr>
576 <td><a href="#UserInterface.__sqlBrowser">__sqlBrowser</a></td>
577 <td>Private slot to start the SQL browser tool.</td>
578 </tr><tr>
579 <td><a href="#UserInterface.__sslErrors">__sslErrors</a></td>
580 <td>Private slot to handle SSL errors.</td>
581 </tr><tr>
582 <td><a href="#UserInterface.__startToolProcess">__startToolProcess</a></td>
583 <td>Private slot to start an external tool process.</td>
584 </tr><tr>
585 <td><a href="#UserInterface.__startWebBrowser">__startWebBrowser</a></td>
586 <td>Private slot to start the eric6 web browser.</td>
587 </tr><tr>
588 <td><a href="#UserInterface.__switchTab">__switchTab</a></td>
589 <td>Private slot used to switch between the current and the previous current tab.</td>
590 </tr><tr>
591 <td><a href="#UserInterface.__toggleBottomSidebar">__toggleBottomSidebar</a></td>
592 <td>Private slot to handle the toggle of the bottom sidebar window.</td>
593 </tr><tr>
594 <td><a href="#UserInterface.__toggleHorizontalToolbox">__toggleHorizontalToolbox</a></td>
595 <td>Private slot to handle the toggle of the Horizontal Toolbox window.</td>
596 </tr><tr>
597 <td><a href="#UserInterface.__toggleLeftSidebar">__toggleLeftSidebar</a></td>
598 <td>Private slot to handle the toggle of the left sidebar window.</td>
599 </tr><tr>
600 <td><a href="#UserInterface.__toggleLeftToolbox">__toggleLeftToolbox</a></td>
601 <td>Private slot to handle the toggle of the Left Toolbox window.</td>
602 </tr><tr>
603 <td><a href="#UserInterface.__toggleRightSidebar">__toggleRightSidebar</a></td>
604 <td>Private slot to handle the toggle of the right sidebar window.</td>
605 </tr><tr>
606 <td><a href="#UserInterface.__toggleRightToolbox">__toggleRightToolbox</a></td>
607 <td>Private slot to handle the toggle of the Right Toolbox window.</td>
608 </tr><tr>
609 <td><a href="#UserInterface.__toggleWindow">__toggleWindow</a></td>
610 <td>Private method to toggle a workspace editor window.</td>
611 </tr><tr>
612 <td><a href="#UserInterface.__toolActionTriggered">__toolActionTriggered</a></td>
613 <td>Private slot called by external tools toolbar actions.</td>
614 </tr><tr>
615 <td><a href="#UserInterface.__toolExecute">__toolExecute</a></td>
616 <td>Private slot to execute a particular tool.</td>
617 </tr><tr>
618 <td><a href="#UserInterface.__toolFinished">__toolFinished</a></td>
619 <td>Private slot to handle the finished signal of a tool process.</td>
620 </tr><tr>
621 <td><a href="#UserInterface.__toolGroupSelected">__toolGroupSelected</a></td>
622 <td>Private slot to set the current tool group.</td>
623 </tr><tr>
624 <td><a href="#UserInterface.__toolGroupsConfiguration">__toolGroupsConfiguration</a></td>
625 <td>Private slot to handle the tool groups configuration menu entry.</td>
626 </tr><tr>
627 <td><a href="#UserInterface.__toolsConfiguration">__toolsConfiguration</a></td>
628 <td>Private slot to handle the tools configuration menu entry.</td>
629 </tr><tr>
630 <td><a href="#UserInterface.__unittest">__unittest</a></td>
631 <td>Private slot for displaying the unittest dialog.</td>
632 </tr><tr>
633 <td><a href="#UserInterface.__unittestProject">__unittestProject</a></td>
634 <td>Private slot for displaying the unittest dialog and run the current project.</td>
635 </tr><tr>
636 <td><a href="#UserInterface.__unittestRerunFailed">__unittestRerunFailed</a></td>
637 <td>Private slot to display the unittest dialog and rerun all failed tests of the last run.</td>
638 </tr><tr>
639 <td><a href="#UserInterface.__unittestRestart">__unittestRestart</a></td>
640 <td>Private slot to display the unittest dialog and rerun the last unit test.</td>
641 </tr><tr>
642 <td><a href="#UserInterface.__unittestScript">__unittestScript</a></td>
643 <td>Private slot for displaying the unittest dialog and run the current script.</td>
644 </tr><tr>
645 <td><a href="#UserInterface.__unittestStopped">__unittestStopped</a></td>
646 <td>Private slot to handle the end of a unit test run.</td>
647 </tr><tr>
648 <td><a href="#UserInterface.__updateExternalToolsActions">__updateExternalToolsActions</a></td>
649 <td>Private method to update the external tools actions for the current tool group.</td>
650 </tr><tr>
651 <td><a href="#UserInterface.__updateVersionsUrls">__updateVersionsUrls</a></td>
652 <td>Private method to update the URLs from which to retrieve the versions file.</td>
653 </tr><tr>
654 <td><a href="#UserInterface.__versionCheckResult">__versionCheckResult</a></td>
655 <td>Private method to show the result of the version check action.</td>
656 </tr><tr>
657 <td><a href="#UserInterface.__versionToTuple">__versionToTuple</a></td>
658 <td>Private method to convert a version string into a tuple.</td>
659 </tr><tr>
660 <td><a href="#UserInterface.__versionsDownloadCanceled">__versionsDownloadCanceled</a></td>
661 <td>Private slot called to cancel the version check.</td>
662 </tr><tr>
663 <td><a href="#UserInterface.__versionsDownloadDone">__versionsDownloadDone</a></td>
664 <td>Private slot called, after the versions file has been downloaded from the internet.</td>
665 </tr><tr>
666 <td><a href="#UserInterface.__webBrowser">__webBrowser</a></td>
667 <td>Private slot to start the eric6 web browser.</td>
668 </tr><tr>
669 <td><a href="#UserInterface.__webBrowserFinished">__webBrowserFinished</a></td>
670 <td>Private slot handling the end of the external web browser process.</td>
671 </tr><tr>
672 <td><a href="#UserInterface.__webBrowserShutdown">__webBrowserShutdown</a></td>
673 <td>Private method to shut down the web browser.</td>
674 </tr><tr>
675 <td><a href="#UserInterface.__whatsThis">__whatsThis</a></td>
676 <td>Private slot called in to enter Whats This mode.</td>
677 </tr><tr>
678 <td><a href="#UserInterface.__writeCrashSession">__writeCrashSession</a></td>
679 <td>Private slot to write a crash session file.</td>
680 </tr><tr>
681 <td><a href="#UserInterface.__writeSession">__writeSession</a></td>
682 <td>Private slot to write the session data to an XML file (.e5s).</td>
683 </tr><tr>
684 <td><a href="#UserInterface.__writeTasks">__writeTasks</a></td>
685 <td>Private slot to write the tasks data to an XML file (.e6t).</td>
686 </tr><tr>
687 <td><a href="#UserInterface.activateCodeDocumentationViewer">activateCodeDocumentationViewer</a></td>
688 <td>Public slot to handle the activation of the Code Documentation Viewer.</td>
689 </tr><tr>
690 <td><a href="#UserInterface.activateCooperationViewer">activateCooperationViewer</a></td>
691 <td>Public slot to handle the activation of the cooperation window.</td>
692 </tr><tr>
693 <td><a href="#UserInterface.activateDebugViewer">activateDebugViewer</a></td>
694 <td>Public slot to handle the activation of the debug viewer.</td>
695 </tr><tr>
696 <td><a href="#UserInterface.addE5Actions">addE5Actions</a></td>
697 <td>Public method to add actions to the list of actions.</td>
698 </tr><tr>
699 <td><a href="#UserInterface.addSideWidget">addSideWidget</a></td>
700 <td>Public method to add a widget to the sides.</td>
701 </tr><tr>
702 <td><a href="#UserInterface.appendToStderr">appendToStderr</a></td>
703 <td>Public slot to append text to the stderr log viewer tab.</td>
704 </tr><tr>
705 <td><a href="#UserInterface.appendToStdout">appendToStdout</a></td>
706 <td>Public slot to append text to the stdout log viewer tab.</td>
707 </tr><tr>
708 <td><a href="#UserInterface.autoConnectIrc">autoConnectIrc</a></td>
709 <td>Public method to initiate the IRC auto connection.</td>
710 </tr><tr>
711 <td><a href="#UserInterface.checkConfigurationStatus">checkConfigurationStatus</a></td>
712 <td>Public method to check, if eric6 has been configured.</td>
713 </tr><tr>
714 <td><a href="#UserInterface.checkForErrorLog">checkForErrorLog</a></td>
715 <td>Public method to check for the presence of an error log and ask the user, what to do with it.</td>
716 </tr><tr>
717 <td><a href="#UserInterface.checkPluginUpdatesAvailable">checkPluginUpdatesAvailable</a></td>
718 <td>Public method to check the availability of updates of plug-ins.</td>
719 </tr><tr>
720 <td><a href="#UserInterface.checkProjectsWorkspace">checkProjectsWorkspace</a></td>
721 <td>Public method to check, if a projects workspace has been configured.</td>
722 </tr><tr>
723 <td><a href="#UserInterface.closeEvent">closeEvent</a></td>
724 <td>Protected event handler for the close event.</td>
725 </tr><tr>
726 <td><a href="#UserInterface.createPopupMenu">createPopupMenu</a></td>
727 <td>Public method to create the toolbars menu for Qt.</td>
728 </tr><tr>
729 <td><a href="#UserInterface.documentationViewer">documentationViewer</a></td>
730 <td>Public method to provide a reference to the code documentation viewer.</td>
731 </tr><tr>
732 <td><a href="#UserInterface.dragEnterEvent">dragEnterEvent</a></td>
733 <td>Protected method to handle the drag enter event.</td>
734 </tr><tr>
735 <td><a href="#UserInterface.dragLeaveEvent">dragLeaveEvent</a></td>
736 <td>Protected method to handle the drag leave event.</td>
737 </tr><tr>
738 <td><a href="#UserInterface.dragMoveEvent">dragMoveEvent</a></td>
739 <td>Protected method to handle the drag move event.</td>
740 </tr><tr>
741 <td><a href="#UserInterface.dropEvent">dropEvent</a></td>
742 <td>Protected method to handle the drop event.</td>
743 </tr><tr>
744 <td><a href="#UserInterface.getActions">getActions</a></td>
745 <td>Public method to get a list of all actions.</td>
746 </tr><tr>
747 <td><a href="#UserInterface.getLayoutType">getLayoutType</a></td>
748 <td>Public method to get the current layout type.</td>
749 </tr><tr>
750 <td><a href="#UserInterface.getLocale">getLocale</a></td>
751 <td>Public method to get the locale of the IDE.</td>
752 </tr><tr>
753 <td><a href="#UserInterface.getMenu">getMenu</a></td>
754 <td>Public method to get a reference to a specific menu.</td>
755 </tr><tr>
756 <td><a href="#UserInterface.getMenuAction">getMenuAction</a></td>
757 <td>Public method to get a reference to an action of a menu.</td>
758 </tr><tr>
759 <td><a href="#UserInterface.getMenuBarAction">getMenuBarAction</a></td>
760 <td>Public method to get a reference to an action of the main menu.</td>
761 </tr><tr>
762 <td><a href="#UserInterface.getOriginalPathString">getOriginalPathString</a></td>
763 <td>Public method to get the original PATH environment variable (i.e.</td>
764 </tr><tr>
765 <td><a href="#UserInterface.getToolBarIconSize">getToolBarIconSize</a></td>
766 <td>Public method to get the toolbar icon size.</td>
767 </tr><tr>
768 <td><a href="#UserInterface.getToolbar">getToolbar</a></td>
769 <td>Public method to get a reference to a specific toolbar.</td>
770 </tr><tr>
771 <td><a href="#UserInterface.getViewProfile">getViewProfile</a></td>
772 <td>Public method to get the current view profile.</td>
773 </tr><tr>
774 <td><a href="#UserInterface.handleUrl">handleUrl</a></td>
775 <td>Public slot to handle opening a URL.</td>
776 </tr><tr>
777 <td><a href="#UserInterface.isOnline">isOnline</a></td>
778 <td>Public method to get the online state.</td>
779 </tr><tr>
780 <td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td>
781 <td>Public slot to start the help viewer/web browser.</td>
782 </tr><tr>
783 <td><a href="#UserInterface.notificationsEnabled">notificationsEnabled</a></td>
784 <td>Public method to check, if notifications are enabled.</td>
785 </tr><tr>
786 <td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td>
787 <td>Public method to check the internet for an eric6 update.</td>
788 </tr><tr>
789 <td><a href="#UserInterface.processArgs">processArgs</a></td>
790 <td>Public method to process the command line args passed to the UI.</td>
791 </tr><tr>
792 <td><a href="#UserInterface.registerToolbar">registerToolbar</a></td>
793 <td>Public method to register a toolbar.</td>
794 </tr><tr>
795 <td><a href="#UserInterface.removeE5Actions">removeE5Actions</a></td>
796 <td>Public method to remove actions from the list of actions.</td>
797 </tr><tr>
798 <td><a href="#UserInterface.removeSideWidget">removeSideWidget</a></td>
799 <td>Public method to remove a widget added using addSideWidget().</td>
800 </tr><tr>
801 <td><a href="#UserInterface.reregisterToolbar">reregisterToolbar</a></td>
802 <td>Public method to change the visible text for the named toolbar.</td>
803 </tr><tr>
804 <td><a href="#UserInterface.setDebugProfile">setDebugProfile</a></td>
805 <td>Public slot to activate the debug view profile.</td>
806 </tr><tr>
807 <td><a href="#UserInterface.showAvailableVersionsInfo">showAvailableVersionsInfo</a></td>
808 <td>Public method to show the eric6 versions available for download.</td>
809 </tr><tr>
810 <td><a href="#UserInterface.showEmailDialog">showEmailDialog</a></td>
811 <td>Public slot to show the email dialog in a given mode.</td>
812 </tr><tr>
813 <td><a href="#UserInterface.showEvent">showEvent</a></td>
814 <td>Protected method to handle the show event.</td>
815 </tr><tr>
816 <td><a href="#UserInterface.showFindFileByNameDialog">showFindFileByNameDialog</a></td>
817 <td>Public slot to show the Find File by Name dialog.</td>
818 </tr><tr>
819 <td><a href="#UserInterface.showFindFilesDialog">showFindFilesDialog</a></td>
820 <td>Public slot to show the Find In Files dialog.</td>
821 </tr><tr>
822 <td><a href="#UserInterface.showLogViewer">showLogViewer</a></td>
823 <td>Public method to show the Log-Viewer.</td>
824 </tr><tr>
825 <td><a href="#UserInterface.showNotification">showNotification</a></td>
826 <td>Public method to show a desktop notification.</td>
827 </tr><tr>
828 <td><a href="#UserInterface.showPluginsAvailable">showPluginsAvailable</a></td>
829 <td>Public slot to show the plugins available for download.</td>
830 </tr><tr>
831 <td><a href="#UserInterface.showPreferences">showPreferences</a></td>
832 <td>Public slot to set the preferences.</td>
833 </tr><tr>
834 <td><a href="#UserInterface.showReplaceFilesDialog">showReplaceFilesDialog</a></td>
835 <td>Public slot to show the Find & Replace In Files dialog.</td>
836 </tr><tr>
837 <td><a href="#UserInterface.unregisterToolbar">unregisterToolbar</a></td>
838 <td>Public method to unregister a toolbar.</td>
839 </tr><tr>
840 <td><a href="#UserInterface.versionIsNewer">versionIsNewer</a></td>
841 <td>Public method to check, if the eric6 version is good compared to the required version.</td>
842 </tr>
843 </table>
844 <h3>Static Methods</h3>
845 <table>
846 <tr><td>None</td></tr>
847 </table>
848 <a NAME="UserInterface.__init__" ID="UserInterface.__init__"></a>
849 <h4>UserInterface (Constructor)</h4>
850 <b>UserInterface</b>(<i>app, locale, splash, plugin, disabledPlugins, noOpenAtStartup, noCrashOpenAtStartup, disableCrashSession, restartArguments, originalPathString</i>)
851 <p>
852 Constructor
853 </p><dl>
854 <dt><i>app</i> (E5Application)</dt>
855 <dd>
856 reference to the application object
857 </dd><dt><i>locale</i> (str)</dt>
858 <dd>
859 locale to be used by the UI
860 </dd><dt><i>splash</i> (UI.SplashScreen.SplashScreen)</dt>
861 <dd>
862 reference to the splashscreen
863 </dd><dt><i>plugin</i> (str)</dt>
864 <dd>
865 filename of a plug-in to be loaded (used for plugin
866 development)
867 </dd><dt><i>disabledPlugins</i> (list of str)</dt>
868 <dd>
869 list of plug-ins that have been disabled via
870 the command line parameters '--disable-plugin='
871 </dd><dt><i>noOpenAtStartup</i> (bool)</dt>
872 <dd>
873 flag indicating that the open at startup option
874 should not be executed
875 </dd><dt><i>noCrashOpenAtStartup</i> (bool)</dt>
876 <dd>
877 flag indicating to ignore any crash session
878 file found at statup
879 </dd><dt><i>disableCrashSession</i> (bool)</dt>
880 <dd>
881 flag indicating to disable the crash session
882 support
883 </dd><dt><i>restartArguments</i> (list of str)</dt>
884 <dd>
885 list of command line parameters to be used for
886 a restart
887 </dd><dt><i>originalPathString</i> (str)</dt>
888 <dd>
889 original PATH environment variable
890 </dd>
891 </dl><a NAME="UserInterface.__TBMenuTriggered" ID="UserInterface.__TBMenuTriggered"></a>
892 <h4>UserInterface.__TBMenuTriggered</h4>
893 <b>__TBMenuTriggered</b>(<i>act</i>)
894 <p>
895 Private method to handle the toggle of a toolbar via the Window->
896 Toolbars submenu.
897 </p><dl>
898 <dt><i>act</i></dt>
899 <dd>
900 reference to the action that was triggered (QAction)
901 </dd>
902 </dl><a NAME="UserInterface.__TBPopupMenuTriggered" ID="UserInterface.__TBPopupMenuTriggered"></a>
903 <h4>UserInterface.__TBPopupMenuTriggered</h4>
904 <b>__TBPopupMenuTriggered</b>(<i>act</i>)
905 <p>
906 Private method to handle the toggle of a toolbar via the QMainWindow
907 Toolbars popup menu.
908 </p><dl>
909 <dt><i>act</i></dt>
910 <dd>
911 reference to the action that was triggered (QAction)
912 </dd>
913 </dl><a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a>
914 <h4>UserInterface.__TRPreviewer</h4>
915 <b>__TRPreviewer</b>(<i>fileNames=None, ignore=False</i>)
916 <p>
917 Private slot to start the Translation Previewer executable.
918 </p><dl>
919 <dt><i>fileNames</i></dt>
920 <dd>
921 filenames of forms and/or translations to be previewed
922 (list of strings)
923 </dd><dt><i>ignore</i></dt>
924 <dd>
925 flag indicating non existing files should be ignored
926 (boolean)
927 </dd>
928 </dl><a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a>
929 <h4>UserInterface.__UIPreviewer</h4>
930 <b>__UIPreviewer</b>(<i>fn=None</i>)
931 <p>
932 Private slot to start the UI Previewer executable.
933 </p><dl>
934 <dt><i>fn</i></dt>
935 <dd>
936 filename of the form to be previewed (string)
937 </dd>
938 </dl><a NAME="UserInterface.__activateBrowser" ID="UserInterface.__activateBrowser"></a>
939 <h4>UserInterface.__activateBrowser</h4>
940 <b>__activateBrowser</b>(<i></i>)
941 <p>
942 Private slot to handle the activation of the file browser.
943 </p><a NAME="UserInterface.__activateCondaWidget" ID="UserInterface.__activateCondaWidget"></a>
944 <h4>UserInterface.__activateCondaWidget</h4>
945 <b>__activateCondaWidget</b>(<i></i>)
946 <p>
947 Private slot to handle the activation of the Conda manager widget.
948 </p><a NAME="UserInterface.__activateIRC" ID="UserInterface.__activateIRC"></a>
949 <h4>UserInterface.__activateIRC</h4>
950 <b>__activateIRC</b>(<i></i>)
951 <p>
952 Private slot to handle the activation of the IRC window.
953 </p><a NAME="UserInterface.__activateLogViewer" ID="UserInterface.__activateLogViewer"></a>
954 <h4>UserInterface.__activateLogViewer</h4>
955 <b>__activateLogViewer</b>(<i></i>)
956 <p>
957 Private slot to handle the activation of the Log Viewer.
958 </p><a NAME="UserInterface.__activateMultiProjectBrowser" ID="UserInterface.__activateMultiProjectBrowser"></a>
959 <h4>UserInterface.__activateMultiProjectBrowser</h4>
960 <b>__activateMultiProjectBrowser</b>(<i></i>)
961 <p>
962 Private slot to handle the activation of the project browser.
963 </p><a NAME="UserInterface.__activateNumbersViewer" ID="UserInterface.__activateNumbersViewer"></a>
964 <h4>UserInterface.__activateNumbersViewer</h4>
965 <b>__activateNumbersViewer</b>(<i></i>)
966 <p>
967 Private slot to handle the activation of the Numbers Viewer.
968 </p><a NAME="UserInterface.__activatePipWidget" ID="UserInterface.__activatePipWidget"></a>
969 <h4>UserInterface.__activatePipWidget</h4>
970 <b>__activatePipWidget</b>(<i></i>)
971 <p>
972 Private slot to handle the activation of the PyPI manager widget.
973 </p><a NAME="UserInterface.__activateProjectBrowser" ID="UserInterface.__activateProjectBrowser"></a>
974 <h4>UserInterface.__activateProjectBrowser</h4>
975 <b>__activateProjectBrowser</b>(<i></i>)
976 <p>
977 Private slot to handle the activation of the project browser.
978 </p><a NAME="UserInterface.__activateShell" ID="UserInterface.__activateShell"></a>
979 <h4>UserInterface.__activateShell</h4>
980 <b>__activateShell</b>(<i></i>)
981 <p>
982 Private slot to handle the activation of the Shell window.
983 </p><a NAME="UserInterface.__activateSymbolsViewer" ID="UserInterface.__activateSymbolsViewer"></a>
984 <h4>UserInterface.__activateSymbolsViewer</h4>
985 <b>__activateSymbolsViewer</b>(<i></i>)
986 <p>
987 Private slot to handle the activation of the Symbols Viewer.
988 </p><a NAME="UserInterface.__activateTaskViewer" ID="UserInterface.__activateTaskViewer"></a>
989 <h4>UserInterface.__activateTaskViewer</h4>
990 <b>__activateTaskViewer</b>(<i></i>)
991 <p>
992 Private slot to handle the activation of the Task Viewer.
993 </p><a NAME="UserInterface.__activateTemplateViewer" ID="UserInterface.__activateTemplateViewer"></a>
994 <h4>UserInterface.__activateTemplateViewer</h4>
995 <b>__activateTemplateViewer</b>(<i></i>)
996 <p>
997 Private slot to handle the activation of the Template Viewer.
998 </p><a NAME="UserInterface.__activateViewProfile" ID="UserInterface.__activateViewProfile"></a>
999 <h4>UserInterface.__activateViewProfile</h4>
1000 <b>__activateViewProfile</b>(<i>name, save=True</i>)
1001 <p>
1002 Private slot to activate a view profile.
1003 </p><dl>
1004 <dt><i>name</i></dt>
1005 <dd>
1006 name of the profile to be activated (string)
1007 </dd><dt><i>save</i></dt>
1008 <dd>
1009 flag indicating that the current profile should
1010 be saved (boolean)
1011 </dd>
1012 </dl><a NAME="UserInterface.__activateViewmanager" ID="UserInterface.__activateViewmanager"></a>
1013 <h4>UserInterface.__activateViewmanager</h4>
1014 <b>__activateViewmanager</b>(<i></i>)
1015 <p>
1016 Private slot to handle the activation of the current editor.
1017 </p><a NAME="UserInterface.__assistant" ID="UserInterface.__assistant"></a>
1018 <h4>UserInterface.__assistant</h4>
1019 <b>__assistant</b>(<i>home=None, version=0</i>)
1020 <p>
1021 Private slot to start the Qt-Assistant executable.
1022 </p><dl>
1023 <dt><i>home</i> (str)</dt>
1024 <dd>
1025 full pathname of a file to display
1026 </dd><dt><i>version</i> (int)</dt>
1027 <dd>
1028 indication for the requested version (4 = Qt 4/5)
1029 </dd>
1030 </dl><a NAME="UserInterface.__assistant4" ID="UserInterface.__assistant4"></a>
1031 <h4>UserInterface.__assistant4</h4>
1032 <b>__assistant4</b>(<i></i>)
1033 <p>
1034 Private slot to start the Qt-Assistant 4/5 executable.
1035 </p><a NAME="UserInterface.__checkActions" ID="UserInterface.__checkActions"></a>
1036 <h4>UserInterface.__checkActions</h4>
1037 <b>__checkActions</b>(<i>editor</i>)
1038 <p>
1039 Private slot to check some actions for their enable/disable status.
1040 </p><dl>
1041 <dt><i>editor</i></dt>
1042 <dd>
1043 editor window
1044 </dd>
1045 </dl><a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a>
1046 <h4>UserInterface.__chmViewer</h4>
1047 <b>__chmViewer</b>(<i>home=None</i>)
1048 <p>
1049 Private slot to start the win help viewer to show *.chm files.
1050 </p><dl>
1051 <dt><i>home</i></dt>
1052 <dd>
1053 full pathname of a file to display (string)
1054 </dd>
1055 </dl><a NAME="UserInterface.__clearPrivateData" ID="UserInterface.__clearPrivateData"></a>
1056 <h4>UserInterface.__clearPrivateData</h4>
1057 <b>__clearPrivateData</b>(<i></i>)
1058 <p>
1059 Private slot to clear the private data lists.
1060 </p><a NAME="UserInterface.__compareFiles" ID="UserInterface.__compareFiles"></a>
1061 <h4>UserInterface.__compareFiles</h4>
1062 <b>__compareFiles</b>(<i></i>)
1063 <p>
1064 Private slot to handle the Compare Files dialog.
1065 </p><a NAME="UserInterface.__compareFilesSbs" ID="UserInterface.__compareFilesSbs"></a>
1066 <h4>UserInterface.__compareFilesSbs</h4>
1067 <b>__compareFilesSbs</b>(<i></i>)
1068 <p>
1069 Private slot to handle the Compare Files dialog.
1070 </p><a NAME="UserInterface.__configShortcuts" ID="UserInterface.__configShortcuts"></a>
1071 <h4>UserInterface.__configShortcuts</h4>
1072 <b>__configShortcuts</b>(<i></i>)
1073 <p>
1074 Private slot to configure the keyboard shortcuts.
1075 </p><a NAME="UserInterface.__configToolBars" ID="UserInterface.__configToolBars"></a>
1076 <h4>UserInterface.__configToolBars</h4>
1077 <b>__configToolBars</b>(<i></i>)
1078 <p>
1079 Private slot to configure the various toolbars.
1080 </p><a NAME="UserInterface.__configViewProfiles" ID="UserInterface.__configViewProfiles"></a>
1081 <h4>UserInterface.__configViewProfiles</h4>
1082 <b>__configViewProfiles</b>(<i></i>)
1083 <p>
1084 Private slot to configure the various view profiles.
1085 </p><a NAME="UserInterface.__connectToWebBrowser" ID="UserInterface.__connectToWebBrowser"></a>
1086 <h4>UserInterface.__connectToWebBrowser</h4>
1087 <b>__connectToWebBrowser</b>(<i>process</i>)
1088 <p>
1089 Private method to connect to a started web browser.
1090 </p><dl>
1091 <dt><i>process</i> (QProcess)</dt>
1092 <dd>
1093 reference to the started web browser process
1094 </dd>
1095 </dl><dl>
1096 <dt>Returns:</dt>
1097 <dd>
1098 error indication (1 = connection not possible, 0 = ok,
1099 -1 = server exited with an error code)
1100 </dd>
1101 </dl><dl>
1102 <dt>Return Type:</dt>
1103 <dd>
1104 int
1105 </dd>
1106 </dl><a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a>
1107 <h4>UserInterface.__createDockWindow</h4>
1108 <b>__createDockWindow</b>(<i>name</i>)
1109 <p>
1110 Private method to create a dock window with common properties.
1111 </p><dl>
1112 <dt><i>name</i></dt>
1113 <dd>
1114 object name of the new dock window (string)
1115 </dd>
1116 </dl><dl>
1117 <dt>Returns:</dt>
1118 <dd>
1119 the generated dock window (QDockWindow)
1120 </dd>
1121 </dl><a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a>
1122 <h4>UserInterface.__createLayout</h4>
1123 <b>__createLayout</b>(<i>debugServer</i>)
1124 <p>
1125 Private method to create the layout of the various windows.
1126 </p><dl>
1127 <dt><i>debugServer</i></dt>
1128 <dd>
1129 reference to the debug server object
1130 </dd>
1131 </dl><dl>
1132 <dt>Raises <b>ValueError</b>:</dt>
1133 <dd>
1134 raised to indicate an invalid layout type
1135 </dd>
1136 </dl><a NAME="UserInterface.__createSidebarsLayout" ID="UserInterface.__createSidebarsLayout"></a>
1137 <h4>UserInterface.__createSidebarsLayout</h4>
1138 <b>__createSidebarsLayout</b>(<i>debugServer</i>)
1139 <p>
1140 Private method to create the Sidebars layout.
1141 </p><dl>
1142 <dt><i>debugServer</i></dt>
1143 <dd>
1144 reference to the debug server object
1145 </dd>
1146 </dl><a NAME="UserInterface.__createToolboxesLayout" ID="UserInterface.__createToolboxesLayout"></a>
1147 <h4>UserInterface.__createToolboxesLayout</h4>
1148 <b>__createToolboxesLayout</b>(<i>debugServer</i>)
1149 <p>
1150 Private method to create the Toolboxes layout.
1151 </p><dl>
1152 <dt><i>debugServer</i></dt>
1153 <dd>
1154 reference to the debug server object
1155 </dd>
1156 </dl><a NAME="UserInterface.__createUnitTestDialog" ID="UserInterface.__createUnitTestDialog"></a>
1157 <h4>UserInterface.__createUnitTestDialog</h4>
1158 <b>__createUnitTestDialog</b>(<i></i>)
1159 <p>
1160 Private slot to generate the unit test dialog on demand.
1161 </p><a NAME="UserInterface.__customViewer" ID="UserInterface.__customViewer"></a>
1162 <h4>UserInterface.__customViewer</h4>
1163 <b>__customViewer</b>(<i>home=None</i>)
1164 <p>
1165 Private slot to start a custom viewer.
1166 </p><dl>
1167 <dt><i>home</i></dt>
1168 <dd>
1169 full pathname of a file to display (string)
1170 </dd>
1171 </dl><a NAME="UserInterface.__debuggingDone" ID="UserInterface.__debuggingDone"></a>
1172 <h4>UserInterface.__debuggingDone</h4>
1173 <b>__debuggingDone</b>(<i></i>)
1174 <p>
1175 Private slot to handle the end of a debugging session.
1176 </p><a NAME="UserInterface.__debuggingStarted" ID="UserInterface.__debuggingStarted"></a>
1177 <h4>UserInterface.__debuggingStarted</h4>
1178 <b>__debuggingStarted</b>(<i></i>)
1179 <p>
1180 Private slot to handle the start of a debugging session.
1181 </p><a NAME="UserInterface.__deinstallPlugin" ID="UserInterface.__deinstallPlugin"></a>
1182 <h4>UserInterface.__deinstallPlugin</h4>
1183 <b>__deinstallPlugin</b>(<i></i>)
1184 <p>
1185 Private slot to show a dialog to uninstall a plugin.
1186 </p><a NAME="UserInterface.__deleteCrashSession" ID="UserInterface.__deleteCrashSession"></a>
1187 <h4>UserInterface.__deleteCrashSession</h4>
1188 <b>__deleteCrashSession</b>(<i></i>)
1189 <p>
1190 Private slot to delete the crash session file.
1191 </p><a NAME="UserInterface.__designer" ID="UserInterface.__designer"></a>
1192 <h4>UserInterface.__designer</h4>
1193 <b>__designer</b>(<i>fn=None, version=0</i>)
1194 <p>
1195 Private slot to start the Qt-Designer executable.
1196 </p><dl>
1197 <dt><i>fn</i> (str)</dt>
1198 <dd>
1199 filename of the form to be opened
1200 </dd><dt><i>version</i> (int)</dt>
1201 <dd>
1202 indication for the requested version (4 = Qt 4/5)
1203 </dd>
1204 </dl><a NAME="UserInterface.__designer4" ID="UserInterface.__designer4"></a>
1205 <h4>UserInterface.__designer4</h4>
1206 <b>__designer4</b>(<i></i>)
1207 <p>
1208 Private slot to start the Qt-Designer 4/5 executable.
1209 </p><a NAME="UserInterface.__editPixmap" ID="UserInterface.__editPixmap"></a>
1210 <h4>UserInterface.__editPixmap</h4>
1211 <b>__editPixmap</b>(<i>fn=""</i>)
1212 <p>
1213 Private slot to show a pixmap in a dialog.
1214 </p><dl>
1215 <dt><i>fn</i></dt>
1216 <dd>
1217 filename of the file to show (string)
1218 </dd>
1219 </dl><a NAME="UserInterface.__editorOpened" ID="UserInterface.__editorOpened"></a>
1220 <h4>UserInterface.__editorOpened</h4>
1221 <b>__editorOpened</b>(<i>fn</i>)
1222 <p>
1223 Private slot to handle the editorOpened signal.
1224 </p><dl>
1225 <dt><i>fn</i></dt>
1226 <dd>
1227 filename of the opened editor (string)
1228 </dd>
1229 </dl><a NAME="UserInterface.__exportPreferences" ID="UserInterface.__exportPreferences"></a>
1230 <h4>UserInterface.__exportPreferences</h4>
1231 <b>__exportPreferences</b>(<i></i>)
1232 <p>
1233 Private slot to export the current preferences.
1234 </p><a NAME="UserInterface.__exportShortcuts" ID="UserInterface.__exportShortcuts"></a>
1235 <h4>UserInterface.__exportShortcuts</h4>
1236 <b>__exportShortcuts</b>(<i></i>)
1237 <p>
1238 Private slot to export the keyboard shortcuts.
1239 </p><a NAME="UserInterface.__getFloatingGeometry" ID="UserInterface.__getFloatingGeometry"></a>
1240 <h4>UserInterface.__getFloatingGeometry</h4>
1241 <b>__getFloatingGeometry</b>(<i>w</i>)
1242 <p>
1243 Private method to get the geometry of a floating windows.
1244 </p><dl>
1245 <dt><i>w</i></dt>
1246 <dd>
1247 reference to the widget to be saved (QWidget)
1248 </dd>
1249 </dl><dl>
1250 <dt>Returns:</dt>
1251 <dd>
1252 list giving the widget's geometry and its visibility
1253 </dd>
1254 </dl><a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a>
1255 <h4>UserInterface.__hasErrorLog</h4>
1256 <b>__hasErrorLog</b>(<i></i>)
1257 <p>
1258 Private method to check, if an error log file exists.
1259 </p><dl>
1260 <dt>Returns:</dt>
1261 <dd>
1262 flag indicating the existence of an error log file (boolean)
1263 </dd>
1264 </dl><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
1265 <h4>UserInterface.__helpViewer</h4>
1266 <b>__helpViewer</b>(<i></i>)
1267 <p>
1268 Private slot to start an empty help viewer/web browser.
1269 </p><a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a>
1270 <h4>UserInterface.__importPreferences</h4>
1271 <b>__importPreferences</b>(<i></i>)
1272 <p>
1273 Private slot to import preferences.
1274 </p><a NAME="UserInterface.__importShortcuts" ID="UserInterface.__importShortcuts"></a>
1275 <h4>UserInterface.__importShortcuts</h4>
1276 <b>__importShortcuts</b>(<i></i>)
1277 <p>
1278 Private slot to import the keyboard shortcuts.
1279 </p><a NAME="UserInterface.__initActions" ID="UserInterface.__initActions"></a>
1280 <h4>UserInterface.__initActions</h4>
1281 <b>__initActions</b>(<i></i>)
1282 <p>
1283 Private method to define the user interface actions.
1284 </p><a NAME="UserInterface.__initDebugToolbarsLayout" ID="UserInterface.__initDebugToolbarsLayout"></a>
1285 <h4>UserInterface.__initDebugToolbarsLayout</h4>
1286 <b>__initDebugToolbarsLayout</b>(<i></i>)
1287 <p>
1288 Private slot to initialize the toolbars layout for the debug profile.
1289 </p><a NAME="UserInterface.__initEricDocAction" ID="UserInterface.__initEricDocAction"></a>
1290 <h4>UserInterface.__initEricDocAction</h4>
1291 <b>__initEricDocAction</b>(<i></i>)
1292 <p>
1293 Private slot to initialize the action to show the eric6 documentation.
1294 </p><a NAME="UserInterface.__initExternalToolsActions" ID="UserInterface.__initExternalToolsActions"></a>
1295 <h4>UserInterface.__initExternalToolsActions</h4>
1296 <b>__initExternalToolsActions</b>(<i></i>)
1297 <p>
1298 Private slot to create actions for the configured external tools.
1299 </p><a NAME="UserInterface.__initMenus" ID="UserInterface.__initMenus"></a>
1300 <h4>UserInterface.__initMenus</h4>
1301 <b>__initMenus</b>(<i></i>)
1302 <p>
1303 Private slot to create the menus.
1304 </p><a NAME="UserInterface.__initPySideDocActions" ID="UserInterface.__initPySideDocActions"></a>
1305 <h4>UserInterface.__initPySideDocActions</h4>
1306 <b>__initPySideDocActions</b>(<i></i>)
1307 <p>
1308 Private slot to initialize the actions to show the PySide
1309 documentation.
1310 </p><a NAME="UserInterface.__initPythonDocActions" ID="UserInterface.__initPythonDocActions"></a>
1311 <h4>UserInterface.__initPythonDocActions</h4>
1312 <b>__initPythonDocActions</b>(<i></i>)
1313 <p>
1314 Private slot to initialize the actions to show the Python
1315 documentation.
1316 </p><a NAME="UserInterface.__initQtDocActions" ID="UserInterface.__initQtDocActions"></a>
1317 <h4>UserInterface.__initQtDocActions</h4>
1318 <b>__initQtDocActions</b>(<i></i>)
1319 <p>
1320 Private slot to initialize the action to show the Qt documentation.
1321 </p><a NAME="UserInterface.__initStatusbar" ID="UserInterface.__initStatusbar"></a>
1322 <h4>UserInterface.__initStatusbar</h4>
1323 <b>__initStatusbar</b>(<i></i>)
1324 <p>
1325 Private slot to set up the status bar.
1326 </p><a NAME="UserInterface.__initToolbars" ID="UserInterface.__initToolbars"></a>
1327 <h4>UserInterface.__initToolbars</h4>
1328 <b>__initToolbars</b>(<i></i>)
1329 <p>
1330 Private slot to create the toolbars.
1331 </p><a NAME="UserInterface.__initToolsMenus" ID="UserInterface.__initToolsMenus"></a>
1332 <h4>UserInterface.__initToolsMenus</h4>
1333 <b>__initToolsMenus</b>(<i>menu</i>)
1334 <p>
1335 Private slot to initialize the various tool menus.
1336 </p><dl>
1337 <dt><i>menu</i> (QMenu)</dt>
1338 <dd>
1339 reference to the parent menu
1340 </dd>
1341 </dl><a NAME="UserInterface.__installPlugins" ID="UserInterface.__installPlugins"></a>
1342 <h4>UserInterface.__installPlugins</h4>
1343 <b>__installPlugins</b>(<i>pluginFileNames=None</i>)
1344 <p>
1345 Private slot to show a dialog to install a new plugin.
1346 </p><dl>
1347 <dt><i>pluginFileNames</i></dt>
1348 <dd>
1349 list of plugin files suggested for
1350 installation list of strings
1351 </dd>
1352 </dl><a NAME="UserInterface.__ircAutoConnected" ID="UserInterface.__ircAutoConnected"></a>
1353 <h4>UserInterface.__ircAutoConnected</h4>
1354 <b>__ircAutoConnected</b>(<i></i>)
1355 <p>
1356 Private slot handling the automatic connection of the IRC client.
1357 </p><a NAME="UserInterface.__lastEditorClosed" ID="UserInterface.__lastEditorClosed"></a>
1358 <h4>UserInterface.__lastEditorClosed</h4>
1359 <b>__lastEditorClosed</b>(<i></i>)
1360 <p>
1361 Private slot to handle the lastEditorClosed signal.
1362 </p><a NAME="UserInterface.__launchExternalWebBrowser" ID="UserInterface.__launchExternalWebBrowser"></a>
1363 <h4>UserInterface.__launchExternalWebBrowser</h4>
1364 <b>__launchExternalWebBrowser</b>(<i>home, searchWord=None</i>)
1365 <p>
1366 Private method to start an external web browser and communicate with
1367 it.
1368 </p><dl>
1369 <dt><i>home</i> (str)</dt>
1370 <dd>
1371 filename of file to be shown or URL to be opened
1372 </dd><dt><i>searchWord=</i> (str)</dt>
1373 <dd>
1374 word to search for
1375 </dd>
1376 </dl><dl>
1377 <dt>Returns:</dt>
1378 <dd>
1379 flag indicating a successful launch
1380 </dd>
1381 </dl><dl>
1382 <dt>Return Type:</dt>
1383 <dd>
1384 bool
1385 </dd>
1386 </dl><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a>
1387 <h4>UserInterface.__linguist</h4>
1388 <b>__linguist</b>(<i>fn=None, version=0</i>)
1389 <p>
1390 Private slot to start the Qt-Linguist executable.
1391 </p><dl>
1392 <dt><i>fn</i> (str)</dt>
1393 <dd>
1394 filename of the translation file to be opened
1395 </dd><dt><i>version</i> (int)</dt>
1396 <dd>
1397 indication for the requested version (4 = Qt 4/5)
1398 </dd>
1399 </dl><a NAME="UserInterface.__linguist4" ID="UserInterface.__linguist4"></a>
1400 <h4>UserInterface.__linguist4</h4>
1401 <b>__linguist4</b>(<i>fn=None</i>)
1402 <p>
1403 Private slot to start the Qt-Linguist 4/5 executable.
1404 </p><dl>
1405 <dt><i>fn</i></dt>
1406 <dd>
1407 filename of the translation file to be opened
1408 </dd>
1409 </dl><a NAME="UserInterface.__loadSessionFromFile" ID="UserInterface.__loadSessionFromFile"></a>
1410 <h4>UserInterface.__loadSessionFromFile</h4>
1411 <b>__loadSessionFromFile</b>(<i></i>)
1412 <p>
1413 Private slot to load a session from disk.
1414 </p><a NAME="UserInterface.__masterPasswordChanged" ID="UserInterface.__masterPasswordChanged"></a>
1415 <h4>UserInterface.__masterPasswordChanged</h4>
1416 <b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
1417 <p>
1418 Private slot to handle the change of the master password.
1419 </p><dl>
1420 <dt><i>oldPassword</i></dt>
1421 <dd>
1422 current master password (string)
1423 </dd><dt><i>newPassword</i></dt>
1424 <dd>
1425 new master password (string)
1426 </dd>
1427 </dl><a NAME="UserInterface.__newProject" ID="UserInterface.__newProject"></a>
1428 <h4>UserInterface.__newProject</h4>
1429 <b>__newProject</b>(<i></i>)
1430 <p>
1431 Private slot to handle the NewProject signal.
1432 </p><a NAME="UserInterface.__newWindow" ID="UserInterface.__newWindow"></a>
1433 <h4>UserInterface.__newWindow</h4>
1434 <b>__newWindow</b>(<i></i>)
1435 <p>
1436 Private slot to start a new instance of eric6.
1437 </p><a NAME="UserInterface.__onlineStateChanged" ID="UserInterface.__onlineStateChanged"></a>
1438 <h4>UserInterface.__onlineStateChanged</h4>
1439 <b>__onlineStateChanged</b>(<i>online</i>)
1440 <p>
1441 Private slot handling changes in online state.
1442 </p><dl>
1443 <dt><i>online</i> (bool)</dt>
1444 <dd>
1445 flag indicating the online state
1446 </dd>
1447 </dl><a NAME="UserInterface.__openHexEditor" ID="UserInterface.__openHexEditor"></a>
1448 <h4>UserInterface.__openHexEditor</h4>
1449 <b>__openHexEditor</b>(<i>fn=""</i>)
1450 <p>
1451 Private slot to open the hex editor window.
1452 </p><dl>
1453 <dt><i>fn</i></dt>
1454 <dd>
1455 filename of the file to show (string)
1456 </dd>
1457 </dl><a NAME="UserInterface.__openMiniEditor" ID="UserInterface.__openMiniEditor"></a>
1458 <h4>UserInterface.__openMiniEditor</h4>
1459 <b>__openMiniEditor</b>(<i></i>)
1460 <p>
1461 Private slot to show a mini editor window.
1462 </p><a NAME="UserInterface.__openOnStartup" ID="UserInterface.__openOnStartup"></a>
1463 <h4>UserInterface.__openOnStartup</h4>
1464 <b>__openOnStartup</b>(<i>startupType=None</i>)
1465 <p>
1466 Private method to open the last file, project or multiproject.
1467 </p><dl>
1468 <dt><i>startupType</i></dt>
1469 <dd>
1470 type of startup requested (string, one of
1471 "Nothing", "File", "Project", "MultiProject" or "Session")
1472 </dd>
1473 </dl><a NAME="UserInterface.__pluginsConfigure" ID="UserInterface.__pluginsConfigure"></a>
1474 <h4>UserInterface.__pluginsConfigure</h4>
1475 <b>__pluginsConfigure</b>(<i></i>)
1476 <p>
1477 Private slot to show the plugin manager configuration page.
1478 </p><a NAME="UserInterface.__populateToolbarsMenu" ID="UserInterface.__populateToolbarsMenu"></a>
1479 <h4>UserInterface.__populateToolbarsMenu</h4>
1480 <b>__populateToolbarsMenu</b>(<i>menu</i>)
1481 <p>
1482 Private method to populate a toolbars menu.
1483 </p><dl>
1484 <dt><i>menu</i></dt>
1485 <dd>
1486 reference to the menu to be populated (QMenu)
1487 </dd>
1488 </dl><a NAME="UserInterface.__preferencesChanged" ID="UserInterface.__preferencesChanged"></a>
1489 <h4>UserInterface.__preferencesChanged</h4>
1490 <b>__preferencesChanged</b>(<i></i>)
1491 <p>
1492 Private slot to handle a change of the preferences.
1493 </p><a NAME="UserInterface.__processToolStderr" ID="UserInterface.__processToolStderr"></a>
1494 <h4>UserInterface.__processToolStderr</h4>
1495 <b>__processToolStderr</b>(<i></i>)
1496 <p>
1497 Private slot to handle the readyReadStderr signal of a tool process.
1498 </p><a NAME="UserInterface.__processToolStdout" ID="UserInterface.__processToolStdout"></a>
1499 <h4>UserInterface.__processToolStdout</h4>
1500 <b>__processToolStdout</b>(<i></i>)
1501 <p>
1502 Private slot to handle the readyReadStdout signal of a tool process.
1503 </p><a NAME="UserInterface.__programChange" ID="UserInterface.__programChange"></a>
1504 <h4>UserInterface.__programChange</h4>
1505 <b>__programChange</b>(<i>fn</i>)
1506 <p>
1507 Private slot to handle the programChange signal.
1508 </p><p>
1509 This primarily is here to set the currentProg variable.
1510 </p><dl>
1511 <dt><i>fn</i></dt>
1512 <dd>
1513 filename to be set as current prog (string)
1514 </dd>
1515 </dl><a NAME="UserInterface.__projectClosed" ID="UserInterface.__projectClosed"></a>
1516 <h4>UserInterface.__projectClosed</h4>
1517 <b>__projectClosed</b>(<i></i>)
1518 <p>
1519 Private slot to handle the projectClosed signal.
1520 </p><a NAME="UserInterface.__projectOpened" ID="UserInterface.__projectOpened"></a>
1521 <h4>UserInterface.__projectOpened</h4>
1522 <b>__projectOpened</b>(<i></i>)
1523 <p>
1524 Private slot to handle the projectOpened signal.
1525 </p><a NAME="UserInterface.__quit" ID="UserInterface.__quit"></a>
1526 <h4>UserInterface.__quit</h4>
1527 <b>__quit</b>(<i></i>)
1528 <p>
1529 Private method to quit the application.
1530 </p><a NAME="UserInterface.__readCrashSession" ID="UserInterface.__readCrashSession"></a>
1531 <h4>UserInterface.__readCrashSession</h4>
1532 <b>__readCrashSession</b>(<i></i>)
1533 <p>
1534 Private method to check for and read a crash session.
1535 </p><dl>
1536 <dt>Returns:</dt>
1537 <dd>
1538 flag indicating a crash session file was found and read
1539 </dd>
1540 </dl><dl>
1541 <dt>Return Type:</dt>
1542 <dd>
1543 bool
1544 </dd>
1545 </dl><a NAME="UserInterface.__readSession" ID="UserInterface.__readSession"></a>
1546 <h4>UserInterface.__readSession</h4>
1547 <b>__readSession</b>(<i>filename=""</i>)
1548 <p>
1549 Private slot to read in the session file (.e5s or .e4s).
1550 </p><dl>
1551 <dt><i>filename</i> (str)</dt>
1552 <dd>
1553 name of a session file to read
1554 </dd>
1555 </dl><dl>
1556 <dt>Returns:</dt>
1557 <dd>
1558 flag indicating success
1559 </dd>
1560 </dl><dl>
1561 <dt>Return Type:</dt>
1562 <dd>
1563 bool
1564 </dd>
1565 </dl><a NAME="UserInterface.__readTasks" ID="UserInterface.__readTasks"></a>
1566 <h4>UserInterface.__readTasks</h4>
1567 <b>__readTasks</b>(<i></i>)
1568 <p>
1569 Private slot to read in the tasks file (.e6t).
1570 </p><a NAME="UserInterface.__reloadAPIs" ID="UserInterface.__reloadAPIs"></a>
1571 <h4>UserInterface.__reloadAPIs</h4>
1572 <b>__reloadAPIs</b>(<i></i>)
1573 <p>
1574 Private slot to reload the api information.
1575 </p><a NAME="UserInterface.__reportBug" ID="UserInterface.__reportBug"></a>
1576 <h4>UserInterface.__reportBug</h4>
1577 <b>__reportBug</b>(<i></i>)
1578 <p>
1579 Private slot to handle the Report Bug dialog.
1580 </p><a NAME="UserInterface.__requestFeature" ID="UserInterface.__requestFeature"></a>
1581 <h4>UserInterface.__requestFeature</h4>
1582 <b>__requestFeature</b>(<i></i>)
1583 <p>
1584 Private slot to handle the Feature Request dialog.
1585 </p><a NAME="UserInterface.__restart" ID="UserInterface.__restart"></a>
1586 <h4>UserInterface.__restart</h4>
1587 <b>__restart</b>(<i>ask=False</i>)
1588 <p>
1589 Private method to restart the application.
1590 </p><dl>
1591 <dt><i>ask</i> (bool)</dt>
1592 <dd>
1593 flag indicating to ask the user for permission
1594 </dd>
1595 </dl><a NAME="UserInterface.__saveCurrentViewProfile" ID="UserInterface.__saveCurrentViewProfile"></a>
1596 <h4>UserInterface.__saveCurrentViewProfile</h4>
1597 <b>__saveCurrentViewProfile</b>(<i>save</i>)
1598 <p>
1599 Private slot to save the window geometries of the active profile.
1600 </p><dl>
1601 <dt><i>save</i></dt>
1602 <dd>
1603 flag indicating that the current profile should
1604 be saved (boolean)
1605 </dd>
1606 </dl><a NAME="UserInterface.__saveSessionToFile" ID="UserInterface.__saveSessionToFile"></a>
1607 <h4>UserInterface.__saveSessionToFile</h4>
1608 <b>__saveSessionToFile</b>(<i></i>)
1609 <p>
1610 Private slot to save a session to disk.
1611 </p><a NAME="UserInterface.__setEditProfile" ID="UserInterface.__setEditProfile"></a>
1612 <h4>UserInterface.__setEditProfile</h4>
1613 <b>__setEditProfile</b>(<i>save=True</i>)
1614 <p>
1615 Private slot to activate the edit view profile.
1616 </p><dl>
1617 <dt><i>save</i></dt>
1618 <dd>
1619 flag indicating that the current profile should
1620 be saved (boolean)
1621 </dd>
1622 </dl><a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a>
1623 <h4>UserInterface.__setWindowCaption</h4>
1624 <b>__setWindowCaption</b>(<i>editor=None, project=None</i>)
1625 <p>
1626 Private method to set the caption of the Main Window.
1627 </p><dl>
1628 <dt><i>editor</i></dt>
1629 <dd>
1630 filename to be displayed (string)
1631 </dd><dt><i>project</i></dt>
1632 <dd>
1633 project name to be displayed (string)
1634 </dd>
1635 </dl><a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a>
1636 <h4>UserInterface.__setupDockWindow</h4>
1637 <b>__setupDockWindow</b>(<i>dock, where, widget, caption</i>)
1638 <p>
1639 Private method to configure the dock window created with
1640 __createDockWindow().
1641 </p><dl>
1642 <dt><i>dock</i></dt>
1643 <dd>
1644 the dock window (QDockWindow)
1645 </dd><dt><i>where</i></dt>
1646 <dd>
1647 dock area to be docked to (Qt.DockWidgetArea)
1648 </dd><dt><i>widget</i></dt>
1649 <dd>
1650 widget to be shown in the dock window (QWidget)
1651 </dd><dt><i>caption</i></dt>
1652 <dd>
1653 caption of the dock window (string)
1654 </dd>
1655 </dl><a NAME="UserInterface.__showAvailableVersionInfos" ID="UserInterface.__showAvailableVersionInfos"></a>
1656 <h4>UserInterface.__showAvailableVersionInfos</h4>
1657 <b>__showAvailableVersionInfos</b>(<i>versions</i>)
1658 <p>
1659 Private method to show the versions available for download.
1660 </p><dl>
1661 <dt><i>versions</i></dt>
1662 <dd>
1663 contents of the downloaded versions file (list of
1664 strings)
1665 </dd>
1666 </dl><a NAME="UserInterface.__showCertificatesDialog" ID="UserInterface.__showCertificatesDialog"></a>
1667 <h4>UserInterface.__showCertificatesDialog</h4>
1668 <b>__showCertificatesDialog</b>(<i></i>)
1669 <p>
1670 Private slot to show the certificates management dialog.
1671 </p><a NAME="UserInterface.__showEricDoc" ID="UserInterface.__showEricDoc"></a>
1672 <h4>UserInterface.__showEricDoc</h4>
1673 <b>__showEricDoc</b>(<i></i>)
1674 <p>
1675 Private slot to show the Eric documentation.
1676 </p><a NAME="UserInterface.__showErrorLog" ID="UserInterface.__showErrorLog"></a>
1677 <h4>UserInterface.__showErrorLog</h4>
1678 <b>__showErrorLog</b>(<i></i>)
1679 <p>
1680 Private slot to show the most recent error log message.
1681 </p><a NAME="UserInterface.__showExternalTools" ID="UserInterface.__showExternalTools"></a>
1682 <h4>UserInterface.__showExternalTools</h4>
1683 <b>__showExternalTools</b>(<i></i>)
1684 <p>
1685 Private slot to display a dialog show a list of external tools used
1686 by eric6.
1687 </p><a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a>
1688 <h4>UserInterface.__showExtrasMenu</h4>
1689 <b>__showExtrasMenu</b>(<i></i>)
1690 <p>
1691 Private slot to display the Extras menu.
1692 </p><a NAME="UserInterface.__showFileMenu" ID="UserInterface.__showFileMenu"></a>
1693 <h4>UserInterface.__showFileMenu</h4>
1694 <b>__showFileMenu</b>(<i></i>)
1695 <p>
1696 Private slot to display the File menu.
1697 </p><a NAME="UserInterface.__showHelpMenu" ID="UserInterface.__showHelpMenu"></a>
1698 <h4>UserInterface.__showHelpMenu</h4>
1699 <b>__showHelpMenu</b>(<i></i>)
1700 <p>
1701 Private slot to display the Help menu.
1702 </p><a NAME="UserInterface.__showNext" ID="UserInterface.__showNext"></a>
1703 <h4>UserInterface.__showNext</h4>
1704 <b>__showNext</b>(<i></i>)
1705 <p>
1706 Private slot used to show the next tab or file.
1707 </p><a NAME="UserInterface.__showPixmap" ID="UserInterface.__showPixmap"></a>
1708 <h4>UserInterface.__showPixmap</h4>
1709 <b>__showPixmap</b>(<i>fn</i>)
1710 <p>
1711 Private slot to show a pixmap in a dialog.
1712 </p><dl>
1713 <dt><i>fn</i></dt>
1714 <dd>
1715 filename of the file to show (string)
1716 </dd>
1717 </dl><a NAME="UserInterface.__showPluginInfo" ID="UserInterface.__showPluginInfo"></a>
1718 <h4>UserInterface.__showPluginInfo</h4>
1719 <b>__showPluginInfo</b>(<i></i>)
1720 <p>
1721 Private slot to show the plugin info dialog.
1722 </p><a NAME="UserInterface.__showPluginToolsMenu" ID="UserInterface.__showPluginToolsMenu"></a>
1723 <h4>UserInterface.__showPluginToolsMenu</h4>
1724 <b>__showPluginToolsMenu</b>(<i></i>)
1725 <p>
1726 Private slot to show the Plugin Tools menu.
1727 </p><a NAME="UserInterface.__showPrevious" ID="UserInterface.__showPrevious"></a>
1728 <h4>UserInterface.__showPrevious</h4>
1729 <b>__showPrevious</b>(<i></i>)
1730 <p>
1731 Private slot used to show the previous tab or file.
1732 </p><a NAME="UserInterface.__showPyQt4Doc" ID="UserInterface.__showPyQt4Doc"></a>
1733 <h4>UserInterface.__showPyQt4Doc</h4>
1734 <b>__showPyQt4Doc</b>(<i></i>)
1735 <p>
1736 Private slot to show the PyQt4 documentation.
1737 </p><a NAME="UserInterface.__showPyQt5Doc" ID="UserInterface.__showPyQt5Doc"></a>
1738 <h4>UserInterface.__showPyQt5Doc</h4>
1739 <b>__showPyQt5Doc</b>(<i></i>)
1740 <p>
1741 Private slot to show the PyQt5 documentation.
1742 </p><a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a>
1743 <h4>UserInterface.__showPySideDoc</h4>
1744 <b>__showPySideDoc</b>(<i>variant</i>)
1745 <p>
1746 Private slot to show the PySide/PySide2 documentation.
1747 </p><dl>
1748 <dt><i>variant</i> (str)</dt>
1749 <dd>
1750 PySide variant (1 or 2)
1751 </dd>
1752 </dl><a NAME="UserInterface.__showPython2Doc" ID="UserInterface.__showPython2Doc"></a>
1753 <h4>UserInterface.__showPython2Doc</h4>
1754 <b>__showPython2Doc</b>(<i></i>)
1755 <p>
1756 Private slot to show the Python 2 documentation.
1757 </p><a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a>
1758 <h4>UserInterface.__showPythonDoc</h4>
1759 <b>__showPythonDoc</b>(<i></i>)
1760 <p>
1761 Private slot to show the Python 3 documentation.
1762 </p><a NAME="UserInterface.__showQt4Doc" ID="UserInterface.__showQt4Doc"></a>
1763 <h4>UserInterface.__showQt4Doc</h4>
1764 <b>__showQt4Doc</b>(<i></i>)
1765 <p>
1766 Private slot to show the Qt4 documentation.
1767 </p><a NAME="UserInterface.__showQt5Doc" ID="UserInterface.__showQt5Doc"></a>
1768 <h4>UserInterface.__showQt5Doc</h4>
1769 <b>__showQt5Doc</b>(<i></i>)
1770 <p>
1771 Private slot to show the Qt5 documentation.
1772 </p><a NAME="UserInterface.__showQtDoc" ID="UserInterface.__showQtDoc"></a>
1773 <h4>UserInterface.__showQtDoc</h4>
1774 <b>__showQtDoc</b>(<i>version</i>)
1775 <p>
1776 Private method to show the Qt documentation.
1777 </p><dl>
1778 <dt><i>version</i></dt>
1779 <dd>
1780 Qt version to show documentation for (integer)
1781 </dd>
1782 </dl><a NAME="UserInterface.__showSettingsMenu" ID="UserInterface.__showSettingsMenu"></a>
1783 <h4>UserInterface.__showSettingsMenu</h4>
1784 <b>__showSettingsMenu</b>(<i></i>)
1785 <p>
1786 Private slot to show the Settings menu.
1787 </p><a NAME="UserInterface.__showSubWindowMenu" ID="UserInterface.__showSubWindowMenu"></a>
1788 <h4>UserInterface.__showSubWindowMenu</h4>
1789 <b>__showSubWindowMenu</b>(<i></i>)
1790 <p>
1791 Private slot to display the Window menu of the Window menu.
1792 </p><a NAME="UserInterface.__showSvg" ID="UserInterface.__showSvg"></a>
1793 <h4>UserInterface.__showSvg</h4>
1794 <b>__showSvg</b>(<i>fn</i>)
1795 <p>
1796 Private slot to show a SVG file in a dialog.
1797 </p><dl>
1798 <dt><i>fn</i></dt>
1799 <dd>
1800 filename of the file to show (string)
1801 </dd>
1802 </dl><a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a>
1803 <h4>UserInterface.__showSystemEmailClient</h4>
1804 <b>__showSystemEmailClient</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
1805 <p>
1806 Private slot to show the system email dialog.
1807 </p><dl>
1808 <dt><i>mode</i></dt>
1809 <dd>
1810 mode of the email dialog (string, "bug" or "feature")
1811 </dd><dt><i>attachFile</i></dt>
1812 <dd>
1813 name of a file to put into the body of the
1814 email (string)
1815 </dd><dt><i>deleteAttachFile</i></dt>
1816 <dd>
1817 flag indicating to delete the file after
1818 it has been read (boolean)
1819 </dd>
1820 </dl><a NAME="UserInterface.__showToolGroupsMenu" ID="UserInterface.__showToolGroupsMenu"></a>
1821 <h4>UserInterface.__showToolGroupsMenu</h4>
1822 <b>__showToolGroupsMenu</b>(<i></i>)
1823 <p>
1824 Private slot to display the Tool Groups menu.
1825 </p><a NAME="UserInterface.__showToolbarsMenu" ID="UserInterface.__showToolbarsMenu"></a>
1826 <h4>UserInterface.__showToolbarsMenu</h4>
1827 <b>__showToolbarsMenu</b>(<i></i>)
1828 <p>
1829 Private slot to display the Toolbars menu.
1830 </p><a NAME="UserInterface.__showUserToolsMenu" ID="UserInterface.__showUserToolsMenu"></a>
1831 <h4>UserInterface.__showUserToolsMenu</h4>
1832 <b>__showUserToolsMenu</b>(<i></i>)
1833 <p>
1834 Private slot to display the User Tools menu.
1835 </p><a NAME="UserInterface.__showVersions" ID="UserInterface.__showVersions"></a>
1836 <h4>UserInterface.__showVersions</h4>
1837 <b>__showVersions</b>(<i></i>)
1838 <p>
1839 Private slot to handle the Versions dialog.
1840 </p><a NAME="UserInterface.__showWindowMenu" ID="UserInterface.__showWindowMenu"></a>
1841 <h4>UserInterface.__showWindowMenu</h4>
1842 <b>__showWindowMenu</b>(<i></i>)
1843 <p>
1844 Private slot to display the Window menu.
1845 </p><a NAME="UserInterface.__showWizardsMenu" ID="UserInterface.__showWizardsMenu"></a>
1846 <h4>UserInterface.__showWizardsMenu</h4>
1847 <b>__showWizardsMenu</b>(<i></i>)
1848 <p>
1849 Private slot to display the Wizards menu.
1850 </p><a NAME="UserInterface.__shutdown" ID="UserInterface.__shutdown"></a>
1851 <h4>UserInterface.__shutdown</h4>
1852 <b>__shutdown</b>(<i></i>)
1853 <p>
1854 Private method to perform all necessary steps to close down the IDE.
1855 </p><dl>
1856 <dt>Returns:</dt>
1857 <dd>
1858 flag indicating success
1859 </dd>
1860 </dl><a NAME="UserInterface.__snapshot" ID="UserInterface.__snapshot"></a>
1861 <h4>UserInterface.__snapshot</h4>
1862 <b>__snapshot</b>(<i></i>)
1863 <p>
1864 Private slot to start the snapshot tool.
1865 </p><a NAME="UserInterface.__sqlBrowser" ID="UserInterface.__sqlBrowser"></a>
1866 <h4>UserInterface.__sqlBrowser</h4>
1867 <b>__sqlBrowser</b>(<i></i>)
1868 <p>
1869 Private slot to start the SQL browser tool.
1870 </p><a NAME="UserInterface.__sslErrors" ID="UserInterface.__sslErrors"></a>
1871 <h4>UserInterface.__sslErrors</h4>
1872 <b>__sslErrors</b>(<i>reply, errors</i>)
1873 <p>
1874 Private slot to handle SSL errors.
1875 </p><dl>
1876 <dt><i>reply</i></dt>
1877 <dd>
1878 reference to the reply object (QNetworkReply)
1879 </dd><dt><i>errors</i></dt>
1880 <dd>
1881 list of SSL errors (list of QSslError)
1882 </dd>
1883 </dl><a NAME="UserInterface.__startToolProcess" ID="UserInterface.__startToolProcess"></a>
1884 <h4>UserInterface.__startToolProcess</h4>
1885 <b>__startToolProcess</b>(<i>tool</i>)
1886 <p>
1887 Private slot to start an external tool process.
1888 </p><dl>
1889 <dt><i>tool</i></dt>
1890 <dd>
1891 list of tool entries
1892 </dd>
1893 </dl><a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a>
1894 <h4>UserInterface.__startWebBrowser</h4>
1895 <b>__startWebBrowser</b>(<i></i>)
1896 <p>
1897 Private slot to start the eric6 web browser.
1898 </p><a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a>
1899 <h4>UserInterface.__switchTab</h4>
1900 <b>__switchTab</b>(<i></i>)
1901 <p>
1902 Private slot used to switch between the current and the previous
1903 current tab.
1904 </p><a NAME="UserInterface.__toggleBottomSidebar" ID="UserInterface.__toggleBottomSidebar"></a>
1905 <h4>UserInterface.__toggleBottomSidebar</h4>
1906 <b>__toggleBottomSidebar</b>(<i></i>)
1907 <p>
1908 Private slot to handle the toggle of the bottom sidebar window.
1909 </p><a NAME="UserInterface.__toggleHorizontalToolbox" ID="UserInterface.__toggleHorizontalToolbox"></a>
1910 <h4>UserInterface.__toggleHorizontalToolbox</h4>
1911 <b>__toggleHorizontalToolbox</b>(<i></i>)
1912 <p>
1913 Private slot to handle the toggle of the Horizontal Toolbox window.
1914 </p><a NAME="UserInterface.__toggleLeftSidebar" ID="UserInterface.__toggleLeftSidebar"></a>
1915 <h4>UserInterface.__toggleLeftSidebar</h4>
1916 <b>__toggleLeftSidebar</b>(<i></i>)
1917 <p>
1918 Private slot to handle the toggle of the left sidebar window.
1919 </p><a NAME="UserInterface.__toggleLeftToolbox" ID="UserInterface.__toggleLeftToolbox"></a>
1920 <h4>UserInterface.__toggleLeftToolbox</h4>
1921 <b>__toggleLeftToolbox</b>(<i></i>)
1922 <p>
1923 Private slot to handle the toggle of the Left Toolbox window.
1924 </p><a NAME="UserInterface.__toggleRightSidebar" ID="UserInterface.__toggleRightSidebar"></a>
1925 <h4>UserInterface.__toggleRightSidebar</h4>
1926 <b>__toggleRightSidebar</b>(<i></i>)
1927 <p>
1928 Private slot to handle the toggle of the right sidebar window.
1929 </p><a NAME="UserInterface.__toggleRightToolbox" ID="UserInterface.__toggleRightToolbox"></a>
1930 <h4>UserInterface.__toggleRightToolbox</h4>
1931 <b>__toggleRightToolbox</b>(<i></i>)
1932 <p>
1933 Private slot to handle the toggle of the Right Toolbox window.
1934 </p><a NAME="UserInterface.__toggleWindow" ID="UserInterface.__toggleWindow"></a>
1935 <h4>UserInterface.__toggleWindow</h4>
1936 <b>__toggleWindow</b>(<i>w</i>)
1937 <p>
1938 Private method to toggle a workspace editor window.
1939 </p><dl>
1940 <dt><i>w</i></dt>
1941 <dd>
1942 reference to the workspace editor window
1943 </dd>
1944 </dl><dl>
1945 <dt>Returns:</dt>
1946 <dd>
1947 flag indicating, if the window was shown (boolean)
1948 </dd>
1949 </dl><a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a>
1950 <h4>UserInterface.__toolActionTriggered</h4>
1951 <b>__toolActionTriggered</b>(<i>act</i>)
1952 <p>
1953 Private slot called by external tools toolbar actions.
1954 </p><dl>
1955 <dt><i>act</i> (QAction)</dt>
1956 <dd>
1957 reference to the action that triggered the slot
1958 </dd>
1959 </dl><a NAME="UserInterface.__toolExecute" ID="UserInterface.__toolExecute"></a>
1960 <h4>UserInterface.__toolExecute</h4>
1961 <b>__toolExecute</b>(<i>act</i>)
1962 <p>
1963 Private slot to execute a particular tool.
1964 </p><dl>
1965 <dt><i>act</i></dt>
1966 <dd>
1967 reference to the action that was triggered (QAction)
1968 </dd>
1969 </dl><a NAME="UserInterface.__toolFinished" ID="UserInterface.__toolFinished"></a>
1970 <h4>UserInterface.__toolFinished</h4>
1971 <b>__toolFinished</b>(<i>exitCode, exitStatus</i>)
1972 <p>
1973 Private slot to handle the finished signal of a tool process.
1974 </p><dl>
1975 <dt><i>exitCode</i></dt>
1976 <dd>
1977 exit code of the process (integer)
1978 </dd><dt><i>exitStatus</i></dt>
1979 <dd>
1980 exit status of the process (QProcess.ExitStatus)
1981 </dd>
1982 </dl><a NAME="UserInterface.__toolGroupSelected" ID="UserInterface.__toolGroupSelected"></a>
1983 <h4>UserInterface.__toolGroupSelected</h4>
1984 <b>__toolGroupSelected</b>(<i>act</i>)
1985 <p>
1986 Private slot to set the current tool group.
1987 </p><dl>
1988 <dt><i>act</i></dt>
1989 <dd>
1990 reference to the action that was triggered (QAction)
1991 </dd>
1992 </dl><a NAME="UserInterface.__toolGroupsConfiguration" ID="UserInterface.__toolGroupsConfiguration"></a>
1993 <h4>UserInterface.__toolGroupsConfiguration</h4>
1994 <b>__toolGroupsConfiguration</b>(<i></i>)
1995 <p>
1996 Private slot to handle the tool groups configuration menu entry.
1997 </p><a NAME="UserInterface.__toolsConfiguration" ID="UserInterface.__toolsConfiguration"></a>
1998 <h4>UserInterface.__toolsConfiguration</h4>
1999 <b>__toolsConfiguration</b>(<i></i>)
2000 <p>
2001 Private slot to handle the tools configuration menu entry.
2002 </p><a NAME="UserInterface.__unittest" ID="UserInterface.__unittest"></a>
2003 <h4>UserInterface.__unittest</h4>
2004 <b>__unittest</b>(<i></i>)
2005 <p>
2006 Private slot for displaying the unittest dialog.
2007 </p><a NAME="UserInterface.__unittestProject" ID="UserInterface.__unittestProject"></a>
2008 <h4>UserInterface.__unittestProject</h4>
2009 <b>__unittestProject</b>(<i></i>)
2010 <p>
2011 Private slot for displaying the unittest dialog and run the current
2012 project.
2013 </p><a NAME="UserInterface.__unittestRerunFailed" ID="UserInterface.__unittestRerunFailed"></a>
2014 <h4>UserInterface.__unittestRerunFailed</h4>
2015 <b>__unittestRerunFailed</b>(<i></i>)
2016 <p>
2017 Private slot to display the unittest dialog and rerun all failed tests
2018 of the last run.
2019 </p><a NAME="UserInterface.__unittestRestart" ID="UserInterface.__unittestRestart"></a>
2020 <h4>UserInterface.__unittestRestart</h4>
2021 <b>__unittestRestart</b>(<i></i>)
2022 <p>
2023 Private slot to display the unittest dialog and rerun the last
2024 unit test.
2025 </p><a NAME="UserInterface.__unittestScript" ID="UserInterface.__unittestScript"></a>
2026 <h4>UserInterface.__unittestScript</h4>
2027 <b>__unittestScript</b>(<i>prog=None</i>)
2028 <p>
2029 Private slot for displaying the unittest dialog and run the current
2030 script.
2031 </p><dl>
2032 <dt><i>prog</i></dt>
2033 <dd>
2034 the python program to be opened
2035 </dd>
2036 </dl><a NAME="UserInterface.__unittestStopped" ID="UserInterface.__unittestStopped"></a>
2037 <h4>UserInterface.__unittestStopped</h4>
2038 <b>__unittestStopped</b>(<i></i>)
2039 <p>
2040 Private slot to handle the end of a unit test run.
2041 </p><a NAME="UserInterface.__updateExternalToolsActions" ID="UserInterface.__updateExternalToolsActions"></a>
2042 <h4>UserInterface.__updateExternalToolsActions</h4>
2043 <b>__updateExternalToolsActions</b>(<i></i>)
2044 <p>
2045 Private method to update the external tools actions for the current
2046 tool group.
2047 </p><a NAME="UserInterface.__updateVersionsUrls" ID="UserInterface.__updateVersionsUrls"></a>
2048 <h4>UserInterface.__updateVersionsUrls</h4>
2049 <b>__updateVersionsUrls</b>(<i>versions</i>)
2050 <p>
2051 Private method to update the URLs from which to retrieve the versions
2052 file.
2053 </p><dl>
2054 <dt><i>versions</i></dt>
2055 <dd>
2056 contents of the downloaded versions file (list of
2057 strings)
2058 </dd>
2059 </dl><a NAME="UserInterface.__versionCheckResult" ID="UserInterface.__versionCheckResult"></a>
2060 <h4>UserInterface.__versionCheckResult</h4>
2061 <b>__versionCheckResult</b>(<i>versions</i>)
2062 <p>
2063 Private method to show the result of the version check action.
2064 </p><dl>
2065 <dt><i>versions</i></dt>
2066 <dd>
2067 contents of the downloaded versions file (list of
2068 strings)
2069 </dd>
2070 </dl><a NAME="UserInterface.__versionToTuple" ID="UserInterface.__versionToTuple"></a>
2071 <h4>UserInterface.__versionToTuple</h4>
2072 <b>__versionToTuple</b>(<i>version</i>)
2073 <p>
2074 Private method to convert a version string into a tuple.
2075 </p><dl>
2076 <dt><i>version</i> (str)</dt>
2077 <dd>
2078 version string
2079 </dd>
2080 </dl><dl>
2081 <dt>Returns:</dt>
2082 <dd>
2083 version tuple
2084 </dd>
2085 </dl><dl>
2086 <dt>Return Type:</dt>
2087 <dd>
2088 tuple of int
2089 </dd>
2090 </dl><a NAME="UserInterface.__versionsDownloadCanceled" ID="UserInterface.__versionsDownloadCanceled"></a>
2091 <h4>UserInterface.__versionsDownloadCanceled</h4>
2092 <b>__versionsDownloadCanceled</b>(<i></i>)
2093 <p>
2094 Private slot called to cancel the version check.
2095 </p><a NAME="UserInterface.__versionsDownloadDone" ID="UserInterface.__versionsDownloadDone"></a>
2096 <h4>UserInterface.__versionsDownloadDone</h4>
2097 <b>__versionsDownloadDone</b>(<i>reply</i>)
2098 <p>
2099 Private slot called, after the versions file has been downloaded
2100 from the internet.
2101 </p><dl>
2102 <dt><i>reply</i> (QNetworkReply)</dt>
2103 <dd>
2104 reference to the network reply
2105 </dd>
2106 </dl><a NAME="UserInterface.__webBrowser" ID="UserInterface.__webBrowser"></a>
2107 <h4>UserInterface.__webBrowser</h4>
2108 <b>__webBrowser</b>(<i>home=""</i>)
2109 <p>
2110 Private slot to start the eric6 web browser.
2111 </p><dl>
2112 <dt><i>home</i></dt>
2113 <dd>
2114 full pathname of a file to display (string)
2115 </dd>
2116 </dl><a NAME="UserInterface.__webBrowserFinished" ID="UserInterface.__webBrowserFinished"></a>
2117 <h4>UserInterface.__webBrowserFinished</h4>
2118 <b>__webBrowserFinished</b>(<i></i>)
2119 <p>
2120 Private slot handling the end of the external web browser process.
2121 </p><a NAME="UserInterface.__webBrowserShutdown" ID="UserInterface.__webBrowserShutdown"></a>
2122 <h4>UserInterface.__webBrowserShutdown</h4>
2123 <b>__webBrowserShutdown</b>(<i></i>)
2124 <p>
2125 Private method to shut down the web browser.
2126 </p><a NAME="UserInterface.__whatsThis" ID="UserInterface.__whatsThis"></a>
2127 <h4>UserInterface.__whatsThis</h4>
2128 <b>__whatsThis</b>(<i></i>)
2129 <p>
2130 Private slot called in to enter Whats This mode.
2131 </p><a NAME="UserInterface.__writeCrashSession" ID="UserInterface.__writeCrashSession"></a>
2132 <h4>UserInterface.__writeCrashSession</h4>
2133 <b>__writeCrashSession</b>(<i></i>)
2134 <p>
2135 Private slot to write a crash session file.
2136 </p><a NAME="UserInterface.__writeSession" ID="UserInterface.__writeSession"></a>
2137 <h4>UserInterface.__writeSession</h4>
2138 <b>__writeSession</b>(<i>filename="", crashSession=False</i>)
2139 <p>
2140 Private slot to write the session data to an XML file (.e5s).
2141 </p><dl>
2142 <dt><i>filename</i> (str)</dt>
2143 <dd>
2144 name of a session file to write
2145 </dd><dt><i>crashSession</i> (bool)</dt>
2146 <dd>
2147 flag indicating to write a crash session file
2148 </dd>
2149 </dl><dl>
2150 <dt>Returns:</dt>
2151 <dd>
2152 flag indicating success
2153 </dd>
2154 </dl><dl>
2155 <dt>Return Type:</dt>
2156 <dd>
2157 bool
2158 </dd>
2159 </dl><a NAME="UserInterface.__writeTasks" ID="UserInterface.__writeTasks"></a>
2160 <h4>UserInterface.__writeTasks</h4>
2161 <b>__writeTasks</b>(<i></i>)
2162 <p>
2163 Private slot to write the tasks data to an XML file (.e6t).
2164 </p><a NAME="UserInterface.activateCodeDocumentationViewer" ID="UserInterface.activateCodeDocumentationViewer"></a>
2165 <h4>UserInterface.activateCodeDocumentationViewer</h4>
2166 <b>activateCodeDocumentationViewer</b>(<i>switchFocus=True</i>)
2167 <p>
2168 Public slot to handle the activation of the Code Documentation Viewer.
2169 </p><dl>
2170 <dt><i>switchFocus</i> (bool)</dt>
2171 <dd>
2172 flag indicating to transfer the input focus
2173 </dd>
2174 </dl><a NAME="UserInterface.activateCooperationViewer" ID="UserInterface.activateCooperationViewer"></a>
2175 <h4>UserInterface.activateCooperationViewer</h4>
2176 <b>activateCooperationViewer</b>(<i></i>)
2177 <p>
2178 Public slot to handle the activation of the cooperation window.
2179 </p><a NAME="UserInterface.activateDebugViewer" ID="UserInterface.activateDebugViewer"></a>
2180 <h4>UserInterface.activateDebugViewer</h4>
2181 <b>activateDebugViewer</b>(<i></i>)
2182 <p>
2183 Public slot to handle the activation of the debug viewer.
2184 </p><a NAME="UserInterface.addE5Actions" ID="UserInterface.addE5Actions"></a>
2185 <h4>UserInterface.addE5Actions</h4>
2186 <b>addE5Actions</b>(<i>actions, actionType</i>)
2187 <p>
2188 Public method to add actions to the list of actions.
2189 </p><dl>
2190 <dt><i>actions</i></dt>
2191 <dd>
2192 list of actions to be added (list of E5Action)
2193 </dd><dt><i>actionType</i></dt>
2194 <dd>
2195 string denoting the action set to add to.
2196 It must be one of "ui" or "wizards".
2197 </dd>
2198 </dl><a NAME="UserInterface.addSideWidget" ID="UserInterface.addSideWidget"></a>
2199 <h4>UserInterface.addSideWidget</h4>
2200 <b>addSideWidget</b>(<i>side, widget, icon, label</i>)
2201 <p>
2202 Public method to add a widget to the sides.
2203 </p><dl>
2204 <dt><i>side</i></dt>
2205 <dd>
2206 side to add the widget to (UserInterface.LeftSide,
2207 UserInterface.BottomSide)
2208 </dd><dt><i>widget</i></dt>
2209 <dd>
2210 reference to the widget to add (QWidget)
2211 </dd><dt><i>icon</i></dt>
2212 <dd>
2213 icon to be used (QIcon)
2214 </dd><dt><i>label</i></dt>
2215 <dd>
2216 label text to be shown (string)
2217 </dd>
2218 </dl><a NAME="UserInterface.appendToStderr" ID="UserInterface.appendToStderr"></a>
2219 <h4>UserInterface.appendToStderr</h4>
2220 <b>appendToStderr</b>(<i>s</i>)
2221 <p>
2222 Public slot to append text to the stderr log viewer tab.
2223 </p><dl>
2224 <dt><i>s</i></dt>
2225 <dd>
2226 output to be appended (string)
2227 </dd>
2228 </dl><a NAME="UserInterface.appendToStdout" ID="UserInterface.appendToStdout"></a>
2229 <h4>UserInterface.appendToStdout</h4>
2230 <b>appendToStdout</b>(<i>s</i>)
2231 <p>
2232 Public slot to append text to the stdout log viewer tab.
2233 </p><dl>
2234 <dt><i>s</i></dt>
2235 <dd>
2236 output to be appended (string)
2237 </dd>
2238 </dl><a NAME="UserInterface.autoConnectIrc" ID="UserInterface.autoConnectIrc"></a>
2239 <h4>UserInterface.autoConnectIrc</h4>
2240 <b>autoConnectIrc</b>(<i></i>)
2241 <p>
2242 Public method to initiate the IRC auto connection.
2243 </p><a NAME="UserInterface.checkConfigurationStatus" ID="UserInterface.checkConfigurationStatus"></a>
2244 <h4>UserInterface.checkConfigurationStatus</h4>
2245 <b>checkConfigurationStatus</b>(<i></i>)
2246 <p>
2247 Public method to check, if eric6 has been configured. If it is not,
2248 the configuration dialog is shown.
2249 </p><a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a>
2250 <h4>UserInterface.checkForErrorLog</h4>
2251 <b>checkForErrorLog</b>(<i></i>)
2252 <p>
2253 Public method to check for the presence of an error log and ask the
2254 user, what to do with it.
2255 </p><a NAME="UserInterface.checkPluginUpdatesAvailable" ID="UserInterface.checkPluginUpdatesAvailable"></a>
2256 <h4>UserInterface.checkPluginUpdatesAvailable</h4>
2257 <b>checkPluginUpdatesAvailable</b>(<i></i>)
2258 <p>
2259 Public method to check the availability of updates of plug-ins.
2260 </p><a NAME="UserInterface.checkProjectsWorkspace" ID="UserInterface.checkProjectsWorkspace"></a>
2261 <h4>UserInterface.checkProjectsWorkspace</h4>
2262 <b>checkProjectsWorkspace</b>(<i></i>)
2263 <p>
2264 Public method to check, if a projects workspace has been configured. If
2265 it has not, a dialog is shown.
2266 </p><a NAME="UserInterface.closeEvent" ID="UserInterface.closeEvent"></a>
2267 <h4>UserInterface.closeEvent</h4>
2268 <b>closeEvent</b>(<i>event</i>)
2269 <p>
2270 Protected event handler for the close event.
2271 </p><p>
2272 This event handler saves the preferences.
2273 </p><dl>
2274 <dt><i>event</i></dt>
2275 <dd>
2276 close event (QCloseEvent)
2277 </dd>
2278 </dl><a NAME="UserInterface.createPopupMenu" ID="UserInterface.createPopupMenu"></a>
2279 <h4>UserInterface.createPopupMenu</h4>
2280 <b>createPopupMenu</b>(<i></i>)
2281 <p>
2282 Public method to create the toolbars menu for Qt.
2283 </p><dl>
2284 <dt>Returns:</dt>
2285 <dd>
2286 toolbars menu (QMenu)
2287 </dd>
2288 </dl><a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a>
2289 <h4>UserInterface.documentationViewer</h4>
2290 <b>documentationViewer</b>(<i></i>)
2291 <p>
2292 Public method to provide a reference to the code documentation viewer.
2293 </p><dl>
2294 <dt>Returns:</dt>
2295 <dd>
2296 reference to the code documentation viewer
2297 </dd>
2298 </dl><dl>
2299 <dt>Return Type:</dt>
2300 <dd>
2301 CodeDocumentationViewer
2302 </dd>
2303 </dl><a NAME="UserInterface.dragEnterEvent" ID="UserInterface.dragEnterEvent"></a>
2304 <h4>UserInterface.dragEnterEvent</h4>
2305 <b>dragEnterEvent</b>(<i>event</i>)
2306 <p>
2307 Protected method to handle the drag enter event.
2308 </p><dl>
2309 <dt><i>event</i></dt>
2310 <dd>
2311 the drag enter event (QDragEnterEvent)
2312 </dd>
2313 </dl><a NAME="UserInterface.dragLeaveEvent" ID="UserInterface.dragLeaveEvent"></a>
2314 <h4>UserInterface.dragLeaveEvent</h4>
2315 <b>dragLeaveEvent</b>(<i>event</i>)
2316 <p>
2317 Protected method to handle the drag leave event.
2318 </p><dl>
2319 <dt><i>event</i></dt>
2320 <dd>
2321 the drag leave event (QDragLeaveEvent)
2322 </dd>
2323 </dl><a NAME="UserInterface.dragMoveEvent" ID="UserInterface.dragMoveEvent"></a>
2324 <h4>UserInterface.dragMoveEvent</h4>
2325 <b>dragMoveEvent</b>(<i>event</i>)
2326 <p>
2327 Protected method to handle the drag move event.
2328 </p><dl>
2329 <dt><i>event</i></dt>
2330 <dd>
2331 the drag move event (QDragMoveEvent)
2332 </dd>
2333 </dl><a NAME="UserInterface.dropEvent" ID="UserInterface.dropEvent"></a>
2334 <h4>UserInterface.dropEvent</h4>
2335 <b>dropEvent</b>(<i>event</i>)
2336 <p>
2337 Protected method to handle the drop event.
2338 </p><dl>
2339 <dt><i>event</i></dt>
2340 <dd>
2341 the drop event (QDropEvent)
2342 </dd>
2343 </dl><a NAME="UserInterface.getActions" ID="UserInterface.getActions"></a>
2344 <h4>UserInterface.getActions</h4>
2345 <b>getActions</b>(<i>actionType</i>)
2346 <p>
2347 Public method to get a list of all actions.
2348 </p><dl>
2349 <dt><i>actionType</i></dt>
2350 <dd>
2351 string denoting the action set to get.
2352 It must be one of "ui" or "wizards".
2353 </dd>
2354 </dl><dl>
2355 <dt>Returns:</dt>
2356 <dd>
2357 list of all actions (list of E5Action)
2358 </dd>
2359 </dl><a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a>
2360 <h4>UserInterface.getLayoutType</h4>
2361 <b>getLayoutType</b>(<i></i>)
2362 <p>
2363 Public method to get the current layout type.
2364 </p><dl>
2365 <dt>Returns:</dt>
2366 <dd>
2367 current layout type
2368 </dd>
2369 </dl><dl>
2370 <dt>Return Type:</dt>
2371 <dd>
2372 str
2373 </dd>
2374 </dl><a NAME="UserInterface.getLocale" ID="UserInterface.getLocale"></a>
2375 <h4>UserInterface.getLocale</h4>
2376 <b>getLocale</b>(<i></i>)
2377 <p>
2378 Public method to get the locale of the IDE.
2379 </p><dl>
2380 <dt>Returns:</dt>
2381 <dd>
2382 locale of the IDE (string or None)
2383 </dd>
2384 </dl><a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a>
2385 <h4>UserInterface.getMenu</h4>
2386 <b>getMenu</b>(<i>name</i>)
2387 <p>
2388 Public method to get a reference to a specific menu.
2389 </p><dl>
2390 <dt><i>name</i></dt>
2391 <dd>
2392 name of the menu (string)
2393 </dd>
2394 </dl><dl>
2395 <dt>Returns:</dt>
2396 <dd>
2397 reference to the menu (QMenu)
2398 </dd>
2399 </dl><a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a>
2400 <h4>UserInterface.getMenuAction</h4>
2401 <b>getMenuAction</b>(<i>menuName, actionName</i>)
2402 <p>
2403 Public method to get a reference to an action of a menu.
2404 </p><dl>
2405 <dt><i>menuName</i></dt>
2406 <dd>
2407 name of the menu to search in (string)
2408 </dd><dt><i>actionName</i></dt>
2409 <dd>
2410 object name of the action to search for
2411 (string)
2412 </dd>
2413 </dl><dl>
2414 <dt>Returns:</dt>
2415 <dd>
2416 reference to the menu action (QAction)
2417 </dd>
2418 </dl><a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a>
2419 <h4>UserInterface.getMenuBarAction</h4>
2420 <b>getMenuBarAction</b>(<i>menuName</i>)
2421 <p>
2422 Public method to get a reference to an action of the main menu.
2423 </p><dl>
2424 <dt><i>menuName</i></dt>
2425 <dd>
2426 name of the menu to search in (string)
2427 </dd>
2428 </dl><dl>
2429 <dt>Returns:</dt>
2430 <dd>
2431 reference to the menu bar action (QAction)
2432 </dd>
2433 </dl><a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a>
2434 <h4>UserInterface.getOriginalPathString</h4>
2435 <b>getOriginalPathString</b>(<i></i>)
2436 <p>
2437 Public method to get the original PATH environment variable
2438 (i.e. before modifications by eric6 and PyQt5).
2439 </p><dl>
2440 <dt>Returns:</dt>
2441 <dd>
2442 original PATH environment variable
2443 </dd>
2444 </dl><dl>
2445 <dt>Return Type:</dt>
2446 <dd>
2447 str
2448 </dd>
2449 </dl><a NAME="UserInterface.getToolBarIconSize" ID="UserInterface.getToolBarIconSize"></a>
2450 <h4>UserInterface.getToolBarIconSize</h4>
2451 <b>getToolBarIconSize</b>(<i></i>)
2452 <p>
2453 Public method to get the toolbar icon size.
2454 </p><dl>
2455 <dt>Returns:</dt>
2456 <dd>
2457 toolbar icon size (QSize)
2458 </dd>
2459 </dl><a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a>
2460 <h4>UserInterface.getToolbar</h4>
2461 <b>getToolbar</b>(<i>name</i>)
2462 <p>
2463 Public method to get a reference to a specific toolbar.
2464 </p><dl>
2465 <dt><i>name</i></dt>
2466 <dd>
2467 name of the toolbar (string)
2468 </dd>
2469 </dl><dl>
2470 <dt>Returns:</dt>
2471 <dd>
2472 reference to the toolbar entry (tuple of string and QToolBar)
2473 </dd>
2474 </dl><a NAME="UserInterface.getViewProfile" ID="UserInterface.getViewProfile"></a>
2475 <h4>UserInterface.getViewProfile</h4>
2476 <b>getViewProfile</b>(<i></i>)
2477 <p>
2478 Public method to get the current view profile.
2479 </p><dl>
2480 <dt>Returns:</dt>
2481 <dd>
2482 the name of the current view profile (string)
2483 </dd>
2484 </dl><a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a>
2485 <h4>UserInterface.handleUrl</h4>
2486 <b>handleUrl</b>(<i>url</i>)
2487 <p>
2488 Public slot to handle opening a URL.
2489 </p><dl>
2490 <dt><i>url</i> (QUrl)</dt>
2491 <dd>
2492 URL to be shown
2493 </dd>
2494 </dl><a NAME="UserInterface.isOnline" ID="UserInterface.isOnline"></a>
2495 <h4>UserInterface.isOnline</h4>
2496 <b>isOnline</b>(<i></i>)
2497 <p>
2498 Public method to get the online state.
2499 </p><dl>
2500 <dt>Returns:</dt>
2501 <dd>
2502 online state
2503 </dd>
2504 </dl><dl>
2505 <dt>Return Type:</dt>
2506 <dd>
2507 bool
2508 </dd>
2509 </dl><a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a>
2510 <h4>UserInterface.launchHelpViewer</h4>
2511 <b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>)
2512 <p>
2513 Public slot to start the help viewer/web browser.
2514 </p><dl>
2515 <dt><i>home</i> (str or QUrl)</dt>
2516 <dd>
2517 filename of file to be shown or URL to be opened
2518 </dd><dt><i>searchWord=</i> (str)</dt>
2519 <dd>
2520 word to search for
2521 </dd><dt><i>useSingle=</i> (bool)</dt>
2522 <dd>
2523 flag indicating to use a single browser window
2524 </dd>
2525 </dl><a NAME="UserInterface.notificationsEnabled" ID="UserInterface.notificationsEnabled"></a>
2526 <h4>UserInterface.notificationsEnabled</h4>
2527 <b>notificationsEnabled</b>(<i></i>)
2528 <p>
2529 Public method to check, if notifications are enabled.
2530 </p><dl>
2531 <dt>Returns:</dt>
2532 <dd>
2533 flag indicating, if notifications are enabled (boolean)
2534 </dd>
2535 </dl><a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a>
2536 <h4>UserInterface.performVersionCheck</h4>
2537 <b>performVersionCheck</b>(<i>manual=True, alternative=0, showVersions=False</i>)
2538 <p>
2539 Public method to check the internet for an eric6 update.
2540 </p><dl>
2541 <dt><i>manual</i></dt>
2542 <dd>
2543 flag indicating an invocation via the menu (boolean)
2544 </dd><dt><i>alternative</i></dt>
2545 <dd>
2546 index of server to download from (integer)
2547 </dd><dt><i>showVersions=</i></dt>
2548 <dd>
2549 flag indicating the show versions mode (boolean)
2550 </dd>
2551 </dl><a NAME="UserInterface.processArgs" ID="UserInterface.processArgs"></a>
2552 <h4>UserInterface.processArgs</h4>
2553 <b>processArgs</b>(<i>args</i>)
2554 <p>
2555 Public method to process the command line args passed to the UI.
2556 </p><dl>
2557 <dt><i>args</i></dt>
2558 <dd>
2559 list of files to open<br />
2560 The args are processed one at a time. All arguments after a
2561 '--' option are considered debug arguments to the program
2562 for the debugger. All files named before the '--' option
2563 are opened in a text editor, unless the argument ends in
2564 .e4p, then it is opened as a project file. If it ends in
2565 .e4m or .e5m, it is opened as a multiproject.
2566 </dd>
2567 </dl><a NAME="UserInterface.registerToolbar" ID="UserInterface.registerToolbar"></a>
2568 <h4>UserInterface.registerToolbar</h4>
2569 <b>registerToolbar</b>(<i>name, text, toolbar</i>)
2570 <p>
2571 Public method to register a toolbar.
2572 </p><p>
2573 This method must be called in order to make a toolbar manageable by the
2574 UserInterface object.
2575 </p><dl>
2576 <dt><i>name</i></dt>
2577 <dd>
2578 name of the toolbar (string). This is used as the key into
2579 the dictionary of toolbar references.
2580 </dd><dt><i>text</i></dt>
2581 <dd>
2582 user visible text for the toolbar entry (string)
2583 </dd><dt><i>toolbar</i></dt>
2584 <dd>
2585 reference to the toolbar to be registered (QToolBar)
2586 </dd>
2587 </dl><dl>
2588 <dt>Raises <b>KeyError</b>:</dt>
2589 <dd>
2590 raised, if a toolbar with the given name was
2591 already registered
2592 </dd>
2593 </dl><a NAME="UserInterface.removeE5Actions" ID="UserInterface.removeE5Actions"></a>
2594 <h4>UserInterface.removeE5Actions</h4>
2595 <b>removeE5Actions</b>(<i>actions, actionType='ui'</i>)
2596 <p>
2597 Public method to remove actions from the list of actions.
2598 </p><dl>
2599 <dt><i>actions</i></dt>
2600 <dd>
2601 list of actions (list of E5Action)
2602 </dd><dt><i>actionType</i></dt>
2603 <dd>
2604 string denoting the action set to remove from.
2605 It must be one of "ui" or "wizards".
2606 </dd>
2607 </dl><a NAME="UserInterface.removeSideWidget" ID="UserInterface.removeSideWidget"></a>
2608 <h4>UserInterface.removeSideWidget</h4>
2609 <b>removeSideWidget</b>(<i>widget</i>)
2610 <p>
2611 Public method to remove a widget added using addSideWidget().
2612 </p><dl>
2613 <dt><i>widget</i></dt>
2614 <dd>
2615 reference to the widget to remove (QWidget)
2616 </dd>
2617 </dl><a NAME="UserInterface.reregisterToolbar" ID="UserInterface.reregisterToolbar"></a>
2618 <h4>UserInterface.reregisterToolbar</h4>
2619 <b>reregisterToolbar</b>(<i>name, text</i>)
2620 <p>
2621 Public method to change the visible text for the named toolbar.
2622 </p><dl>
2623 <dt><i>name</i></dt>
2624 <dd>
2625 name of the toolbar to be changed (string)
2626 </dd><dt><i>text</i></dt>
2627 <dd>
2628 new user visible text for the toolbar entry (string)
2629 </dd>
2630 </dl><a NAME="UserInterface.setDebugProfile" ID="UserInterface.setDebugProfile"></a>
2631 <h4>UserInterface.setDebugProfile</h4>
2632 <b>setDebugProfile</b>(<i>save=True</i>)
2633 <p>
2634 Public slot to activate the debug view profile.
2635 </p><dl>
2636 <dt><i>save</i></dt>
2637 <dd>
2638 flag indicating that the current profile should
2639 be saved (boolean)
2640 </dd>
2641 </dl><a NAME="UserInterface.showAvailableVersionsInfo" ID="UserInterface.showAvailableVersionsInfo"></a>
2642 <h4>UserInterface.showAvailableVersionsInfo</h4>
2643 <b>showAvailableVersionsInfo</b>(<i></i>)
2644 <p>
2645 Public method to show the eric6 versions available for download.
2646 </p><a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a>
2647 <h4>UserInterface.showEmailDialog</h4>
2648 <b>showEmailDialog</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
2649 <p>
2650 Public slot to show the email dialog in a given mode.
2651 </p><dl>
2652 <dt><i>mode</i></dt>
2653 <dd>
2654 mode of the email dialog (string, "bug" or "feature")
2655 </dd><dt><i>attachFile</i></dt>
2656 <dd>
2657 name of a file to attach to the email (string)
2658 </dd><dt><i>deleteAttachFile</i></dt>
2659 <dd>
2660 flag indicating to delete the attached file
2661 after it has been sent (boolean)
2662 </dd>
2663 </dl><a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a>
2664 <h4>UserInterface.showEvent</h4>
2665 <b>showEvent</b>(<i>evt</i>)
2666 <p>
2667 Protected method to handle the show event.
2668 </p><dl>
2669 <dt><i>evt</i></dt>
2670 <dd>
2671 reference to the show event (QShowEvent)
2672 </dd>
2673 </dl><a NAME="UserInterface.showFindFileByNameDialog" ID="UserInterface.showFindFileByNameDialog"></a>
2674 <h4>UserInterface.showFindFileByNameDialog</h4>
2675 <b>showFindFileByNameDialog</b>(<i></i>)
2676 <p>
2677 Public slot to show the Find File by Name dialog.
2678 </p><a NAME="UserInterface.showFindFilesDialog" ID="UserInterface.showFindFilesDialog"></a>
2679 <h4>UserInterface.showFindFilesDialog</h4>
2680 <b>showFindFilesDialog</b>(<i>txt="", searchDir="", openFiles=False</i>)
2681 <p>
2682 Public slot to show the Find In Files dialog.
2683 </p><dl>
2684 <dt><i>txt=</i></dt>
2685 <dd>
2686 text to search for (string)
2687 </dd><dt><i>searchDir=</i></dt>
2688 <dd>
2689 directory to search in (string)
2690 </dd><dt><i>openFiles=</i></dt>
2691 <dd>
2692 flag indicating to operate on open files (boolean)
2693 </dd>
2694 </dl><a NAME="UserInterface.showLogViewer" ID="UserInterface.showLogViewer"></a>
2695 <h4>UserInterface.showLogViewer</h4>
2696 <b>showLogViewer</b>(<i></i>)
2697 <p>
2698 Public method to show the Log-Viewer.
2699 </p><a NAME="UserInterface.showNotification" ID="UserInterface.showNotification"></a>
2700 <h4>UserInterface.showNotification</h4>
2701 <b>showNotification</b>(<i>icon, heading, text, timeout=None</i>)
2702 <p>
2703 Public method to show a desktop notification.
2704 </p><dl>
2705 <dt><i>icon</i> (QPixmap)</dt>
2706 <dd>
2707 icon to be shown in the notification
2708 </dd><dt><i>heading</i> (str)</dt>
2709 <dd>
2710 heading of the notification
2711 </dd><dt><i>text</i> (str)</dt>
2712 <dd>
2713 text of the notification
2714 </dd><dt><i>timeout</i> (int)</dt>
2715 <dd>
2716 time in seconds the notification should be shown
2717 (None = use configured timeout, 0 = indefinitely)
2718 </dd>
2719 </dl><a NAME="UserInterface.showPluginsAvailable" ID="UserInterface.showPluginsAvailable"></a>
2720 <h4>UserInterface.showPluginsAvailable</h4>
2721 <b>showPluginsAvailable</b>(<i></i>)
2722 <p>
2723 Public slot to show the plugins available for download.
2724 </p><a NAME="UserInterface.showPreferences" ID="UserInterface.showPreferences"></a>
2725 <h4>UserInterface.showPreferences</h4>
2726 <b>showPreferences</b>(<i>pageName=None</i>)
2727 <p>
2728 Public slot to set the preferences.
2729 </p><dl>
2730 <dt><i>pageName</i></dt>
2731 <dd>
2732 name of the configuration page to show (string)
2733 </dd>
2734 </dl><a NAME="UserInterface.showReplaceFilesDialog" ID="UserInterface.showReplaceFilesDialog"></a>
2735 <h4>UserInterface.showReplaceFilesDialog</h4>
2736 <b>showReplaceFilesDialog</b>(<i>txt="", searchDir="", openFiles=False</i>)
2737 <p>
2738 Public slot to show the Find & Replace In Files dialog.
2739 </p><dl>
2740 <dt><i>txt=</i></dt>
2741 <dd>
2742 text to search for (string)
2743 </dd><dt><i>searchDir=</i></dt>
2744 <dd>
2745 directory to search in (string)
2746 </dd><dt><i>openFiles=</i></dt>
2747 <dd>
2748 flag indicating to operate on open files (boolean)
2749 </dd>
2750 </dl><a NAME="UserInterface.unregisterToolbar" ID="UserInterface.unregisterToolbar"></a>
2751 <h4>UserInterface.unregisterToolbar</h4>
2752 <b>unregisterToolbar</b>(<i>name</i>)
2753 <p>
2754 Public method to unregister a toolbar.
2755 </p><dl>
2756 <dt><i>name</i></dt>
2757 <dd>
2758 name of the toolbar (string).
2759 </dd>
2760 </dl><a NAME="UserInterface.versionIsNewer" ID="UserInterface.versionIsNewer"></a>
2761 <h4>UserInterface.versionIsNewer</h4>
2762 <b>versionIsNewer</b>(<i>required, snapshot=None</i>)
2763 <p>
2764 Public method to check, if the eric6 version is good compared to
2765 the required version.
2766 </p><dl>
2767 <dt><i>required</i></dt>
2768 <dd>
2769 required version (string)
2770 </dd><dt><i>snapshot</i></dt>
2771 <dd>
2772 required snapshot version (string)
2773 </dd>
2774 </dl><dl>
2775 <dt>Returns:</dt>
2776 <dd>
2777 flag indicating, that the version is newer than the required
2778 one (boolean)
2779 </dd>
2780 </dl>
2781 <div align="right"><a href="#top">Up</a></div>
2782 <hr />
2783 </body></html>

Mercurial Repository: eric

eric ide

mercurial