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