Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.UI.UserInterface.html

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

Mercurial Repository: eric

eric ide

mercurial