Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.UI.UserInterface.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.UI.UserInterface</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.UI.UserInterface</h1>
24 <p>
25 Module implementing the main user interface.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#Redirector">Redirector</a></td>
35 <td>Helper class used to redirect stdout and stderr to the log window</td>
36 </tr><tr>
37 <td><a href="#UserInterface">UserInterface</a></td>
38 <td>Class implementing the main user interface.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="Redirector" ID="Redirector"></a>
47 <h2>Redirector</h2>
48 <p>
49 Helper class used to redirect stdout and stderr to the log window
50 </p><h4>Signals</h4>
51 <dl>
52 <dt>appendStderr(string)</dt>
53 <dd>
54 emitted to write data to stderr logger
55 </dd><dt>appendStdout(string)</dt>
56 <dd>
57 emitted to write data to stdout logger
58 </dd>
59 </dl>
60 <h3>Derived from</h3>
61 QObject
62 <h3>Class Attributes</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Methods</h3>
67 <table>
68 <tr>
69 <td><a href="#Redirector.__init__">Redirector</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#Redirector.__bufferedWrite">__bufferedWrite</a></td>
73 <td>Private method returning number of characters to write.</td>
74 </tr><tr>
75 <td><a href="#Redirector.__nWrite">__nWrite</a></td>
76 <td>Private method used to write data.</td>
77 </tr><tr>
78 <td><a href="#Redirector.flush">flush</a></td>
79 <td>Public method used to flush the buffered data.</td>
80 </tr><tr>
81 <td><a href="#Redirector.write">write</a></td>
82 <td>Public method used to write data.</td>
83 </tr>
84 </table>
85 <a NAME="Redirector.__init__" ID="Redirector.__init__"></a>
86 <h4>Redirector (Constructor)</h4>
87 <b>Redirector</b>(<i>stderr</i>)
88 <p>
89 Constructor
90 </p><dl>
91 <dt><i>stderr</i></dt>
92 <dd>
93 flag indicating stderr is being redirected
94 </dd>
95 </dl><a NAME="Redirector.__bufferedWrite" ID="Redirector.__bufferedWrite"></a>
96 <h4>Redirector.__bufferedWrite</h4>
97 <b>__bufferedWrite</b>(<i></i>)
98 <p>
99 Private method returning number of characters to write.
100 </p><dl>
101 <dt>Returns:</dt>
102 <dd>
103 number of characters buffered or length of buffered line (integer)
104 </dd>
105 </dl><a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a>
106 <h4>Redirector.__nWrite</h4>
107 <b>__nWrite</b>(<i>n</i>)
108 <p>
109 Private method used to write data.
110 </p><dl>
111 <dt><i>n</i></dt>
112 <dd>
113 max number of bytes to write
114 </dd>
115 </dl><a NAME="Redirector.flush" ID="Redirector.flush"></a>
116 <h4>Redirector.flush</h4>
117 <b>flush</b>(<i></i>)
118 <p>
119 Public method used to flush the buffered data.
120 </p><a NAME="Redirector.write" ID="Redirector.write"></a>
121 <h4>Redirector.write</h4>
122 <b>write</b>(<i>s</i>)
123 <p>
124 Public method used to write data.
125 </p><dl>
126 <dt><i>s</i></dt>
127 <dd>
128 data to be written (it must support the str-method)
129 </dd>
130 </dl>
131 <div align="right"><a href="#top">Up</a></div>
132 <hr /><hr />
133 <a NAME="UserInterface" ID="UserInterface"></a>
134 <h2>UserInterface</h2>
135 <p>
136 Class implementing the main user interface.
137 </p><h4>Signals</h4>
138 <dl>
139 <dt>appendStderr(QString)</dt>
140 <dd>
141 emitted to write data to stderr logger
142 </dd><dt>appendStdout(QString)</dt>
143 <dd>
144 emitted to write data to stdout logger
145 </dd><dt>preferencesChanged()</dt>
146 <dd>
147 emitted after the preferences were changed
148 </dd><dt>reloadAPIs()</dt>
149 <dd>
150 emitted to reload the api information
151 </dd><dt>showMenu(string, QMenu)</dt>
152 <dd>
153 emitted when a menu is about to be shown. The name
154 of the menu and a reference to the menu are given.
155 </dd>
156 </dl>
157 <h3>Derived from</h3>
158 QMainWindow
159 <h3>Class Attributes</h3>
160 <table>
161 <tr><td>maxFilePathLen</td></tr><tr><td>maxMenuFilePathLen</td></tr><tr><td>maxSbFilePathLen</td></tr>
162 </table>
163 <h3>Methods</h3>
164 <table>
165 <tr>
166 <td><a href="#UserInterface.__init__">UserInterface</a></td>
167 <td>Constructor</td>
168 </tr><tr>
169 <td><a href="#UserInterface.__TBMenuTriggered">__TBMenuTriggered</a></td>
170 <td>Private method to handle the toggle of a toolbar.</td>
171 </tr><tr>
172 <td><a href="#UserInterface.__TRPreviewer">__TRPreviewer</a></td>
173 <td>Private slot to start the Translation Previewer executable.</td>
174 </tr><tr>
175 <td><a href="#UserInterface.__UIPreviewer">__UIPreviewer</a></td>
176 <td>Private slot to start the UI Previewer executable.</td>
177 </tr><tr>
178 <td><a href="#UserInterface.__activateBrowser">__activateBrowser</a></td>
179 <td>Private slot to handle the activation of the file browser.</td>
180 </tr><tr>
181 <td><a href="#UserInterface.__activateDebugViewer">__activateDebugViewer</a></td>
182 <td>Private slot to handle the activation of the debug browser.</td>
183 </tr><tr>
184 <td><a href="#UserInterface.__activateLogViewer">__activateLogViewer</a></td>
185 <td>Private slot to handle the activation of the Log Viewer.</td>
186 </tr><tr>
187 <td><a href="#UserInterface.__activateMultiProjectBrowser">__activateMultiProjectBrowser</a></td>
188 <td>Private slot to handle the activation of the project browser.</td>
189 </tr><tr>
190 <td><a href="#UserInterface.__activateProjectBrowser">__activateProjectBrowser</a></td>
191 <td>Private slot to handle the activation of the project browser.</td>
192 </tr><tr>
193 <td><a href="#UserInterface.__activateShell">__activateShell</a></td>
194 <td>Private slot to handle the activation of the Shell window.</td>
195 </tr><tr>
196 <td><a href="#UserInterface.__activateTaskViewer">__activateTaskViewer</a></td>
197 <td>Private slot to handle the activation of the Task Viewer.</td>
198 </tr><tr>
199 <td><a href="#UserInterface.__activateTemplateViewer">__activateTemplateViewer</a></td>
200 <td>Private slot to handle the activation of the Template Viewer.</td>
201 </tr><tr>
202 <td><a href="#UserInterface.__activateTerminal">__activateTerminal</a></td>
203 <td>Private slot to handle the activation of the Terminal window.</td>
204 </tr><tr>
205 <td><a href="#UserInterface.__activateViewProfile">__activateViewProfile</a></td>
206 <td>Private slot to activate a view profile.</td>
207 </tr><tr>
208 <td><a href="#UserInterface.__activateViewmanager">__activateViewmanager</a></td>
209 <td>Private slot to handle the activation of the current editor.</td>
210 </tr><tr>
211 <td><a href="#UserInterface.__assistant">__assistant</a></td>
212 <td>Private slot to start the Qt-Assistant executable.</td>
213 </tr><tr>
214 <td><a href="#UserInterface.__assistant4">__assistant4</a></td>
215 <td>Private slot to start the Qt-Assistant 4 executable.</td>
216 </tr><tr>
217 <td><a href="#UserInterface.__checkActions">__checkActions</a></td>
218 <td>Private slot to check some actions for their enable/disable status.</td>
219 </tr><tr>
220 <td><a href="#UserInterface.__chmViewer">__chmViewer</a></td>
221 <td>Private slot to start the win help viewer to show *.chm files.</td>
222 </tr><tr>
223 <td><a href="#UserInterface.__compareFiles">__compareFiles</a></td>
224 <td>Private slot to handle the Compare Files dialog.</td>
225 </tr><tr>
226 <td><a href="#UserInterface.__compareFilesSbs">__compareFilesSbs</a></td>
227 <td>Private slot to handle the Compare Files dialog.</td>
228 </tr><tr>
229 <td><a href="#UserInterface.__configShortcuts">__configShortcuts</a></td>
230 <td>Private slot to configure the keyboard shortcuts.</td>
231 </tr><tr>
232 <td><a href="#UserInterface.__configToolBars">__configToolBars</a></td>
233 <td>Private slot to configure the various toolbars.</td>
234 </tr><tr>
235 <td><a href="#UserInterface.__configViewProfiles">__configViewProfiles</a></td>
236 <td>Private slot to configure the various view profiles.</td>
237 </tr><tr>
238 <td><a href="#UserInterface.__configureDockareaCornerUsage">__configureDockareaCornerUsage</a></td>
239 <td>Private method to configure the usage of the dockarea corners.</td>
240 </tr><tr>
241 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td>
242 <td>Private method to create a dock window with common properties.</td>
243 </tr><tr>
244 <td><a href="#UserInterface.__createDockWindowsLayout">__createDockWindowsLayout</a></td>
245 <td>Private method to create the DockWindows layout.</td>
246 </tr><tr>
247 <td><a href="#UserInterface.__createFloatingWindowsLayout">__createFloatingWindowsLayout</a></td>
248 <td>Private method to create the FloatingWindows layout.</td>
249 </tr><tr>
250 <td><a href="#UserInterface.__createLayout">__createLayout</a></td>
251 <td>Private method to create the layout of the various windows.</td>
252 </tr><tr>
253 <td><a href="#UserInterface.__createSidebarsLayout">__createSidebarsLayout</a></td>
254 <td>Private method to create the Sidebars layout.</td>
255 </tr><tr>
256 <td><a href="#UserInterface.__createToolboxesLayout">__createToolboxesLayout</a></td>
257 <td>Private method to create the Toolboxes layout.</td>
258 </tr><tr>
259 <td><a href="#UserInterface.__customViewer">__customViewer</a></td>
260 <td>Private slot to start a custom viewer.</td>
261 </tr><tr>
262 <td><a href="#UserInterface.__debuggingStarted">__debuggingStarted</a></td>
263 <td>Private slot to handle the start of a debugging session.</td>
264 </tr><tr>
265 <td><a href="#UserInterface.__deinstallPlugin">__deinstallPlugin</a></td>
266 <td>Private slot to show a dialog to uninstall a plugin.</td>
267 </tr><tr>
268 <td><a href="#UserInterface.__designer">__designer</a></td>
269 <td>Private slot to start the Qt-Designer executable.</td>
270 </tr><tr>
271 <td><a href="#UserInterface.__designer4">__designer4</a></td>
272 <td>Private slot to start the Qt-Designer 4 executable.</td>
273 </tr><tr>
274 <td><a href="#UserInterface.__editPixmap">__editPixmap</a></td>
275 <td>Private slot to show a pixmap in a dialog.</td>
276 </tr><tr>
277 <td><a href="#UserInterface.__editorOpened">__editorOpened</a></td>
278 <td>Private slot to handle the editorOpened signal.</td>
279 </tr><tr>
280 <td><a href="#UserInterface.__exportPreferences">__exportPreferences</a></td>
281 <td>Private slot to export the current preferences.</td>
282 </tr><tr>
283 <td><a href="#UserInterface.__exportShortcuts">__exportShortcuts</a></td>
284 <td>Private slot to export the keyboard shortcuts.</td>
285 </tr><tr>
286 <td><a href="#UserInterface.__getFloatingGeometry">__getFloatingGeometry</a></td>
287 <td>Private method to get the geometry of a floating windows.</td>
288 </tr><tr>
289 <td><a href="#UserInterface.__helpClosed">__helpClosed</a></td>
290 <td>Private slot to handle the helpClosed signal of the help window.</td>
291 </tr><tr>
292 <td><a href="#UserInterface.__helpViewer">__helpViewer</a></td>
293 <td>Private slot to start an empty help viewer.</td>
294 </tr><tr>
295 <td><a href="#UserInterface.__importPreferences">__importPreferences</a></td>
296 <td>Private slot to import preferences.</td>
297 </tr><tr>
298 <td><a href="#UserInterface.__importShortcuts">__importShortcuts</a></td>
299 <td>Private slot to import the keyboard shortcuts.</td>
300 </tr><tr>
301 <td><a href="#UserInterface.__initActions">__initActions</a></td>
302 <td>Private method to define the user interface actions.</td>
303 </tr><tr>
304 <td><a href="#UserInterface.__initEricDocAction">__initEricDocAction</a></td>
305 <td>Private slot to initialize the action to show the eric4 documentation.</td>
306 </tr><tr>
307 <td><a href="#UserInterface.__initExternalToolsActions">__initExternalToolsActions</a></td>
308 <td>Private slot to create actions for the configured external tools.</td>
309 </tr><tr>
310 <td><a href="#UserInterface.__initMenus">__initMenus</a></td>
311 <td>Private slot to create the menus.</td>
312 </tr><tr>
313 <td><a href="#UserInterface.__initPySideDocActions">__initPySideDocActions</a></td>
314 <td>Private slot to initilize the action to show the PySide documentation.</td>
315 </tr><tr>
316 <td><a href="#UserInterface.__initPythonDocAction">__initPythonDocAction</a></td>
317 <td>Private slot to initilize the action to show the Python documentation.</td>
318 </tr><tr>
319 <td><a href="#UserInterface.__initQtDocActions">__initQtDocActions</a></td>
320 <td>Private slot to initilize the action to show the Qt documentation.</td>
321 </tr><tr>
322 <td><a href="#UserInterface.__initStatusbar">__initStatusbar</a></td>
323 <td>Private slot to set up the status bar.</td>
324 </tr><tr>
325 <td><a href="#UserInterface.__initToolbars">__initToolbars</a></td>
326 <td>Private slot to create the toolbars.</td>
327 </tr><tr>
328 <td><a href="#UserInterface.__installPlugins">__installPlugins</a></td>
329 <td>Private slot to show a dialog to install a new plugin.</td>
330 </tr><tr>
331 <td><a href="#UserInterface.__lastEditorClosed">__lastEditorClosed</a></td>
332 <td>Private slot to handle the lastEditorClosed signal.</td>
333 </tr><tr>
334 <td><a href="#UserInterface.__linguist">__linguist</a></td>
335 <td>Private slot to start the Qt-Linguist executable.</td>
336 </tr><tr>
337 <td><a href="#UserInterface.__linguist4">__linguist4</a></td>
338 <td>Private slot to start the Qt-Linguist 4 executable.</td>
339 </tr><tr>
340 <td><a href="#UserInterface.__newProject">__newProject</a></td>
341 <td>Private slot to handle the NewProject signal.</td>
342 </tr><tr>
343 <td><a href="#UserInterface.__openMiniEditor">__openMiniEditor</a></td>
344 <td>Private slot to show a mini editor window.</td>
345 </tr><tr>
346 <td><a href="#UserInterface.__openOnStartup">__openOnStartup</a></td>
347 <td>Private method to open the last file, project or multiproject.</td>
348 </tr><tr>
349 <td><a href="#UserInterface.__pluginsConfigure">__pluginsConfigure</a></td>
350 <td>Private slot to show the plugin manager configuration page.</td>
351 </tr><tr>
352 <td><a href="#UserInterface.__preferencesChanged">__preferencesChanged</a></td>
353 <td>Private slot to handle a change of the preferences.</td>
354 </tr><tr>
355 <td><a href="#UserInterface.__processToolStderr">__processToolStderr</a></td>
356 <td>Private slot to handle the readyReadStderr signal of a tool process.</td>
357 </tr><tr>
358 <td><a href="#UserInterface.__processToolStdout">__processToolStdout</a></td>
359 <td>Private slot to handle the readyReadStdout signal of a tool process.</td>
360 </tr><tr>
361 <td><a href="#UserInterface.__programChange">__programChange</a></td>
362 <td>Private slot to handle the programChange signal.</td>
363 </tr><tr>
364 <td><a href="#UserInterface.__projectClosed">__projectClosed</a></td>
365 <td>Private slot to handle the projectClosed signal.</td>
366 </tr><tr>
367 <td><a href="#UserInterface.__projectOpened">__projectOpened</a></td>
368 <td>Private slot to handle the projectOpened signal.</td>
369 </tr><tr>
370 <td><a href="#UserInterface.__proxyAuthenticationRequired">__proxyAuthenticationRequired</a></td>
371 <td>Private slot to handle a proxy authentication request.</td>
372 </tr><tr>
373 <td><a href="#UserInterface.__quit">__quit</a></td>
374 <td>Private method to quit the application.</td>
375 </tr><tr>
376 <td><a href="#UserInterface.__readSession">__readSession</a></td>
377 <td>Private slot to read in the session file (.e4s)</td>
378 </tr><tr>
379 <td><a href="#UserInterface.__readTasks">__readTasks</a></td>
380 <td>Private slot to read in the tasks file (.e4t)</td>
381 </tr><tr>
382 <td><a href="#UserInterface.__reloadAPIs">__reloadAPIs</a></td>
383 <td>Private slot to reload the api information.</td>
384 </tr><tr>
385 <td><a href="#UserInterface.__reportBug">__reportBug</a></td>
386 <td>Private slot to handle the Report Bug dialog.</td>
387 </tr><tr>
388 <td><a href="#UserInterface.__requestFeature">__requestFeature</a></td>
389 <td>Private slot to handle the Feature Request dialog.</td>
390 </tr><tr>
391 <td><a href="#UserInterface.__restart">__restart</a></td>
392 <td>Private method to restart the application.</td>
393 </tr><tr>
394 <td><a href="#UserInterface.__saveCurrentViewProfile">__saveCurrentViewProfile</a></td>
395 <td>Private slot to save the window geometries of the active profile.</td>
396 </tr><tr>
397 <td><a href="#UserInterface.__setEditProfile">__setEditProfile</a></td>
398 <td>Private slot to activate the edit view profile.</td>
399 </tr><tr>
400 <td><a href="#UserInterface.__setStyle">__setStyle</a></td>
401 <td>Private slot to set the style of the interface.</td>
402 </tr><tr>
403 <td><a href="#UserInterface.__setWindowCaption">__setWindowCaption</a></td>
404 <td>Private method to set the caption of the Main Window.</td>
405 </tr><tr>
406 <td><a href="#UserInterface.__setupDockWindow">__setupDockWindow</a></td>
407 <td>Private method to configure the dock window created with __createDockWindow().</td>
408 </tr><tr>
409 <td><a href="#UserInterface.__showAvailableVersionInfos">__showAvailableVersionInfos</a></td>
410 <td>Private method to show the versions available for download.</td>
411 </tr><tr>
412 <td><a href="#UserInterface.__showEmailDialog">__showEmailDialog</a></td>
413 <td>Private slot to show the email dialog in a given mode.</td>
414 </tr><tr>
415 <td><a href="#UserInterface.__showEricDoc">__showEricDoc</a></td>
416 <td>Private slot to show the Eric documentation.</td>
417 </tr><tr>
418 <td><a href="#UserInterface.__showExternalTools">__showExternalTools</a></td>
419 <td>Private slot to display a dialog show a list of external tools used by eric4.</td>
420 </tr><tr>
421 <td><a href="#UserInterface.__showExtrasMenu">__showExtrasMenu</a></td>
422 <td>Private slot to display the Extras menu.</td>
423 </tr><tr>
424 <td><a href="#UserInterface.__showFileMenu">__showFileMenu</a></td>
425 <td>Private slot to display the File menu.</td>
426 </tr><tr>
427 <td><a href="#UserInterface.__showHelpMenu">__showHelpMenu</a></td>
428 <td>Private slot to display the Help menu.</td>
429 </tr><tr>
430 <td><a href="#UserInterface.__showNext">__showNext</a></td>
431 <td>Private slot used to show the next tab or file.</td>
432 </tr><tr>
433 <td><a href="#UserInterface.__showPixmap">__showPixmap</a></td>
434 <td>Private slot to show a pixmap in a dialog.</td>
435 </tr><tr>
436 <td><a href="#UserInterface.__showPluginInfo">__showPluginInfo</a></td>
437 <td>Private slot to show the plugin info dialog.</td>
438 </tr><tr>
439 <td><a href="#UserInterface.__showPluginsAvailable">__showPluginsAvailable</a></td>
440 <td>Private slot to show the plugins available for download.</td>
441 </tr><tr>
442 <td><a href="#UserInterface.__showPrevious">__showPrevious</a></td>
443 <td>Private slot used to show the previous tab or file.</td>
444 </tr><tr>
445 <td><a href="#UserInterface.__showPyQt4Doc">__showPyQt4Doc</a></td>
446 <td>Private slot to show the PyQt4 documentation.</td>
447 </tr><tr>
448 <td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td>
449 <td>Private slot to show the PySide documentation.</td>
450 </tr><tr>
451 <td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td>
452 <td>Private slot to show the Python documentation.</td>
453 </tr><tr>
454 <td><a href="#UserInterface.__showQt4Doc">__showQt4Doc</a></td>
455 <td>Private slot to show the Qt4 documentation.</td>
456 </tr><tr>
457 <td><a href="#UserInterface.__showSvg">__showSvg</a></td>
458 <td>Private slot to show a SVG file in a dialog.</td>
459 </tr><tr>
460 <td><a href="#UserInterface.__showSystemEmailClient">__showSystemEmailClient</a></td>
461 <td>Private slot to show the system email dialog.</td>
462 </tr><tr>
463 <td><a href="#UserInterface.__showToolGroupsMenu">__showToolGroupsMenu</a></td>
464 <td>Private slot to display the Tool Groups menu.</td>
465 </tr><tr>
466 <td><a href="#UserInterface.__showToolbarsMenu">__showToolbarsMenu</a></td>
467 <td>Private slot to display the Toolbars menu.</td>
468 </tr><tr>
469 <td><a href="#UserInterface.__showToolsMenu">__showToolsMenu</a></td>
470 <td>Private slot to display the Tools menu.</td>
471 </tr><tr>
472 <td><a href="#UserInterface.__showVersions">__showVersions</a></td>
473 <td>Private slot to handle the Versions dialog.</td>
474 </tr><tr>
475 <td><a href="#UserInterface.__showWindowMenu">__showWindowMenu</a></td>
476 <td>Private slot to display the Window menu.</td>
477 </tr><tr>
478 <td><a href="#UserInterface.__showWizardsMenu">__showWizardsMenu</a></td>
479 <td>Private slot to display the Wizards menu.</td>
480 </tr><tr>
481 <td><a href="#UserInterface.__shutdown">__shutdown</a></td>
482 <td>Private method to perform all necessary steps to close down the IDE.</td>
483 </tr><tr>
484 <td><a href="#UserInterface.__sqlBrowser">__sqlBrowser</a></td>
485 <td>Private slot to start the SQL browser tool.</td>
486 </tr><tr>
487 <td><a href="#UserInterface.__sslErrors">__sslErrors</a></td>
488 <td>Private slot to handle SSL errors.</td>
489 </tr><tr>
490 <td><a href="#UserInterface.__startToolProcess">__startToolProcess</a></td>
491 <td>Private slot to start an external tool process.</td>
492 </tr><tr>
493 <td><a href="#UserInterface.__switchTab">__switchTab</a></td>
494 <td>Private slot used to switch between the current and the previous current tab.</td>
495 </tr><tr>
496 <td><a href="#UserInterface.__toggleBottomSidebar">__toggleBottomSidebar</a></td>
497 <td>Private slot to handle the toggle of the bottom sidebar window.</td>
498 </tr><tr>
499 <td><a href="#UserInterface.__toggleBrowser">__toggleBrowser</a></td>
500 <td>Private slot to handle the toggle of the File Browser window.</td>
501 </tr><tr>
502 <td><a href="#UserInterface.__toggleDebugViewer">__toggleDebugViewer</a></td>
503 <td>Private slot to handle the toggle of the debug viewer.</td>
504 </tr><tr>
505 <td><a href="#UserInterface.__toggleHorizontalToolbox">__toggleHorizontalToolbox</a></td>
506 <td>Private slot to handle the toggle of the Horizontal Toolbox window.</td>
507 </tr><tr>
508 <td><a href="#UserInterface.__toggleLeftSidebar">__toggleLeftSidebar</a></td>
509 <td>Private slot to handle the toggle of the left sidebar window.</td>
510 </tr><tr>
511 <td><a href="#UserInterface.__toggleLogViewer">__toggleLogViewer</a></td>
512 <td>Private slot to handle the toggle of the Log Viewer window.</td>
513 </tr><tr>
514 <td><a href="#UserInterface.__toggleMultiProjectBrowser">__toggleMultiProjectBrowser</a></td>
515 <td>Private slot to handle the toggle of the Project Browser window.</td>
516 </tr><tr>
517 <td><a href="#UserInterface.__toggleProjectBrowser">__toggleProjectBrowser</a></td>
518 <td>Private slot to handle the toggle of the Project Browser window.</td>
519 </tr><tr>
520 <td><a href="#UserInterface.__toggleShell">__toggleShell</a></td>
521 <td>Private slot to handle the toggle of the Shell window .</td>
522 </tr><tr>
523 <td><a href="#UserInterface.__toggleTaskViewer">__toggleTaskViewer</a></td>
524 <td>Private slot to handle the toggle of the Task Viewer window.</td>
525 </tr><tr>
526 <td><a href="#UserInterface.__toggleTemplateViewer">__toggleTemplateViewer</a></td>
527 <td>Private slot to handle the toggle of the Template Viewer window.</td>
528 </tr><tr>
529 <td><a href="#UserInterface.__toggleTerminal">__toggleTerminal</a></td>
530 <td>Private slot to handle the toggle of the Terminal window .</td>
531 </tr><tr>
532 <td><a href="#UserInterface.__toggleVerticalToolbox">__toggleVerticalToolbox</a></td>
533 <td>Private slot to handle the toggle of the Vertical Toolbox window.</td>
534 </tr><tr>
535 <td><a href="#UserInterface.__toggleWindow">__toggleWindow</a></td>
536 <td>Private method to toggle a workspace editor window.</td>
537 </tr><tr>
538 <td><a href="#UserInterface.__toolActionTriggered">__toolActionTriggered</a></td>
539 <td>Private slot called by external tools toolbar actions.</td>
540 </tr><tr>
541 <td><a href="#UserInterface.__toolExecute">__toolExecute</a></td>
542 <td>Private slot to execute a particular tool.</td>
543 </tr><tr>
544 <td><a href="#UserInterface.__toolFinished">__toolFinished</a></td>
545 <td>Private slot to handle the finished signal of a tool process.</td>
546 </tr><tr>
547 <td><a href="#UserInterface.__toolGroupSelected">__toolGroupSelected</a></td>
548 <td>Private slot to set the current tool group.</td>
549 </tr><tr>
550 <td><a href="#UserInterface.__toolGroupsConfiguration">__toolGroupsConfiguration</a></td>
551 <td>Private slot to handle the tool groups configuration menu entry.</td>
552 </tr><tr>
553 <td><a href="#UserInterface.__toolsConfiguration">__toolsConfiguration</a></td>
554 <td>Private slot to handle the tools configuration menu entry.</td>
555 </tr><tr>
556 <td><a href="#UserInterface.__unittest">__unittest</a></td>
557 <td>Private slot for displaying the unittest dialog.</td>
558 </tr><tr>
559 <td><a href="#UserInterface.__unittestProject">__unittestProject</a></td>
560 <td>Private slot for displaying the unittest dialog and run the current project.</td>
561 </tr><tr>
562 <td><a href="#UserInterface.__unittestRestart">__unittestRestart</a></td>
563 <td>Private slot to display the unittest dialog and rerun the last test.</td>
564 </tr><tr>
565 <td><a href="#UserInterface.__unittestScript">__unittestScript</a></td>
566 <td>Private slot for displaying the unittest dialog and run the current script.</td>
567 </tr><tr>
568 <td><a href="#UserInterface.__updateExternalToolsActions">__updateExternalToolsActions</a></td>
569 <td>Private method to update the external tools actions for the current tool group.</td>
570 </tr><tr>
571 <td><a href="#UserInterface.__updateVersionsUrls">__updateVersionsUrls</a></td>
572 <td>Private method to update the URLs from which to retrieve the versions file.</td>
573 </tr><tr>
574 <td><a href="#UserInterface.__versionCheckResult">__versionCheckResult</a></td>
575 <td>Private method to show the result of the version check action.</td>
576 </tr><tr>
577 <td><a href="#UserInterface.__versionsDownloadCanceled">__versionsDownloadCanceled</a></td>
578 <td>Private method called to cancel the version check.</td>
579 </tr><tr>
580 <td><a href="#UserInterface.__versionsDownloadDone">__versionsDownloadDone</a></td>
581 <td>Private method called, after the versions file has been downloaded from the internet.</td>
582 </tr><tr>
583 <td><a href="#UserInterface.__webBrowser">__webBrowser</a></td>
584 <td>Private slot to start the eric4 web browser.</td>
585 </tr><tr>
586 <td><a href="#UserInterface.__whatsThis">__whatsThis</a></td>
587 <td>Private slot called in to enter Whats This mode.</td>
588 </tr><tr>
589 <td><a href="#UserInterface.__writeSession">__writeSession</a></td>
590 <td>Private slot to write the session data to an XML file (.e4s).</td>
591 </tr><tr>
592 <td><a href="#UserInterface.__writeTasks">__writeTasks</a></td>
593 <td>Private slot to write the tasks data to an XML file (.e4t).</td>
594 </tr><tr>
595 <td><a href="#UserInterface.addE4Actions">addE4Actions</a></td>
596 <td>Public method to add actions to the list of actions.</td>
597 </tr><tr>
598 <td><a href="#UserInterface.appendToStderr">appendToStderr</a></td>
599 <td>Public slot to append text to the stderr log viewer tab.</td>
600 </tr><tr>
601 <td><a href="#UserInterface.appendToStdout">appendToStdout</a></td>
602 <td>Public slot to append text to the stdout log viewer tab.</td>
603 </tr><tr>
604 <td><a href="#UserInterface.checkConfigurationStatus">checkConfigurationStatus</a></td>
605 <td>Public method to check, if eric4 has been configured.</td>
606 </tr><tr>
607 <td><a href="#UserInterface.checkForErrorLog">checkForErrorLog</a></td>
608 <td>Public method to check for the presence of an error log and ask the user, what to do with it.</td>
609 </tr><tr>
610 <td><a href="#UserInterface.closeEvent">closeEvent</a></td>
611 <td>Private event handler for the close event.</td>
612 </tr><tr>
613 <td><a href="#UserInterface.dragEnterEvent">dragEnterEvent</a></td>
614 <td>Protected method to handle the drag enter event.</td>
615 </tr><tr>
616 <td><a href="#UserInterface.dragLeaveEvent">dragLeaveEvent</a></td>
617 <td>Protected method to handle the drag leave event.</td>
618 </tr><tr>
619 <td><a href="#UserInterface.dragMoveEvent">dragMoveEvent</a></td>
620 <td>Protected method to handle the drag move event.</td>
621 </tr><tr>
622 <td><a href="#UserInterface.dropEvent">dropEvent</a></td>
623 <td>Protected method to handle the drop event.</td>
624 </tr><tr>
625 <td><a href="#UserInterface.getActions">getActions</a></td>
626 <td>Public method to get a list of all actions.</td>
627 </tr><tr>
628 <td><a href="#UserInterface.getLocale">getLocale</a></td>
629 <td>Public method to get the locale of the IDE.</td>
630 </tr><tr>
631 <td><a href="#UserInterface.getMenu">getMenu</a></td>
632 <td>Public method to get a reference to a specific menu.</td>
633 </tr><tr>
634 <td><a href="#UserInterface.getMenuAction">getMenuAction</a></td>
635 <td>Public method to get a reference to an action of a menu.</td>
636 </tr><tr>
637 <td><a href="#UserInterface.getMenuBarAction">getMenuBarAction</a></td>
638 <td>Public method to get a reference to an action of the main menu.</td>
639 </tr><tr>
640 <td><a href="#UserInterface.getToolBarIconSize">getToolBarIconSize</a></td>
641 <td>Public method to get the toolbar icon size.</td>
642 </tr><tr>
643 <td><a href="#UserInterface.getToolbar">getToolbar</a></td>
644 <td>Public method to get a reference to a specific toolbar.</td>
645 </tr><tr>
646 <td><a href="#UserInterface.getViewProfile">getViewProfile</a></td>
647 <td>Public method to get the current view profile.</td>
648 </tr><tr>
649 <td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td>
650 <td>Public slot to start the help viewer.</td>
651 </tr><tr>
652 <td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td>
653 <td>Public method to check the internet for an eric4 update.</td>
654 </tr><tr>
655 <td><a href="#UserInterface.processArgs">processArgs</a></td>
656 <td>Public method to process the command line args passed to the UI.</td>
657 </tr><tr>
658 <td><a href="#UserInterface.registerToolbar">registerToolbar</a></td>
659 <td>Public method to register a toolbar.</td>
660 </tr><tr>
661 <td><a href="#UserInterface.removeE4Actions">removeE4Actions</a></td>
662 <td>Public method to remove actions from the list of actions.</td>
663 </tr><tr>
664 <td><a href="#UserInterface.reregisterToolbar">reregisterToolbar</a></td>
665 <td>Public method to change the visible text for the named toolbar.</td>
666 </tr><tr>
667 <td><a href="#UserInterface.setDebugProfile">setDebugProfile</a></td>
668 <td>Public slot to activate the debug view profile.</td>
669 </tr><tr>
670 <td><a href="#UserInterface.showAvailableVersionsInfo">showAvailableVersionsInfo</a></td>
671 <td>Public method to show the eric4 versions available for download.</td>
672 </tr><tr>
673 <td><a href="#UserInterface.showEvent">showEvent</a></td>
674 <td>Protected method to handle the show event.</td>
675 </tr><tr>
676 <td><a href="#UserInterface.showLogTab">showLogTab</a></td>
677 <td>Public method to show a particular Log-Viewer tab.</td>
678 </tr><tr>
679 <td><a href="#UserInterface.showPreferences">showPreferences</a></td>
680 <td>Public slot to set the preferences.</td>
681 </tr><tr>
682 <td><a href="#UserInterface.unregisterToolbar">unregisterToolbar</a></td>
683 <td>Public method to unregister a toolbar.</td>
684 </tr><tr>
685 <td><a href="#UserInterface.versionIsNewer">versionIsNewer</a></td>
686 <td>Public method to check, if the eric4 version is good compared to the required version.</td>
687 </tr>
688 </table>
689 <a NAME="UserInterface.__init__" ID="UserInterface.__init__"></a>
690 <h4>UserInterface (Constructor)</h4>
691 <b>UserInterface</b>(<i>locale, splash, plugin, noOpenAtStartup, restartArguments</i>)
692 <p>
693 Constructor
694 </p><dl>
695 <dt><i>locale</i></dt>
696 <dd>
697 locale to be used by the UI (string)
698 </dd><dt><i>splash</i></dt>
699 <dd>
700 reference to the splashscreen (UI.SplashScreen.SplashScreen)
701 </dd><dt><i>plugin</i></dt>
702 <dd>
703 filename of a plugin to be loaded (used for plugin development)
704 </dd><dt><i>noOpenAtStartup</i></dt>
705 <dd>
706 flag indicating that the open at startup option
707 should not be executed (boolean)
708 </dd><dt><i>restartArguments</i></dt>
709 <dd>
710 list of command line parameters to be used for a
711 restart (list of strings)
712 </dd>
713 </dl><a NAME="UserInterface.__TBMenuTriggered" ID="UserInterface.__TBMenuTriggered"></a>
714 <h4>UserInterface.__TBMenuTriggered</h4>
715 <b>__TBMenuTriggered</b>(<i>act</i>)
716 <p>
717 Private method to handle the toggle of a toolbar.
718 </p><dl>
719 <dt><i>act</i></dt>
720 <dd>
721 reference to the action that was triggered (QAction)
722 </dd>
723 </dl><a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a>
724 <h4>UserInterface.__TRPreviewer</h4>
725 <b>__TRPreviewer</b>(<i>fileNames = None, ignore = False</i>)
726 <p>
727 Private slot to start the Translation Previewer executable.
728 </p><dl>
729 <dt><i>fileNames</i></dt>
730 <dd>
731 filenames of forms and/or translations to be previewed
732 (list of strings)
733 </dd><dt><i>ignore</i></dt>
734 <dd>
735 flag indicating non existing files should be ignored (boolean)
736 </dd>
737 </dl><a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a>
738 <h4>UserInterface.__UIPreviewer</h4>
739 <b>__UIPreviewer</b>(<i>fn=None</i>)
740 <p>
741 Private slot to start the UI Previewer executable.
742 </p><dl>
743 <dt><i>fn</i></dt>
744 <dd>
745 filename of the form to be previewed (string)
746 </dd>
747 </dl><a NAME="UserInterface.__activateBrowser" ID="UserInterface.__activateBrowser"></a>
748 <h4>UserInterface.__activateBrowser</h4>
749 <b>__activateBrowser</b>(<i></i>)
750 <p>
751 Private slot to handle the activation of the file browser.
752 </p><a NAME="UserInterface.__activateDebugViewer" ID="UserInterface.__activateDebugViewer"></a>
753 <h4>UserInterface.__activateDebugViewer</h4>
754 <b>__activateDebugViewer</b>(<i></i>)
755 <p>
756 Private slot to handle the activation of the debug browser.
757 </p><a NAME="UserInterface.__activateLogViewer" ID="UserInterface.__activateLogViewer"></a>
758 <h4>UserInterface.__activateLogViewer</h4>
759 <b>__activateLogViewer</b>(<i></i>)
760 <p>
761 Private slot to handle the activation of the Log Viewer.
762 </p><a NAME="UserInterface.__activateMultiProjectBrowser" ID="UserInterface.__activateMultiProjectBrowser"></a>
763 <h4>UserInterface.__activateMultiProjectBrowser</h4>
764 <b>__activateMultiProjectBrowser</b>(<i></i>)
765 <p>
766 Private slot to handle the activation of the project browser.
767 </p><a NAME="UserInterface.__activateProjectBrowser" ID="UserInterface.__activateProjectBrowser"></a>
768 <h4>UserInterface.__activateProjectBrowser</h4>
769 <b>__activateProjectBrowser</b>(<i></i>)
770 <p>
771 Private slot to handle the activation of the project browser.
772 </p><a NAME="UserInterface.__activateShell" ID="UserInterface.__activateShell"></a>
773 <h4>UserInterface.__activateShell</h4>
774 <b>__activateShell</b>(<i></i>)
775 <p>
776 Private slot to handle the activation of the Shell window.
777 </p><a NAME="UserInterface.__activateTaskViewer" ID="UserInterface.__activateTaskViewer"></a>
778 <h4>UserInterface.__activateTaskViewer</h4>
779 <b>__activateTaskViewer</b>(<i></i>)
780 <p>
781 Private slot to handle the activation of the Task Viewer.
782 </p><a NAME="UserInterface.__activateTemplateViewer" ID="UserInterface.__activateTemplateViewer"></a>
783 <h4>UserInterface.__activateTemplateViewer</h4>
784 <b>__activateTemplateViewer</b>(<i></i>)
785 <p>
786 Private slot to handle the activation of the Template Viewer.
787 </p><a NAME="UserInterface.__activateTerminal" ID="UserInterface.__activateTerminal"></a>
788 <h4>UserInterface.__activateTerminal</h4>
789 <b>__activateTerminal</b>(<i></i>)
790 <p>
791 Private slot to handle the activation of the Terminal window.
792 </p><a NAME="UserInterface.__activateViewProfile" ID="UserInterface.__activateViewProfile"></a>
793 <h4>UserInterface.__activateViewProfile</h4>
794 <b>__activateViewProfile</b>(<i>name, save = True</i>)
795 <p>
796 Private slot to activate a view profile.
797 </p><dl>
798 <dt><i>name</i></dt>
799 <dd>
800 name of the profile to be activated (string)
801 </dd><dt><i>save</i></dt>
802 <dd>
803 flag indicating that the current profile should
804 be saved (boolean)
805 </dd>
806 </dl><a NAME="UserInterface.__activateViewmanager" ID="UserInterface.__activateViewmanager"></a>
807 <h4>UserInterface.__activateViewmanager</h4>
808 <b>__activateViewmanager</b>(<i></i>)
809 <p>
810 Private slot to handle the activation of the current editor.
811 </p><a NAME="UserInterface.__assistant" ID="UserInterface.__assistant"></a>
812 <h4>UserInterface.__assistant</h4>
813 <b>__assistant</b>(<i>home = None, version = 0</i>)
814 <p>
815 Private slot to start the Qt-Assistant executable.
816 </p><dl>
817 <dt><i>home</i></dt>
818 <dd>
819 full pathname of a file to display (string)
820 </dd><dt><i>version</i></dt>
821 <dd>
822 indication for the requested version (Qt 4) (integer)
823 </dd>
824 </dl><a NAME="UserInterface.__assistant4" ID="UserInterface.__assistant4"></a>
825 <h4>UserInterface.__assistant4</h4>
826 <b>__assistant4</b>(<i></i>)
827 <p>
828 Private slot to start the Qt-Assistant 4 executable.
829 </p><a NAME="UserInterface.__checkActions" ID="UserInterface.__checkActions"></a>
830 <h4>UserInterface.__checkActions</h4>
831 <b>__checkActions</b>(<i>editor</i>)
832 <p>
833 Private slot to check some actions for their enable/disable status.
834 </p><dl>
835 <dt><i>editor</i></dt>
836 <dd>
837 editor window
838 </dd>
839 </dl><a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a>
840 <h4>UserInterface.__chmViewer</h4>
841 <b>__chmViewer</b>(<i>home=None</i>)
842 <p>
843 Private slot to start the win help viewer to show *.chm files.
844 </p><dl>
845 <dt><i>home</i></dt>
846 <dd>
847 full pathname of a file to display (string)
848 </dd>
849 </dl><a NAME="UserInterface.__compareFiles" ID="UserInterface.__compareFiles"></a>
850 <h4>UserInterface.__compareFiles</h4>
851 <b>__compareFiles</b>(<i></i>)
852 <p>
853 Private slot to handle the Compare Files dialog.
854 </p><a NAME="UserInterface.__compareFilesSbs" ID="UserInterface.__compareFilesSbs"></a>
855 <h4>UserInterface.__compareFilesSbs</h4>
856 <b>__compareFilesSbs</b>(<i></i>)
857 <p>
858 Private slot to handle the Compare Files dialog.
859 </p><a NAME="UserInterface.__configShortcuts" ID="UserInterface.__configShortcuts"></a>
860 <h4>UserInterface.__configShortcuts</h4>
861 <b>__configShortcuts</b>(<i></i>)
862 <p>
863 Private slot to configure the keyboard shortcuts.
864 </p><a NAME="UserInterface.__configToolBars" ID="UserInterface.__configToolBars"></a>
865 <h4>UserInterface.__configToolBars</h4>
866 <b>__configToolBars</b>(<i></i>)
867 <p>
868 Private slot to configure the various toolbars.
869 </p><a NAME="UserInterface.__configViewProfiles" ID="UserInterface.__configViewProfiles"></a>
870 <h4>UserInterface.__configViewProfiles</h4>
871 <b>__configViewProfiles</b>(<i></i>)
872 <p>
873 Private slot to configure the various view profiles.
874 </p><a NAME="UserInterface.__configureDockareaCornerUsage" ID="UserInterface.__configureDockareaCornerUsage"></a>
875 <h4>UserInterface.__configureDockareaCornerUsage</h4>
876 <b>__configureDockareaCornerUsage</b>(<i></i>)
877 <p>
878 Private method to configure the usage of the dockarea corners.
879 </p><a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a>
880 <h4>UserInterface.__createDockWindow</h4>
881 <b>__createDockWindow</b>(<i>name</i>)
882 <p>
883 Private method to create a dock window with common properties.
884 </p><dl>
885 <dt><i>name</i></dt>
886 <dd>
887 object name of the new dock window (string)
888 </dd>
889 </dl><dl>
890 <dt>Returns:</dt>
891 <dd>
892 the generated dock window (QDockWindow)
893 </dd>
894 </dl><a NAME="UserInterface.__createDockWindowsLayout" ID="UserInterface.__createDockWindowsLayout"></a>
895 <h4>UserInterface.__createDockWindowsLayout</h4>
896 <b>__createDockWindowsLayout</b>(<i>debugServer</i>)
897 <p>
898 Private method to create the DockWindows layout.
899 </p><dl>
900 <dt><i>debugServer</i></dt>
901 <dd>
902 reference to the debug server object
903 </dd>
904 </dl><a NAME="UserInterface.__createFloatingWindowsLayout" ID="UserInterface.__createFloatingWindowsLayout"></a>
905 <h4>UserInterface.__createFloatingWindowsLayout</h4>
906 <b>__createFloatingWindowsLayout</b>(<i>debugServer</i>)
907 <p>
908 Private method to create the FloatingWindows layout.
909 </p><dl>
910 <dt><i>debugServer</i></dt>
911 <dd>
912 reference to the debug server object
913 </dd>
914 </dl><a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a>
915 <h4>UserInterface.__createLayout</h4>
916 <b>__createLayout</b>(<i>debugServer</i>)
917 <p>
918 Private method to create the layout of the various windows.
919 </p><dl>
920 <dt><i>debugServer</i></dt>
921 <dd>
922 reference to the debug server object
923 </dd>
924 </dl><a NAME="UserInterface.__createSidebarsLayout" ID="UserInterface.__createSidebarsLayout"></a>
925 <h4>UserInterface.__createSidebarsLayout</h4>
926 <b>__createSidebarsLayout</b>(<i>debugServer</i>)
927 <p>
928 Private method to create the Sidebars layout.
929 </p><dl>
930 <dt><i>debugServer</i></dt>
931 <dd>
932 reference to the debug server object
933 </dd>
934 </dl><a NAME="UserInterface.__createToolboxesLayout" ID="UserInterface.__createToolboxesLayout"></a>
935 <h4>UserInterface.__createToolboxesLayout</h4>
936 <b>__createToolboxesLayout</b>(<i>debugServer</i>)
937 <p>
938 Private method to create the Toolboxes layout.
939 </p><dl>
940 <dt><i>debugServer</i></dt>
941 <dd>
942 reference to the debug server object
943 </dd>
944 </dl><a NAME="UserInterface.__customViewer" ID="UserInterface.__customViewer"></a>
945 <h4>UserInterface.__customViewer</h4>
946 <b>__customViewer</b>(<i>home = None</i>)
947 <p>
948 Private slot to start a custom viewer.
949 </p><dl>
950 <dt><i>home</i></dt>
951 <dd>
952 full pathname of a file to display (string)
953 </dd>
954 </dl><a NAME="UserInterface.__debuggingStarted" ID="UserInterface.__debuggingStarted"></a>
955 <h4>UserInterface.__debuggingStarted</h4>
956 <b>__debuggingStarted</b>(<i></i>)
957 <p>
958 Private slot to handle the start of a debugging session.
959 </p><a NAME="UserInterface.__deinstallPlugin" ID="UserInterface.__deinstallPlugin"></a>
960 <h4>UserInterface.__deinstallPlugin</h4>
961 <b>__deinstallPlugin</b>(<i></i>)
962 <p>
963 Private slot to show a dialog to uninstall a plugin.
964 </p><a NAME="UserInterface.__designer" ID="UserInterface.__designer"></a>
965 <h4>UserInterface.__designer</h4>
966 <b>__designer</b>(<i>fn = None, version = 0</i>)
967 <p>
968 Private slot to start the Qt-Designer executable.
969 </p><dl>
970 <dt><i>fn</i></dt>
971 <dd>
972 filename of the form to be opened
973 </dd><dt><i>version</i></dt>
974 <dd>
975 indication for the requested version (Qt 4) (integer)
976 </dd>
977 </dl><a NAME="UserInterface.__designer4" ID="UserInterface.__designer4"></a>
978 <h4>UserInterface.__designer4</h4>
979 <b>__designer4</b>(<i></i>)
980 <p>
981 Private slot to start the Qt-Designer 4 executable.
982 </p><a NAME="UserInterface.__editPixmap" ID="UserInterface.__editPixmap"></a>
983 <h4>UserInterface.__editPixmap</h4>
984 <b>__editPixmap</b>(<i>fn = ""</i>)
985 <p>
986 Private slot to show a pixmap in a dialog.
987 </p><dl>
988 <dt><i>fn</i></dt>
989 <dd>
990 filename of the file to show (string)
991 </dd>
992 </dl><a NAME="UserInterface.__editorOpened" ID="UserInterface.__editorOpened"></a>
993 <h4>UserInterface.__editorOpened</h4>
994 <b>__editorOpened</b>(<i>fn</i>)
995 <p>
996 Private slot to handle the editorOpened signal.
997 </p><dl>
998 <dt><i>fn</i></dt>
999 <dd>
1000 filename of the opened editor (string)
1001 </dd>
1002 </dl><a NAME="UserInterface.__exportPreferences" ID="UserInterface.__exportPreferences"></a>
1003 <h4>UserInterface.__exportPreferences</h4>
1004 <b>__exportPreferences</b>(<i></i>)
1005 <p>
1006 Private slot to export the current preferences.
1007 </p><a NAME="UserInterface.__exportShortcuts" ID="UserInterface.__exportShortcuts"></a>
1008 <h4>UserInterface.__exportShortcuts</h4>
1009 <b>__exportShortcuts</b>(<i></i>)
1010 <p>
1011 Private slot to export the keyboard shortcuts.
1012 </p><a NAME="UserInterface.__getFloatingGeometry" ID="UserInterface.__getFloatingGeometry"></a>
1013 <h4>UserInterface.__getFloatingGeometry</h4>
1014 <b>__getFloatingGeometry</b>(<i>w</i>)
1015 <p>
1016 Private method to get the geometry of a floating windows.
1017 </p><dl>
1018 <dt><i>w</i></dt>
1019 <dd>
1020 reference to the widget to be saved (QWidget)
1021 </dd>
1022 </dl><dl>
1023 <dt>Returns:</dt>
1024 <dd>
1025 list giving the widget's geometry and it's visibility
1026 </dd>
1027 </dl><a NAME="UserInterface.__helpClosed" ID="UserInterface.__helpClosed"></a>
1028 <h4>UserInterface.__helpClosed</h4>
1029 <b>__helpClosed</b>(<i></i>)
1030 <p>
1031 Private slot to handle the helpClosed signal of the help window.
1032 </p><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
1033 <h4>UserInterface.__helpViewer</h4>
1034 <b>__helpViewer</b>(<i></i>)
1035 <p>
1036 Private slot to start an empty help viewer.
1037 </p><a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a>
1038 <h4>UserInterface.__importPreferences</h4>
1039 <b>__importPreferences</b>(<i></i>)
1040 <p>
1041 Private slot to import preferences.
1042 </p><a NAME="UserInterface.__importShortcuts" ID="UserInterface.__importShortcuts"></a>
1043 <h4>UserInterface.__importShortcuts</h4>
1044 <b>__importShortcuts</b>(<i></i>)
1045 <p>
1046 Private slot to import the keyboard shortcuts.
1047 </p><a NAME="UserInterface.__initActions" ID="UserInterface.__initActions"></a>
1048 <h4>UserInterface.__initActions</h4>
1049 <b>__initActions</b>(<i></i>)
1050 <p>
1051 Private method to define the user interface actions.
1052 </p><a NAME="UserInterface.__initEricDocAction" ID="UserInterface.__initEricDocAction"></a>
1053 <h4>UserInterface.__initEricDocAction</h4>
1054 <b>__initEricDocAction</b>(<i></i>)
1055 <p>
1056 Private slot to initialize the action to show the eric4 documentation.
1057 </p><a NAME="UserInterface.__initExternalToolsActions" ID="UserInterface.__initExternalToolsActions"></a>
1058 <h4>UserInterface.__initExternalToolsActions</h4>
1059 <b>__initExternalToolsActions</b>(<i></i>)
1060 <p>
1061 Private slot to create actions for the configured external tools.
1062 </p><a NAME="UserInterface.__initMenus" ID="UserInterface.__initMenus"></a>
1063 <h4>UserInterface.__initMenus</h4>
1064 <b>__initMenus</b>(<i></i>)
1065 <p>
1066 Private slot to create the menus.
1067 </p><a NAME="UserInterface.__initPySideDocActions" ID="UserInterface.__initPySideDocActions"></a>
1068 <h4>UserInterface.__initPySideDocActions</h4>
1069 <b>__initPySideDocActions</b>(<i></i>)
1070 <p>
1071 Private slot to initilize the action to show the PySide documentation.
1072 </p><a NAME="UserInterface.__initPythonDocAction" ID="UserInterface.__initPythonDocAction"></a>
1073 <h4>UserInterface.__initPythonDocAction</h4>
1074 <b>__initPythonDocAction</b>(<i></i>)
1075 <p>
1076 Private slot to initilize the action to show the Python documentation.
1077 </p><a NAME="UserInterface.__initQtDocActions" ID="UserInterface.__initQtDocActions"></a>
1078 <h4>UserInterface.__initQtDocActions</h4>
1079 <b>__initQtDocActions</b>(<i></i>)
1080 <p>
1081 Private slot to initilize the action to show the Qt documentation.
1082 </p><a NAME="UserInterface.__initStatusbar" ID="UserInterface.__initStatusbar"></a>
1083 <h4>UserInterface.__initStatusbar</h4>
1084 <b>__initStatusbar</b>(<i></i>)
1085 <p>
1086 Private slot to set up the status bar.
1087 </p><a NAME="UserInterface.__initToolbars" ID="UserInterface.__initToolbars"></a>
1088 <h4>UserInterface.__initToolbars</h4>
1089 <b>__initToolbars</b>(<i></i>)
1090 <p>
1091 Private slot to create the toolbars.
1092 </p><a NAME="UserInterface.__installPlugins" ID="UserInterface.__installPlugins"></a>
1093 <h4>UserInterface.__installPlugins</h4>
1094 <b>__installPlugins</b>(<i>pluginFileNames = []</i>)
1095 <p>
1096 Private slot to show a dialog to install a new plugin.
1097 </p><dl>
1098 <dt><i>pluginFileNames</i></dt>
1099 <dd>
1100 list of plugin files suggested for
1101 installation list of strings
1102 </dd>
1103 </dl><a NAME="UserInterface.__lastEditorClosed" ID="UserInterface.__lastEditorClosed"></a>
1104 <h4>UserInterface.__lastEditorClosed</h4>
1105 <b>__lastEditorClosed</b>(<i></i>)
1106 <p>
1107 Private slot to handle the lastEditorClosed signal.
1108 </p><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a>
1109 <h4>UserInterface.__linguist</h4>
1110 <b>__linguist</b>(<i>fn = None, version = 0</i>)
1111 <p>
1112 Private slot to start the Qt-Linguist executable.
1113 </p><dl>
1114 <dt><i>fn</i></dt>
1115 <dd>
1116 filename of the translation file to be opened
1117 </dd><dt><i>version</i></dt>
1118 <dd>
1119 indication for the requested version (Qt 4) (integer)
1120 </dd>
1121 </dl><a NAME="UserInterface.__linguist4" ID="UserInterface.__linguist4"></a>
1122 <h4>UserInterface.__linguist4</h4>
1123 <b>__linguist4</b>(<i>fn = None</i>)
1124 <p>
1125 Private slot to start the Qt-Linguist 4 executable.
1126 </p><dl>
1127 <dt><i>fn</i></dt>
1128 <dd>
1129 filename of the translation file to be opened
1130 </dd>
1131 </dl><a NAME="UserInterface.__newProject" ID="UserInterface.__newProject"></a>
1132 <h4>UserInterface.__newProject</h4>
1133 <b>__newProject</b>(<i></i>)
1134 <p>
1135 Private slot to handle the NewProject signal.
1136 </p><a NAME="UserInterface.__openMiniEditor" ID="UserInterface.__openMiniEditor"></a>
1137 <h4>UserInterface.__openMiniEditor</h4>
1138 <b>__openMiniEditor</b>(<i></i>)
1139 <p>
1140 Private slot to show a mini editor window.
1141 </p><a NAME="UserInterface.__openOnStartup" ID="UserInterface.__openOnStartup"></a>
1142 <h4>UserInterface.__openOnStartup</h4>
1143 <b>__openOnStartup</b>(<i>startupType = None</i>)
1144 <p>
1145 Private method to open the last file, project or multiproject.
1146 </p><dl>
1147 <dt><i>startupType</i></dt>
1148 <dd>
1149 type of startup requested (string, one of
1150 "Nothing", "File", "Project", "MultiProject" or "Session")
1151 </dd>
1152 </dl><a NAME="UserInterface.__pluginsConfigure" ID="UserInterface.__pluginsConfigure"></a>
1153 <h4>UserInterface.__pluginsConfigure</h4>
1154 <b>__pluginsConfigure</b>(<i></i>)
1155 <p>
1156 Private slot to show the plugin manager configuration page.
1157 </p><a NAME="UserInterface.__preferencesChanged" ID="UserInterface.__preferencesChanged"></a>
1158 <h4>UserInterface.__preferencesChanged</h4>
1159 <b>__preferencesChanged</b>(<i></i>)
1160 <p>
1161 Private slot to handle a change of the preferences.
1162 </p><a NAME="UserInterface.__processToolStderr" ID="UserInterface.__processToolStderr"></a>
1163 <h4>UserInterface.__processToolStderr</h4>
1164 <b>__processToolStderr</b>(<i></i>)
1165 <p>
1166 Private slot to handle the readyReadStderr signal of a tool process.
1167 </p><a NAME="UserInterface.__processToolStdout" ID="UserInterface.__processToolStdout"></a>
1168 <h4>UserInterface.__processToolStdout</h4>
1169 <b>__processToolStdout</b>(<i></i>)
1170 <p>
1171 Private slot to handle the readyReadStdout signal of a tool process.
1172 </p><a NAME="UserInterface.__programChange" ID="UserInterface.__programChange"></a>
1173 <h4>UserInterface.__programChange</h4>
1174 <b>__programChange</b>(<i>fn</i>)
1175 <p>
1176 Private slot to handle the programChange signal.
1177 </p><p>
1178 This primarily is here to set the currentProg variable.
1179 </p><dl>
1180 <dt><i>fn</i></dt>
1181 <dd>
1182 filename to be set as current prog (string)
1183 </dd>
1184 </dl><a NAME="UserInterface.__projectClosed" ID="UserInterface.__projectClosed"></a>
1185 <h4>UserInterface.__projectClosed</h4>
1186 <b>__projectClosed</b>(<i></i>)
1187 <p>
1188 Private slot to handle the projectClosed signal.
1189 </p><a NAME="UserInterface.__projectOpened" ID="UserInterface.__projectOpened"></a>
1190 <h4>UserInterface.__projectOpened</h4>
1191 <b>__projectOpened</b>(<i></i>)
1192 <p>
1193 Private slot to handle the projectOpened signal.
1194 </p><a NAME="UserInterface.__proxyAuthenticationRequired" ID="UserInterface.__proxyAuthenticationRequired"></a>
1195 <h4>UserInterface.__proxyAuthenticationRequired</h4>
1196 <b>__proxyAuthenticationRequired</b>(<i>proxy, auth</i>)
1197 <p>
1198 Private slot to handle a proxy authentication request.
1199 </p><dl>
1200 <dt><i>proxy</i></dt>
1201 <dd>
1202 reference to the proxy object (QNetworkProxy)
1203 </dd><dt><i>auth</i></dt>
1204 <dd>
1205 reference to the authenticator object (QAuthenticator)
1206 </dd>
1207 </dl><a NAME="UserInterface.__quit" ID="UserInterface.__quit"></a>
1208 <h4>UserInterface.__quit</h4>
1209 <b>__quit</b>(<i></i>)
1210 <p>
1211 Private method to quit the application.
1212 </p><a NAME="UserInterface.__readSession" ID="UserInterface.__readSession"></a>
1213 <h4>UserInterface.__readSession</h4>
1214 <b>__readSession</b>(<i></i>)
1215 <p>
1216 Private slot to read in the session file (.e4s)
1217 </p><a NAME="UserInterface.__readTasks" ID="UserInterface.__readTasks"></a>
1218 <h4>UserInterface.__readTasks</h4>
1219 <b>__readTasks</b>(<i></i>)
1220 <p>
1221 Private slot to read in the tasks file (.e4t)
1222 </p><a NAME="UserInterface.__reloadAPIs" ID="UserInterface.__reloadAPIs"></a>
1223 <h4>UserInterface.__reloadAPIs</h4>
1224 <b>__reloadAPIs</b>(<i></i>)
1225 <p>
1226 Private slot to reload the api information.
1227 </p><a NAME="UserInterface.__reportBug" ID="UserInterface.__reportBug"></a>
1228 <h4>UserInterface.__reportBug</h4>
1229 <b>__reportBug</b>(<i></i>)
1230 <p>
1231 Private slot to handle the Report Bug dialog.
1232 </p><a NAME="UserInterface.__requestFeature" ID="UserInterface.__requestFeature"></a>
1233 <h4>UserInterface.__requestFeature</h4>
1234 <b>__requestFeature</b>(<i></i>)
1235 <p>
1236 Private slot to handle the Feature Request dialog.
1237 </p><a NAME="UserInterface.__restart" ID="UserInterface.__restart"></a>
1238 <h4>UserInterface.__restart</h4>
1239 <b>__restart</b>(<i></i>)
1240 <p>
1241 Private method to restart the application.
1242 </p><a NAME="UserInterface.__saveCurrentViewProfile" ID="UserInterface.__saveCurrentViewProfile"></a>
1243 <h4>UserInterface.__saveCurrentViewProfile</h4>
1244 <b>__saveCurrentViewProfile</b>(<i>save</i>)
1245 <p>
1246 Private slot to save the window geometries of the active profile.
1247 </p><dl>
1248 <dt><i>save</i></dt>
1249 <dd>
1250 flag indicating that the current profile should
1251 be saved (boolean)
1252 </dd>
1253 </dl><a NAME="UserInterface.__setEditProfile" ID="UserInterface.__setEditProfile"></a>
1254 <h4>UserInterface.__setEditProfile</h4>
1255 <b>__setEditProfile</b>(<i>save = True</i>)
1256 <p>
1257 Private slot to activate the edit view profile.
1258 </p><dl>
1259 <dt><i>save</i></dt>
1260 <dd>
1261 flag indicating that the current profile should
1262 be saved (boolean)
1263 </dd>
1264 </dl><a NAME="UserInterface.__setStyle" ID="UserInterface.__setStyle"></a>
1265 <h4>UserInterface.__setStyle</h4>
1266 <b>__setStyle</b>(<i></i>)
1267 <p>
1268 Private slot to set the style of the interface.
1269 </p><a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a>
1270 <h4>UserInterface.__setWindowCaption</h4>
1271 <b>__setWindowCaption</b>(<i>editor = None, project = None</i>)
1272 <p>
1273 Private method to set the caption of the Main Window.
1274 </p><dl>
1275 <dt><i>editor</i></dt>
1276 <dd>
1277 filename to be displayed (string)
1278 </dd><dt><i>project</i></dt>
1279 <dd>
1280 project name to be displayed (string)
1281 </dd>
1282 </dl><a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a>
1283 <h4>UserInterface.__setupDockWindow</h4>
1284 <b>__setupDockWindow</b>(<i>dock, where, widget, caption</i>)
1285 <p>
1286 Private method to configure the dock window created with __createDockWindow().
1287 </p><dl>
1288 <dt><i>dock</i></dt>
1289 <dd>
1290 the dock window (QDockWindow)
1291 </dd><dt><i>where</i></dt>
1292 <dd>
1293 dock area to be docked to (Qt.DockWidgetArea)
1294 </dd><dt><i>widget</i></dt>
1295 <dd>
1296 widget to be shown in the dock window (QWidget)
1297 </dd><dt><i>caption</i></dt>
1298 <dd>
1299 caption of the dock window (string)
1300 </dd>
1301 </dl><a NAME="UserInterface.__showAvailableVersionInfos" ID="UserInterface.__showAvailableVersionInfos"></a>
1302 <h4>UserInterface.__showAvailableVersionInfos</h4>
1303 <b>__showAvailableVersionInfos</b>(<i>versions</i>)
1304 <p>
1305 Private method to show the versions available for download.
1306 </p><dl>
1307 <dt><i>versions</i></dt>
1308 <dd>
1309 contents of the downloaded versions file (list of strings)
1310 </dd>
1311 </dl><a NAME="UserInterface.__showEmailDialog" ID="UserInterface.__showEmailDialog"></a>
1312 <h4>UserInterface.__showEmailDialog</h4>
1313 <b>__showEmailDialog</b>(<i>mode, attachFile = None, deleteAttachFile = False</i>)
1314 <p>
1315 Private slot to show the email dialog in a given mode.
1316 </p><dl>
1317 <dt><i>mode</i></dt>
1318 <dd>
1319 mode of the email dialog (string, "bug" or "feature")
1320 </dd><dt><i>attachFile</i></dt>
1321 <dd>
1322 name of a file to attach to the email (string)
1323 </dd><dt><i>deleteAttachFile</i></dt>
1324 <dd>
1325 flag indicating to delete the attached file after
1326 it has been sent (boolean)
1327 </dd>
1328 </dl><a NAME="UserInterface.__showEricDoc" ID="UserInterface.__showEricDoc"></a>
1329 <h4>UserInterface.__showEricDoc</h4>
1330 <b>__showEricDoc</b>(<i></i>)
1331 <p>
1332 Private slot to show the Eric documentation.
1333 </p><a NAME="UserInterface.__showExternalTools" ID="UserInterface.__showExternalTools"></a>
1334 <h4>UserInterface.__showExternalTools</h4>
1335 <b>__showExternalTools</b>(<i></i>)
1336 <p>
1337 Private slot to display a dialog show a list of external tools used by eric4.
1338 </p><a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a>
1339 <h4>UserInterface.__showExtrasMenu</h4>
1340 <b>__showExtrasMenu</b>(<i></i>)
1341 <p>
1342 Private slot to display the Extras menu.
1343 </p><a NAME="UserInterface.__showFileMenu" ID="UserInterface.__showFileMenu"></a>
1344 <h4>UserInterface.__showFileMenu</h4>
1345 <b>__showFileMenu</b>(<i></i>)
1346 <p>
1347 Private slot to display the File menu.
1348 </p><a NAME="UserInterface.__showHelpMenu" ID="UserInterface.__showHelpMenu"></a>
1349 <h4>UserInterface.__showHelpMenu</h4>
1350 <b>__showHelpMenu</b>(<i></i>)
1351 <p>
1352 Private slot to display the Help menu.
1353 </p><a NAME="UserInterface.__showNext" ID="UserInterface.__showNext"></a>
1354 <h4>UserInterface.__showNext</h4>
1355 <b>__showNext</b>(<i></i>)
1356 <p>
1357 Private slot used to show the next tab or file.
1358 </p><a NAME="UserInterface.__showPixmap" ID="UserInterface.__showPixmap"></a>
1359 <h4>UserInterface.__showPixmap</h4>
1360 <b>__showPixmap</b>(<i>fn</i>)
1361 <p>
1362 Private slot to show a pixmap in a dialog.
1363 </p><dl>
1364 <dt><i>fn</i></dt>
1365 <dd>
1366 filename of the file to show (string)
1367 </dd>
1368 </dl><a NAME="UserInterface.__showPluginInfo" ID="UserInterface.__showPluginInfo"></a>
1369 <h4>UserInterface.__showPluginInfo</h4>
1370 <b>__showPluginInfo</b>(<i></i>)
1371 <p>
1372 Private slot to show the plugin info dialog.
1373 </p><a NAME="UserInterface.__showPluginsAvailable" ID="UserInterface.__showPluginsAvailable"></a>
1374 <h4>UserInterface.__showPluginsAvailable</h4>
1375 <b>__showPluginsAvailable</b>(<i></i>)
1376 <p>
1377 Private slot to show the plugins available for download.
1378 </p><a NAME="UserInterface.__showPrevious" ID="UserInterface.__showPrevious"></a>
1379 <h4>UserInterface.__showPrevious</h4>
1380 <b>__showPrevious</b>(<i></i>)
1381 <p>
1382 Private slot used to show the previous tab or file.
1383 </p><a NAME="UserInterface.__showPyQt4Doc" ID="UserInterface.__showPyQt4Doc"></a>
1384 <h4>UserInterface.__showPyQt4Doc</h4>
1385 <b>__showPyQt4Doc</b>(<i></i>)
1386 <p>
1387 Private slot to show the PyQt4 documentation.
1388 </p><a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a>
1389 <h4>UserInterface.__showPySideDoc</h4>
1390 <b>__showPySideDoc</b>(<i></i>)
1391 <p>
1392 Private slot to show the PySide documentation.
1393 </p><a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a>
1394 <h4>UserInterface.__showPythonDoc</h4>
1395 <b>__showPythonDoc</b>(<i></i>)
1396 <p>
1397 Private slot to show the Python documentation.
1398 </p><a NAME="UserInterface.__showQt4Doc" ID="UserInterface.__showQt4Doc"></a>
1399 <h4>UserInterface.__showQt4Doc</h4>
1400 <b>__showQt4Doc</b>(<i></i>)
1401 <p>
1402 Private slot to show the Qt4 documentation.
1403 </p><a NAME="UserInterface.__showSvg" ID="UserInterface.__showSvg"></a>
1404 <h4>UserInterface.__showSvg</h4>
1405 <b>__showSvg</b>(<i>fn</i>)
1406 <p>
1407 Private slot to show a SVG file in a dialog.
1408 </p><dl>
1409 <dt><i>fn</i></dt>
1410 <dd>
1411 filename of the file to show (string)
1412 </dd>
1413 </dl><a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a>
1414 <h4>UserInterface.__showSystemEmailClient</h4>
1415 <b>__showSystemEmailClient</b>(<i>mode, attachFile = None, deleteAttachFile = False</i>)
1416 <p>
1417 Private slot to show the system email dialog.
1418 </p><dl>
1419 <dt><i>mode</i></dt>
1420 <dd>
1421 mode of the email dialog (string, "bug" or "feature")
1422 </dd><dt><i>attachFile</i></dt>
1423 <dd>
1424 name of a file to put into the body of the
1425 email (string)
1426 </dd><dt><i>deleteAttachFile</i></dt>
1427 <dd>
1428 flag indicating to delete the file after
1429 it has been read (boolean)
1430 </dd>
1431 </dl><a NAME="UserInterface.__showToolGroupsMenu" ID="UserInterface.__showToolGroupsMenu"></a>
1432 <h4>UserInterface.__showToolGroupsMenu</h4>
1433 <b>__showToolGroupsMenu</b>(<i></i>)
1434 <p>
1435 Private slot to display the Tool Groups menu.
1436 </p><a NAME="UserInterface.__showToolbarsMenu" ID="UserInterface.__showToolbarsMenu"></a>
1437 <h4>UserInterface.__showToolbarsMenu</h4>
1438 <b>__showToolbarsMenu</b>(<i></i>)
1439 <p>
1440 Private slot to display the Toolbars menu.
1441 </p><a NAME="UserInterface.__showToolsMenu" ID="UserInterface.__showToolsMenu"></a>
1442 <h4>UserInterface.__showToolsMenu</h4>
1443 <b>__showToolsMenu</b>(<i></i>)
1444 <p>
1445 Private slot to display the Tools menu.
1446 </p><a NAME="UserInterface.__showVersions" ID="UserInterface.__showVersions"></a>
1447 <h4>UserInterface.__showVersions</h4>
1448 <b>__showVersions</b>(<i></i>)
1449 <p>
1450 Private slot to handle the Versions dialog.
1451 </p><a NAME="UserInterface.__showWindowMenu" ID="UserInterface.__showWindowMenu"></a>
1452 <h4>UserInterface.__showWindowMenu</h4>
1453 <b>__showWindowMenu</b>(<i></i>)
1454 <p>
1455 Private slot to display the Window menu.
1456 </p><a NAME="UserInterface.__showWizardsMenu" ID="UserInterface.__showWizardsMenu"></a>
1457 <h4>UserInterface.__showWizardsMenu</h4>
1458 <b>__showWizardsMenu</b>(<i></i>)
1459 <p>
1460 Private slot to display the Wizards menu.
1461 </p><a NAME="UserInterface.__shutdown" ID="UserInterface.__shutdown"></a>
1462 <h4>UserInterface.__shutdown</h4>
1463 <b>__shutdown</b>(<i></i>)
1464 <p>
1465 Private method to perform all necessary steps to close down the IDE.
1466 </p><dl>
1467 <dt>Returns:</dt>
1468 <dd>
1469 flag indicating success
1470 </dd>
1471 </dl><a NAME="UserInterface.__sqlBrowser" ID="UserInterface.__sqlBrowser"></a>
1472 <h4>UserInterface.__sqlBrowser</h4>
1473 <b>__sqlBrowser</b>(<i></i>)
1474 <p>
1475 Private slot to start the SQL browser tool.
1476 </p><a NAME="UserInterface.__sslErrors" ID="UserInterface.__sslErrors"></a>
1477 <h4>UserInterface.__sslErrors</h4>
1478 <b>__sslErrors</b>(<i>sslErrors</i>)
1479 <p>
1480 Private slot to handle SSL errors.
1481 </p><dl>
1482 <dt><i>sslErrors</i></dt>
1483 <dd>
1484 list of SSL errors (list of QSslError)
1485 </dd>
1486 </dl><a NAME="UserInterface.__startToolProcess" ID="UserInterface.__startToolProcess"></a>
1487 <h4>UserInterface.__startToolProcess</h4>
1488 <b>__startToolProcess</b>(<i>tool</i>)
1489 <p>
1490 Private slot to start an external tool process.
1491 </p><dl>
1492 <dt><i>tool</i></dt>
1493 <dd>
1494 list of tool entries
1495 </dd>
1496 </dl><a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a>
1497 <h4>UserInterface.__switchTab</h4>
1498 <b>__switchTab</b>(<i></i>)
1499 <p>
1500 Private slot used to switch between the current and the previous current tab.
1501 </p><a NAME="UserInterface.__toggleBottomSidebar" ID="UserInterface.__toggleBottomSidebar"></a>
1502 <h4>UserInterface.__toggleBottomSidebar</h4>
1503 <b>__toggleBottomSidebar</b>(<i></i>)
1504 <p>
1505 Private slot to handle the toggle of the bottom sidebar window.
1506 </p><a NAME="UserInterface.__toggleBrowser" ID="UserInterface.__toggleBrowser"></a>
1507 <h4>UserInterface.__toggleBrowser</h4>
1508 <b>__toggleBrowser</b>(<i></i>)
1509 <p>
1510 Private slot to handle the toggle of the File Browser window.
1511 </p><a NAME="UserInterface.__toggleDebugViewer" ID="UserInterface.__toggleDebugViewer"></a>
1512 <h4>UserInterface.__toggleDebugViewer</h4>
1513 <b>__toggleDebugViewer</b>(<i></i>)
1514 <p>
1515 Private slot to handle the toggle of the debug viewer.
1516 </p><a NAME="UserInterface.__toggleHorizontalToolbox" ID="UserInterface.__toggleHorizontalToolbox"></a>
1517 <h4>UserInterface.__toggleHorizontalToolbox</h4>
1518 <b>__toggleHorizontalToolbox</b>(<i></i>)
1519 <p>
1520 Private slot to handle the toggle of the Horizontal Toolbox window.
1521 </p><a NAME="UserInterface.__toggleLeftSidebar" ID="UserInterface.__toggleLeftSidebar"></a>
1522 <h4>UserInterface.__toggleLeftSidebar</h4>
1523 <b>__toggleLeftSidebar</b>(<i></i>)
1524 <p>
1525 Private slot to handle the toggle of the left sidebar window.
1526 </p><a NAME="UserInterface.__toggleLogViewer" ID="UserInterface.__toggleLogViewer"></a>
1527 <h4>UserInterface.__toggleLogViewer</h4>
1528 <b>__toggleLogViewer</b>(<i></i>)
1529 <p>
1530 Private slot to handle the toggle of the Log Viewer window.
1531 </p><a NAME="UserInterface.__toggleMultiProjectBrowser" ID="UserInterface.__toggleMultiProjectBrowser"></a>
1532 <h4>UserInterface.__toggleMultiProjectBrowser</h4>
1533 <b>__toggleMultiProjectBrowser</b>(<i></i>)
1534 <p>
1535 Private slot to handle the toggle of the Project Browser window.
1536 </p><a NAME="UserInterface.__toggleProjectBrowser" ID="UserInterface.__toggleProjectBrowser"></a>
1537 <h4>UserInterface.__toggleProjectBrowser</h4>
1538 <b>__toggleProjectBrowser</b>(<i></i>)
1539 <p>
1540 Private slot to handle the toggle of the Project Browser window.
1541 </p><a NAME="UserInterface.__toggleShell" ID="UserInterface.__toggleShell"></a>
1542 <h4>UserInterface.__toggleShell</h4>
1543 <b>__toggleShell</b>(<i></i>)
1544 <p>
1545 Private slot to handle the toggle of the Shell window .
1546 </p><a NAME="UserInterface.__toggleTaskViewer" ID="UserInterface.__toggleTaskViewer"></a>
1547 <h4>UserInterface.__toggleTaskViewer</h4>
1548 <b>__toggleTaskViewer</b>(<i></i>)
1549 <p>
1550 Private slot to handle the toggle of the Task Viewer window.
1551 </p><a NAME="UserInterface.__toggleTemplateViewer" ID="UserInterface.__toggleTemplateViewer"></a>
1552 <h4>UserInterface.__toggleTemplateViewer</h4>
1553 <b>__toggleTemplateViewer</b>(<i></i>)
1554 <p>
1555 Private slot to handle the toggle of the Template Viewer window.
1556 </p><a NAME="UserInterface.__toggleTerminal" ID="UserInterface.__toggleTerminal"></a>
1557 <h4>UserInterface.__toggleTerminal</h4>
1558 <b>__toggleTerminal</b>(<i></i>)
1559 <p>
1560 Private slot to handle the toggle of the Terminal window .
1561 </p><a NAME="UserInterface.__toggleVerticalToolbox" ID="UserInterface.__toggleVerticalToolbox"></a>
1562 <h4>UserInterface.__toggleVerticalToolbox</h4>
1563 <b>__toggleVerticalToolbox</b>(<i></i>)
1564 <p>
1565 Private slot to handle the toggle of the Vertical Toolbox window.
1566 </p><a NAME="UserInterface.__toggleWindow" ID="UserInterface.__toggleWindow"></a>
1567 <h4>UserInterface.__toggleWindow</h4>
1568 <b>__toggleWindow</b>(<i>w</i>)
1569 <p>
1570 Private method to toggle a workspace editor window.
1571 </p><dl>
1572 <dt><i>w</i></dt>
1573 <dd>
1574 reference to the workspace editor window
1575 </dd>
1576 </dl><dl>
1577 <dt>Returns:</dt>
1578 <dd>
1579 flag indicating, if the window was shown (boolean)
1580 </dd>
1581 </dl><a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a>
1582 <h4>UserInterface.__toolActionTriggered</h4>
1583 <b>__toolActionTriggered</b>(<i></i>)
1584 <p>
1585 Private slot called by external tools toolbar actions.
1586 </p><a NAME="UserInterface.__toolExecute" ID="UserInterface.__toolExecute"></a>
1587 <h4>UserInterface.__toolExecute</h4>
1588 <b>__toolExecute</b>(<i>act</i>)
1589 <p>
1590 Private slot to execute a particular tool.
1591 </p><dl>
1592 <dt><i>act</i></dt>
1593 <dd>
1594 reference to the action that was triggered (QAction)
1595 </dd>
1596 </dl><a NAME="UserInterface.__toolFinished" ID="UserInterface.__toolFinished"></a>
1597 <h4>UserInterface.__toolFinished</h4>
1598 <b>__toolFinished</b>(<i>exitCode, exitStatus</i>)
1599 <p>
1600 Private slot to handle the finished signal of a tool process.
1601 </p><dl>
1602 <dt><i>exitCode</i></dt>
1603 <dd>
1604 exit code of the process (integer)
1605 </dd><dt><i>exitStatus</i></dt>
1606 <dd>
1607 exit status of the process (QProcess.ExitStatus)
1608 </dd>
1609 </dl><a NAME="UserInterface.__toolGroupSelected" ID="UserInterface.__toolGroupSelected"></a>
1610 <h4>UserInterface.__toolGroupSelected</h4>
1611 <b>__toolGroupSelected</b>(<i>act</i>)
1612 <p>
1613 Private slot to set the current tool group.
1614 </p><dl>
1615 <dt><i>act</i></dt>
1616 <dd>
1617 reference to the action that was triggered (QAction)
1618 </dd>
1619 </dl><a NAME="UserInterface.__toolGroupsConfiguration" ID="UserInterface.__toolGroupsConfiguration"></a>
1620 <h4>UserInterface.__toolGroupsConfiguration</h4>
1621 <b>__toolGroupsConfiguration</b>(<i></i>)
1622 <p>
1623 Private slot to handle the tool groups configuration menu entry.
1624 </p><a NAME="UserInterface.__toolsConfiguration" ID="UserInterface.__toolsConfiguration"></a>
1625 <h4>UserInterface.__toolsConfiguration</h4>
1626 <b>__toolsConfiguration</b>(<i></i>)
1627 <p>
1628 Private slot to handle the tools configuration menu entry.
1629 </p><a NAME="UserInterface.__unittest" ID="UserInterface.__unittest"></a>
1630 <h4>UserInterface.__unittest</h4>
1631 <b>__unittest</b>(<i></i>)
1632 <p>
1633 Private slot for displaying the unittest dialog.
1634 </p><a NAME="UserInterface.__unittestProject" ID="UserInterface.__unittestProject"></a>
1635 <h4>UserInterface.__unittestProject</h4>
1636 <b>__unittestProject</b>(<i></i>)
1637 <p>
1638 Private slot for displaying the unittest dialog and run the current project.
1639 </p><a NAME="UserInterface.__unittestRestart" ID="UserInterface.__unittestRestart"></a>
1640 <h4>UserInterface.__unittestRestart</h4>
1641 <b>__unittestRestart</b>(<i></i>)
1642 <p>
1643 Private slot to display the unittest dialog and rerun the last test.
1644 </p><a NAME="UserInterface.__unittestScript" ID="UserInterface.__unittestScript"></a>
1645 <h4>UserInterface.__unittestScript</h4>
1646 <b>__unittestScript</b>(<i>prog = None</i>)
1647 <p>
1648 Private slot for displaying the unittest dialog and run the current script.
1649 </p><dl>
1650 <dt><i>prog</i></dt>
1651 <dd>
1652 the python program to be opened
1653 </dd>
1654 </dl><a NAME="UserInterface.__updateExternalToolsActions" ID="UserInterface.__updateExternalToolsActions"></a>
1655 <h4>UserInterface.__updateExternalToolsActions</h4>
1656 <b>__updateExternalToolsActions</b>(<i></i>)
1657 <p>
1658 Private method to update the external tools actions for the current tool group.
1659 </p><a NAME="UserInterface.__updateVersionsUrls" ID="UserInterface.__updateVersionsUrls"></a>
1660 <h4>UserInterface.__updateVersionsUrls</h4>
1661 <b>__updateVersionsUrls</b>(<i>versions</i>)
1662 <p>
1663 Private method to update the URLs from which to retrieve the versions file.
1664 </p><dl>
1665 <dt><i>versions</i></dt>
1666 <dd>
1667 contents of the downloaded versions file (list of strings)
1668 </dd>
1669 </dl><a NAME="UserInterface.__versionCheckResult" ID="UserInterface.__versionCheckResult"></a>
1670 <h4>UserInterface.__versionCheckResult</h4>
1671 <b>__versionCheckResult</b>(<i>versions</i>)
1672 <p>
1673 Private method to show the result of the version check action.
1674 </p><dl>
1675 <dt><i>versions</i></dt>
1676 <dd>
1677 contents of the downloaded versions file (list of strings)
1678 </dd>
1679 </dl><a NAME="UserInterface.__versionsDownloadCanceled" ID="UserInterface.__versionsDownloadCanceled"></a>
1680 <h4>UserInterface.__versionsDownloadCanceled</h4>
1681 <b>__versionsDownloadCanceled</b>(<i></i>)
1682 <p>
1683 Private method called to cancel the version check.
1684 </p><a NAME="UserInterface.__versionsDownloadDone" ID="UserInterface.__versionsDownloadDone"></a>
1685 <h4>UserInterface.__versionsDownloadDone</h4>
1686 <b>__versionsDownloadDone</b>(<i>error</i>)
1687 <p>
1688 Private method called, after the versions file has been downloaded
1689 from the internet.
1690 </p><dl>
1691 <dt><i>error</i></dt>
1692 <dd>
1693 flag indicating an error condition (boolean)
1694 </dd>
1695 </dl><a NAME="UserInterface.__webBrowser" ID="UserInterface.__webBrowser"></a>
1696 <h4>UserInterface.__webBrowser</h4>
1697 <b>__webBrowser</b>(<i></i>)
1698 <p>
1699 Private slot to start the eric4 web browser.
1700 </p><a NAME="UserInterface.__whatsThis" ID="UserInterface.__whatsThis"></a>
1701 <h4>UserInterface.__whatsThis</h4>
1702 <b>__whatsThis</b>(<i></i>)
1703 <p>
1704 Private slot called in to enter Whats This mode.
1705 </p><a NAME="UserInterface.__writeSession" ID="UserInterface.__writeSession"></a>
1706 <h4>UserInterface.__writeSession</h4>
1707 <b>__writeSession</b>(<i></i>)
1708 <p>
1709 Private slot to write the session data to an XML file (.e4s).
1710 </p><a NAME="UserInterface.__writeTasks" ID="UserInterface.__writeTasks"></a>
1711 <h4>UserInterface.__writeTasks</h4>
1712 <b>__writeTasks</b>(<i></i>)
1713 <p>
1714 Private slot to write the tasks data to an XML file (.e4t).
1715 </p><a NAME="UserInterface.addE4Actions" ID="UserInterface.addE4Actions"></a>
1716 <h4>UserInterface.addE4Actions</h4>
1717 <b>addE4Actions</b>(<i>actions, type</i>)
1718 <p>
1719 Public method to add actions to the list of actions.
1720 </p><dl>
1721 <dt><i>type</i></dt>
1722 <dd>
1723 string denoting the action set to get.
1724 It must be one of "ui" or "wizards".
1725 </dd><dt><i>actions</i></dt>
1726 <dd>
1727 list of actions to be added (list of E4Action)
1728 </dd>
1729 </dl><a NAME="UserInterface.appendToStderr" ID="UserInterface.appendToStderr"></a>
1730 <h4>UserInterface.appendToStderr</h4>
1731 <b>appendToStderr</b>(<i>s</i>)
1732 <p>
1733 Public slot to append text to the stderr log viewer tab.
1734 </p><dl>
1735 <dt><i>s</i></dt>
1736 <dd>
1737 output to be appended (string)
1738 </dd>
1739 </dl><a NAME="UserInterface.appendToStdout" ID="UserInterface.appendToStdout"></a>
1740 <h4>UserInterface.appendToStdout</h4>
1741 <b>appendToStdout</b>(<i>s</i>)
1742 <p>
1743 Public slot to append text to the stdout log viewer tab.
1744 </p><dl>
1745 <dt><i>s</i></dt>
1746 <dd>
1747 output to be appended (string)
1748 </dd>
1749 </dl><a NAME="UserInterface.checkConfigurationStatus" ID="UserInterface.checkConfigurationStatus"></a>
1750 <h4>UserInterface.checkConfigurationStatus</h4>
1751 <b>checkConfigurationStatus</b>(<i></i>)
1752 <p>
1753 Public method to check, if eric4 has been configured. If it is not,
1754 the configuration dialog is shown.
1755 </p><a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a>
1756 <h4>UserInterface.checkForErrorLog</h4>
1757 <b>checkForErrorLog</b>(<i></i>)
1758 <p>
1759 Public method to check for the presence of an error log and ask the user,
1760 what to do with it.
1761 </p><a NAME="UserInterface.closeEvent" ID="UserInterface.closeEvent"></a>
1762 <h4>UserInterface.closeEvent</h4>
1763 <b>closeEvent</b>(<i>event</i>)
1764 <p>
1765 Private event handler for the close event.
1766 </p><p>
1767 This event handler saves the preferences.
1768 </p><dl>
1769 <dt><i>event</i></dt>
1770 <dd>
1771 close event (QCloseEvent)
1772 </dd>
1773 </dl><a NAME="UserInterface.dragEnterEvent" ID="UserInterface.dragEnterEvent"></a>
1774 <h4>UserInterface.dragEnterEvent</h4>
1775 <b>dragEnterEvent</b>(<i>event</i>)
1776 <p>
1777 Protected method to handle the drag enter event.
1778 </p><dl>
1779 <dt><i>event</i></dt>
1780 <dd>
1781 the drag enter event (QDragEnterEvent)
1782 </dd>
1783 </dl><a NAME="UserInterface.dragLeaveEvent" ID="UserInterface.dragLeaveEvent"></a>
1784 <h4>UserInterface.dragLeaveEvent</h4>
1785 <b>dragLeaveEvent</b>(<i>event</i>)
1786 <p>
1787 Protected method to handle the drag leave event.
1788 </p><dl>
1789 <dt><i>event</i></dt>
1790 <dd>
1791 the drag leave event (QDragLeaveEvent)
1792 </dd>
1793 </dl><a NAME="UserInterface.dragMoveEvent" ID="UserInterface.dragMoveEvent"></a>
1794 <h4>UserInterface.dragMoveEvent</h4>
1795 <b>dragMoveEvent</b>(<i>event</i>)
1796 <p>
1797 Protected method to handle the drag move event.
1798 </p><dl>
1799 <dt><i>event</i></dt>
1800 <dd>
1801 the drag move event (QDragMoveEvent)
1802 </dd>
1803 </dl><a NAME="UserInterface.dropEvent" ID="UserInterface.dropEvent"></a>
1804 <h4>UserInterface.dropEvent</h4>
1805 <b>dropEvent</b>(<i>event</i>)
1806 <p>
1807 Protected method to handle the drop event.
1808 </p><dl>
1809 <dt><i>event</i></dt>
1810 <dd>
1811 the drop event (QDropEvent)
1812 </dd>
1813 </dl><a NAME="UserInterface.getActions" ID="UserInterface.getActions"></a>
1814 <h4>UserInterface.getActions</h4>
1815 <b>getActions</b>(<i>type</i>)
1816 <p>
1817 Public method to get a list of all actions.
1818 </p><dl>
1819 <dt><i>type</i></dt>
1820 <dd>
1821 string denoting the action set to get.
1822 It must be one of "ui" or "wizards".
1823 </dd>
1824 </dl><dl>
1825 <dt>Returns:</dt>
1826 <dd>
1827 list of all actions (list of E4Action)
1828 </dd>
1829 </dl><a NAME="UserInterface.getLocale" ID="UserInterface.getLocale"></a>
1830 <h4>UserInterface.getLocale</h4>
1831 <b>getLocale</b>(<i></i>)
1832 <p>
1833 Public method to get the locale of the IDE.
1834 </p><dl>
1835 <dt>Returns:</dt>
1836 <dd>
1837 locale of the IDE (string or None)
1838 </dd>
1839 </dl><a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a>
1840 <h4>UserInterface.getMenu</h4>
1841 <b>getMenu</b>(<i>name</i>)
1842 <p>
1843 Public method to get a reference to a specific menu.
1844 </p><dl>
1845 <dt><i>name</i></dt>
1846 <dd>
1847 name of the menu (string)
1848 </dd>
1849 </dl><dl>
1850 <dt>Returns:</dt>
1851 <dd>
1852 reference to the menu (QMenu)
1853 </dd>
1854 </dl><a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a>
1855 <h4>UserInterface.getMenuAction</h4>
1856 <b>getMenuAction</b>(<i>menuName, actionName</i>)
1857 <p>
1858 Public method to get a reference to an action of a menu.
1859 </p><dl>
1860 <dt><i>menuName</i></dt>
1861 <dd>
1862 name of the menu to search in (string)
1863 </dd><dt><i>actionName</i></dt>
1864 <dd>
1865 object name of the action to search for
1866 (string)
1867 </dd>
1868 </dl><a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a>
1869 <h4>UserInterface.getMenuBarAction</h4>
1870 <b>getMenuBarAction</b>(<i>menuName</i>)
1871 <p>
1872 Public method to get a reference to an action of the main menu.
1873 </p><dl>
1874 <dt><i>menuName</i></dt>
1875 <dd>
1876 name of the menu to search in (string)
1877 </dd>
1878 </dl><a NAME="UserInterface.getToolBarIconSize" ID="UserInterface.getToolBarIconSize"></a>
1879 <h4>UserInterface.getToolBarIconSize</h4>
1880 <b>getToolBarIconSize</b>(<i></i>)
1881 <p>
1882 Public method to get the toolbar icon size.
1883 </p><dl>
1884 <dt>Returns:</dt>
1885 <dd>
1886 toolbar icon size (QSize)
1887 </dd>
1888 </dl><a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a>
1889 <h4>UserInterface.getToolbar</h4>
1890 <b>getToolbar</b>(<i>name</i>)
1891 <p>
1892 Public method to get a reference to a specific toolbar.
1893 </p><dl>
1894 <dt><i>name</i></dt>
1895 <dd>
1896 name of the toolbar (string)
1897 </dd>
1898 </dl><dl>
1899 <dt>Returns:</dt>
1900 <dd>
1901 reference to the toolbar entry (tuple of string and QToolBar)
1902 </dd>
1903 </dl><a NAME="UserInterface.getViewProfile" ID="UserInterface.getViewProfile"></a>
1904 <h4>UserInterface.getViewProfile</h4>
1905 <b>getViewProfile</b>(<i></i>)
1906 <p>
1907 Public method to get the current view profile.
1908 </p><dl>
1909 <dt>Returns:</dt>
1910 <dd>
1911 the name of the current view profile (string)
1912 </dd>
1913 </dl><a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a>
1914 <h4>UserInterface.launchHelpViewer</h4>
1915 <b>launchHelpViewer</b>(<i>home, searchWord = None</i>)
1916 <p>
1917 Public slot to start the help viewer.
1918 </p><dl>
1919 <dt><i>home</i></dt>
1920 <dd>
1921 filename of file to be shown (string)
1922 </dd><dt><i>searchWord=</i></dt>
1923 <dd>
1924 word to search for (string)
1925 </dd>
1926 </dl><a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a>
1927 <h4>UserInterface.performVersionCheck</h4>
1928 <b>performVersionCheck</b>(<i>manual = True, alternative = 0, showVersions = False</i>)
1929 <p>
1930 Public method to check the internet for an eric4 update.
1931 </p><dl>
1932 <dt><i>manual</i></dt>
1933 <dd>
1934 flag indicating an invocation via the menu (boolean)
1935 </dd><dt><i>alternative</i></dt>
1936 <dd>
1937 index of server to download from (integer)
1938 </dd><dt><i>showVersion=</i></dt>
1939 <dd>
1940 flag indicating the show versions mode (boolean)
1941 </dd>
1942 </dl><a NAME="UserInterface.processArgs" ID="UserInterface.processArgs"></a>
1943 <h4>UserInterface.processArgs</h4>
1944 <b>processArgs</b>(<i>args</i>)
1945 <p>
1946 Public method to process the command line args passed to the UI.
1947 </p><dl>
1948 <dt><i>args</i></dt>
1949 <dd>
1950 list of files to open<br />
1951 The args are processed one at a time. All arguments after a
1952 '--' option are considered debug arguments to the program
1953 for the debugger. All files named before the '--' option
1954 are opened in a text editor, unless the argument ends in
1955 .e3p, .e3pz, .e4p or .e4pz, then it is opened as a project file.
1956 If it ends in .e4m or .e4mz, it is opened as a multiproject.
1957 </dd>
1958 </dl><a NAME="UserInterface.registerToolbar" ID="UserInterface.registerToolbar"></a>
1959 <h4>UserInterface.registerToolbar</h4>
1960 <b>registerToolbar</b>(<i>name, text, toolbar</i>)
1961 <p>
1962 Public method to register a toolbar.
1963 </p><p>
1964 This method must be called in order to make a toolbar manageable by the
1965 UserInterface object.
1966 </p><dl>
1967 <dt><i>name</i></dt>
1968 <dd>
1969 name of the toolbar (string). This is used as the key into
1970 the dictionary of toolbar references.
1971 </dd><dt><i>text</i></dt>
1972 <dd>
1973 user visible text for the toolbar entry (string)
1974 </dd><dt><i>toolbar</i></dt>
1975 <dd>
1976 reference to the toolbar to be registered (QToolBar)
1977 </dd>
1978 </dl><dl>
1979 <dt>Raises <b>KeyError</b>:</dt>
1980 <dd>
1981 raised, if a toolbar with the given name was
1982 already registered
1983 </dd>
1984 </dl><a NAME="UserInterface.removeE4Actions" ID="UserInterface.removeE4Actions"></a>
1985 <h4>UserInterface.removeE4Actions</h4>
1986 <b>removeE4Actions</b>(<i>actions, type = 'ui'</i>)
1987 <p>
1988 Public method to remove actions from the list of actions.
1989 </p><dl>
1990 <dt><i>type</i></dt>
1991 <dd>
1992 string denoting the action set to get.
1993 It must be one of "ui" or "wizards".
1994 </dd><dt><i>actions</i></dt>
1995 <dd>
1996 list of actions (list of E4Action)
1997 </dd>
1998 </dl><a NAME="UserInterface.reregisterToolbar" ID="UserInterface.reregisterToolbar"></a>
1999 <h4>UserInterface.reregisterToolbar</h4>
2000 <b>reregisterToolbar</b>(<i>name, text</i>)
2001 <p>
2002 Public method to change the visible text for the named toolbar.
2003 </p><dl>
2004 <dt><i>name</i></dt>
2005 <dd>
2006 name of the toolbar to be changed (string)
2007 </dd><dt><i>text</i></dt>
2008 <dd>
2009 new user visible text for the toolbar entry (string)
2010 </dd>
2011 </dl><a NAME="UserInterface.setDebugProfile" ID="UserInterface.setDebugProfile"></a>
2012 <h4>UserInterface.setDebugProfile</h4>
2013 <b>setDebugProfile</b>(<i>save = True</i>)
2014 <p>
2015 Public slot to activate the debug view profile.
2016 </p><dl>
2017 <dt><i>save</i></dt>
2018 <dd>
2019 flag indicating that the current profile should
2020 be saved (boolean)
2021 </dd>
2022 </dl><a NAME="UserInterface.showAvailableVersionsInfo" ID="UserInterface.showAvailableVersionsInfo"></a>
2023 <h4>UserInterface.showAvailableVersionsInfo</h4>
2024 <b>showAvailableVersionsInfo</b>(<i></i>)
2025 <p>
2026 Public method to show the eric4 versions available for download.
2027 </p><a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a>
2028 <h4>UserInterface.showEvent</h4>
2029 <b>showEvent</b>(<i>evt</i>)
2030 <p>
2031 Protected method to handle the show event.
2032 </p><dl>
2033 <dt><i>evt</i></dt>
2034 <dd>
2035 reference to the show event (QShowEvent)
2036 </dd>
2037 </dl><a NAME="UserInterface.showLogTab" ID="UserInterface.showLogTab"></a>
2038 <h4>UserInterface.showLogTab</h4>
2039 <b>showLogTab</b>(<i>tabname</i>)
2040 <p>
2041 Public method to show a particular Log-Viewer tab.
2042 </p><dl>
2043 <dt><i>tabname</i></dt>
2044 <dd>
2045 string naming the tab to be shown (string)
2046 </dd>
2047 </dl><a NAME="UserInterface.showPreferences" ID="UserInterface.showPreferences"></a>
2048 <h4>UserInterface.showPreferences</h4>
2049 <b>showPreferences</b>(<i>pageName = None</i>)
2050 <p>
2051 Public slot to set the preferences.
2052 </p><dl>
2053 <dt><i>pageName</i></dt>
2054 <dd>
2055 name of the configuration page to show (string)
2056 </dd>
2057 </dl><a NAME="UserInterface.unregisterToolbar" ID="UserInterface.unregisterToolbar"></a>
2058 <h4>UserInterface.unregisterToolbar</h4>
2059 <b>unregisterToolbar</b>(<i>name</i>)
2060 <p>
2061 Public method to unregister a toolbar.
2062 </p><dl>
2063 <dt><i>name</i></dt>
2064 <dd>
2065 name of the toolbar (string).
2066 </dd>
2067 </dl><a NAME="UserInterface.versionIsNewer" ID="UserInterface.versionIsNewer"></a>
2068 <h4>UserInterface.versionIsNewer</h4>
2069 <b>versionIsNewer</b>(<i>required, snapshot = None</i>)
2070 <p>
2071 Public method to check, if the eric4 version is good compared to
2072 the required version.
2073 </p><dl>
2074 <dt><i>required</i></dt>
2075 <dd>
2076 required version (string)
2077 </dd><dt><i>snapshot</i></dt>
2078 <dd>
2079 required snapshot version (string)
2080 </dd>
2081 </dl><dl>
2082 <dt>Returns:</dt>
2083 <dd>
2084 flag indicating, that the version is newer than the required one
2085 (boolean)
2086 </dd>
2087 </dl>
2088 <div align="right"><a href="#top">Up</a></div>
2089 <hr />
2090 </body></html>

Mercurial Repository: eric

eric ide

mercurial