Documentation/Source/eric6.UI.UserInterface.html

branch
maintenance
changeset 6319
df201b9fbad4
parent 6296
db9b3a419845
child 6428
10aa2bf9c1d7
equal deleted inserted replaced
6274:44249d49d892 6319:df201b9fbad4
323 </tr><tr> 323 </tr><tr>
324 <td><a href="#UserInterface.__helpClosed">__helpClosed</a></td> 324 <td><a href="#UserInterface.__helpClosed">__helpClosed</a></td>
325 <td>Private slot to handle the helpClosed signal of the help window.</td> 325 <td>Private slot to handle the helpClosed signal of the help window.</td>
326 </tr><tr> 326 </tr><tr>
327 <td><a href="#UserInterface.__helpViewer">__helpViewer</a></td> 327 <td><a href="#UserInterface.__helpViewer">__helpViewer</a></td>
328 <td>Private slot to start an empty help viewer.</td> 328 <td>Private slot to start an empty help viewer/web browser.</td>
329 </tr><tr> 329 </tr><tr>
330 <td><a href="#UserInterface.__importPreferences">__importPreferences</a></td> 330 <td><a href="#UserInterface.__importPreferences">__importPreferences</a></td>
331 <td>Private slot to import preferences.</td> 331 <td>Private slot to import preferences.</td>
332 </tr><tr> 332 </tr><tr>
333 <td><a href="#UserInterface.__importShortcuts">__importShortcuts</a></td> 333 <td><a href="#UserInterface.__importShortcuts">__importShortcuts</a></td>
346 <td>Private slot to create actions for the configured external tools.</td> 346 <td>Private slot to create actions for the configured external tools.</td>
347 </tr><tr> 347 </tr><tr>
348 <td><a href="#UserInterface.__initMenus">__initMenus</a></td> 348 <td><a href="#UserInterface.__initMenus">__initMenus</a></td>
349 <td>Private slot to create the menus.</td> 349 <td>Private slot to create the menus.</td>
350 </tr><tr> 350 </tr><tr>
351 <td><a href="#UserInterface.__initPySideDocAction">__initPySideDocAction</a></td> 351 <td><a href="#UserInterface.__initPySideDocActions">__initPySideDocActions</a></td>
352 <td>Private slot to initialize the action to show the PySide documentation.</td> 352 <td>Private slot to initialize the actions to show the PySide documentation.</td>
353 </tr><tr> 353 </tr><tr>
354 <td><a href="#UserInterface.__initPythonDocActions">__initPythonDocActions</a></td> 354 <td><a href="#UserInterface.__initPythonDocActions">__initPythonDocActions</a></td>
355 <td>Private slot to initialize the actions to show the Python documentation.</td> 355 <td>Private slot to initialize the actions to show the Python documentation.</td>
356 </tr><tr> 356 </tr><tr>
357 <td><a href="#UserInterface.__initQtDocActions">__initQtDocActions</a></td> 357 <td><a href="#UserInterface.__initQtDocActions">__initQtDocActions</a></td>
512 </tr><tr> 512 </tr><tr>
513 <td><a href="#UserInterface.__showPyQt5Doc">__showPyQt5Doc</a></td> 513 <td><a href="#UserInterface.__showPyQt5Doc">__showPyQt5Doc</a></td>
514 <td>Private slot to show the PyQt5 documentation.</td> 514 <td>Private slot to show the PyQt5 documentation.</td>
515 </tr><tr> 515 </tr><tr>
516 <td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td> 516 <td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td>
517 <td>Private slot to show the PySide documentation.</td> 517 <td>Private slot to show the PySide/PySide2 documentation.</td>
518 </tr><tr> 518 </tr><tr>
519 <td><a href="#UserInterface.__showPython2Doc">__showPython2Doc</a></td> 519 <td><a href="#UserInterface.__showPython2Doc">__showPython2Doc</a></td>
520 <td>Private slot to show the Python 2 documentation.</td> 520 <td>Private slot to show the Python 2 documentation.</td>
521 </tr><tr> 521 </tr><tr>
522 <td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td> 522 <td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td>
754 <td>Public method to get a reference to a specific toolbar.</td> 754 <td>Public method to get a reference to a specific toolbar.</td>
755 </tr><tr> 755 </tr><tr>
756 <td><a href="#UserInterface.getViewProfile">getViewProfile</a></td> 756 <td><a href="#UserInterface.getViewProfile">getViewProfile</a></td>
757 <td>Public method to get the current view profile.</td> 757 <td>Public method to get the current view profile.</td>
758 </tr><tr> 758 </tr><tr>
759 <td><a href="#UserInterface.handleUrl">handleUrl</a></td>
760 <td>Public slot to handle opening a URL.</td>
761 </tr><tr>
759 <td><a href="#UserInterface.isOnline">isOnline</a></td> 762 <td><a href="#UserInterface.isOnline">isOnline</a></td>
760 <td>Public method to get the online state.</td> 763 <td>Public method to get the online state.</td>
761 </tr><tr> 764 </tr><tr>
762 <td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td> 765 <td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td>
763 <td>Public slot to start the help viewer.</td> 766 <td>Public slot to start the help viewer/web browser.</td>
764 </tr><tr> 767 </tr><tr>
765 <td><a href="#UserInterface.notificationsEnabled">notificationsEnabled</a></td> 768 <td><a href="#UserInterface.notificationsEnabled">notificationsEnabled</a></td>
766 <td>Public method to check, if notifications are enabled.</td> 769 <td>Public method to check, if notifications are enabled.</td>
767 </tr><tr> 770 </tr><tr>
768 <td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td> 771 <td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td>
1221 Private slot to handle the helpClosed signal of the help window. 1224 Private slot to handle the helpClosed signal of the help window.
1222 </p><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a> 1225 </p><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
1223 <h4>UserInterface.__helpViewer</h4> 1226 <h4>UserInterface.__helpViewer</h4>
1224 <b>__helpViewer</b>(<i></i>) 1227 <b>__helpViewer</b>(<i></i>)
1225 <p> 1228 <p>
1226 Private slot to start an empty help viewer. 1229 Private slot to start an empty help viewer/web browser.
1227 </p><a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a> 1230 </p><a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a>
1228 <h4>UserInterface.__importPreferences</h4> 1231 <h4>UserInterface.__importPreferences</h4>
1229 <b>__importPreferences</b>(<i></i>) 1232 <b>__importPreferences</b>(<i></i>)
1230 <p> 1233 <p>
1231 Private slot to import preferences. 1234 Private slot to import preferences.
1257 </p><a NAME="UserInterface.__initMenus" ID="UserInterface.__initMenus"></a> 1260 </p><a NAME="UserInterface.__initMenus" ID="UserInterface.__initMenus"></a>
1258 <h4>UserInterface.__initMenus</h4> 1261 <h4>UserInterface.__initMenus</h4>
1259 <b>__initMenus</b>(<i></i>) 1262 <b>__initMenus</b>(<i></i>)
1260 <p> 1263 <p>
1261 Private slot to create the menus. 1264 Private slot to create the menus.
1262 </p><a NAME="UserInterface.__initPySideDocAction" ID="UserInterface.__initPySideDocAction"></a> 1265 </p><a NAME="UserInterface.__initPySideDocActions" ID="UserInterface.__initPySideDocActions"></a>
1263 <h4>UserInterface.__initPySideDocAction</h4> 1266 <h4>UserInterface.__initPySideDocActions</h4>
1264 <b>__initPySideDocAction</b>(<i></i>) 1267 <b>__initPySideDocActions</b>(<i></i>)
1265 <p> 1268 <p>
1266 Private slot to initialize the action to show the PySide documentation. 1269 Private slot to initialize the actions to show the PySide
1270 documentation.
1267 </p><a NAME="UserInterface.__initPythonDocActions" ID="UserInterface.__initPythonDocActions"></a> 1271 </p><a NAME="UserInterface.__initPythonDocActions" ID="UserInterface.__initPythonDocActions"></a>
1268 <h4>UserInterface.__initPythonDocActions</h4> 1272 <h4>UserInterface.__initPythonDocActions</h4>
1269 <b>__initPythonDocActions</b>(<i></i>) 1273 <b>__initPythonDocActions</b>(<i></i>)
1270 <p> 1274 <p>
1271 Private slot to initialize the actions to show the Python 1275 Private slot to initialize the actions to show the Python
1667 <b>__showPyQt5Doc</b>(<i></i>) 1671 <b>__showPyQt5Doc</b>(<i></i>)
1668 <p> 1672 <p>
1669 Private slot to show the PyQt5 documentation. 1673 Private slot to show the PyQt5 documentation.
1670 </p><a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a> 1674 </p><a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a>
1671 <h4>UserInterface.__showPySideDoc</h4> 1675 <h4>UserInterface.__showPySideDoc</h4>
1672 <b>__showPySideDoc</b>(<i></i>) 1676 <b>__showPySideDoc</b>(<i>variant</i>)
1673 <p> 1677 <p>
1674 Private slot to show the PySide documentation. 1678 Private slot to show the PySide/PySide2 documentation.
1675 </p><a NAME="UserInterface.__showPython2Doc" ID="UserInterface.__showPython2Doc"></a> 1679 </p><dl>
1680 <dt><i>variant</i> (str)</dt>
1681 <dd>
1682 PySide variant (1 or 2)
1683 </dd>
1684 </dl><a NAME="UserInterface.__showPython2Doc" ID="UserInterface.__showPython2Doc"></a>
1676 <h4>UserInterface.__showPython2Doc</h4> 1685 <h4>UserInterface.__showPython2Doc</h4>
1677 <b>__showPython2Doc</b>(<i></i>) 1686 <b>__showPython2Doc</b>(<i></i>)
1678 <p> 1687 <p>
1679 Private slot to show the Python 2 documentation. 1688 Private slot to show the Python 2 documentation.
1680 </p><a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a> 1689 </p><a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a>
2377 </p><dl> 2386 </p><dl>
2378 <dt>Returns:</dt> 2387 <dt>Returns:</dt>
2379 <dd> 2388 <dd>
2380 the name of the current view profile (string) 2389 the name of the current view profile (string)
2381 </dd> 2390 </dd>
2391 </dl><a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a>
2392 <h4>UserInterface.handleUrl</h4>
2393 <b>handleUrl</b>(<i>url</i>)
2394 <p>
2395 Public slot to handle opening a URL.
2396 </p><dl>
2397 <dt><i>url</i> (QUrl)</dt>
2398 <dd>
2399 URL to be shown
2400 </dd>
2382 </dl><a NAME="UserInterface.isOnline" ID="UserInterface.isOnline"></a> 2401 </dl><a NAME="UserInterface.isOnline" ID="UserInterface.isOnline"></a>
2383 <h4>UserInterface.isOnline</h4> 2402 <h4>UserInterface.isOnline</h4>
2384 <b>isOnline</b>(<i></i>) 2403 <b>isOnline</b>(<i></i>)
2385 <p> 2404 <p>
2386 Public method to get the online state. 2405 Public method to get the online state.
2396 </dd> 2415 </dd>
2397 </dl><a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a> 2416 </dl><a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a>
2398 <h4>UserInterface.launchHelpViewer</h4> 2417 <h4>UserInterface.launchHelpViewer</h4>
2399 <b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>) 2418 <b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>)
2400 <p> 2419 <p>
2401 Public slot to start the help viewer. 2420 Public slot to start the help viewer/web browser.
2402 </p><dl> 2421 </p><dl>
2403 <dt><i>home</i></dt> 2422 <dt><i>home</i> (str or QUrl)</dt>
2404 <dd> 2423 <dd>
2405 filename of file to be shown (string) 2424 filename of file to be shown or URL to be opened
2406 </dd><dt><i>searchWord=</i></dt> 2425 </dd><dt><i>searchWord=</i> (str)</dt>
2407 <dd> 2426 <dd>
2408 word to search for (string) 2427 word to search for
2409 </dd><dt><i>useSingle=</i></dt> 2428 </dd><dt><i>useSingle=</i> (bool)</dt>
2410 <dd> 2429 <dd>
2411 flag indicating to use a single browser window 2430 flag indicating to use a single browser window
2412 (boolean)
2413 </dd> 2431 </dd>
2414 </dl><a NAME="UserInterface.notificationsEnabled" ID="UserInterface.notificationsEnabled"></a> 2432 </dl><a NAME="UserInterface.notificationsEnabled" ID="UserInterface.notificationsEnabled"></a>
2415 <h4>UserInterface.notificationsEnabled</h4> 2433 <h4>UserInterface.notificationsEnabled</h4>
2416 <b>notificationsEnabled</b>(<i></i>) 2434 <b>notificationsEnabled</b>(<i></i>)
2417 <p> 2435 <p>

eric ide

mercurial