--- a/eric6/Documentation/Source/eric6.UI.UserInterface.html Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.UI.UserInterface.html Mon Feb 01 10:38:16 2021 +0100
@@ -137,7 +137,7 @@
Private method returning number of characters to write.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
number of characters buffered or length of buffered line
(integer)
@@ -203,11 +203,6 @@
emitted after the master
password has been changed with the old and the new password
</dd>
-<dt>onlineStateChanged(online)</dt>
-<dd>
-emitted to indicate a change of the
- network state
-</dd>
<dt>preferencesChanged()</dt>
<dd>
emitted after the preferences were changed
@@ -448,7 +443,7 @@
</tr>
<tr>
<td><a href="#UserInterface.__initEricDocAction">__initEricDocAction</a></td>
-<td>Private slot to initialize the action to show the eric6 documentation.</td>
+<td>Private slot to initialize the action to show the eric documentation.</td>
</tr>
<tr>
<td><a href="#UserInterface.__initExternalToolsActions">__initExternalToolsActions</a></td>
@@ -516,11 +511,7 @@
</tr>
<tr>
<td><a href="#UserInterface.__newWindow">__newWindow</a></td>
-<td>Private slot to start a new instance of eric6.</td>
-</tr>
-<tr>
-<td><a href="#UserInterface.__onlineStateChanged">__onlineStateChanged</a></td>
-<td>Private slot handling changes in online state.</td>
+<td>Private slot to start a new instance of eric.</td>
</tr>
<tr>
<td><a href="#UserInterface.__openHexEditor">__openHexEditor</a></td>
@@ -636,7 +627,7 @@
</tr>
<tr>
<td><a href="#UserInterface.__showExternalTools">__showExternalTools</a></td>
-<td>Private slot to display a dialog show a list of external tools used by eric6.</td>
+<td>Private slot to display a dialog show a list of external tools used by eric.</td>
</tr>
<tr>
<td><a href="#UserInterface.__showExtrasMenu">__showExtrasMenu</a></td>
@@ -675,22 +666,18 @@
<td>Private slot used to show the previous tab or file.</td>
</tr>
<tr>
-<td><a href="#UserInterface.__showPyQt5Doc">__showPyQt5Doc</a></td>
-<td>Private slot to show the PyQt5 documentation.</td>
+<td><a href="#UserInterface.__showPyQtDoc">__showPyQtDoc</a></td>
+<td>Private slot to show the PyQt5/6 documentation.</td>
</tr>
<tr>
<td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td>
-<td>Private slot to show the PySide2 documentation.</td>
+<td>Private slot to show the PySide2/PySide6 documentation.</td>
</tr>
<tr>
<td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td>
<td>Private slot to show the Python 3 documentation.</td>
</tr>
<tr>
-<td><a href="#UserInterface.__showQt5Doc">__showQt5Doc</a></td>
-<td>Private slot to show the Qt5 documentation.</td>
-</tr>
-<tr>
<td><a href="#UserInterface.__showQtDoc">__showQtDoc</a></td>
<td>Private method to show the Qt documentation.</td>
</tr>
@@ -756,7 +743,7 @@
</tr>
<tr>
<td><a href="#UserInterface.__startWebBrowser">__startWebBrowser</a></td>
-<td>Private slot to start the eric6 web browser.</td>
+<td>Private slot to start the eric web browser.</td>
</tr>
<tr>
<td><a href="#UserInterface.__switchTab">__switchTab</a></td>
@@ -864,7 +851,7 @@
</tr>
<tr>
<td><a href="#UserInterface.__webBrowser">__webBrowser</a></td>
-<td>Private slot to start the eric6 web browser.</td>
+<td>Private slot to start the eric web browser.</td>
</tr>
<tr>
<td><a href="#UserInterface.__webBrowserFinished">__webBrowserFinished</a></td>
@@ -924,7 +911,7 @@
</tr>
<tr>
<td><a href="#UserInterface.checkConfigurationStatus">checkConfigurationStatus</a></td>
-<td>Public method to check, if eric6 has been configured.</td>
+<td>Public method to check, if eric has been configured.</td>
</tr>
<tr>
<td><a href="#UserInterface.checkForErrorLog">checkForErrorLog</a></td>
@@ -1015,10 +1002,6 @@
<td>Public slot to handle opening a URL.</td>
</tr>
<tr>
-<td><a href="#UserInterface.isOnline">isOnline</a></td>
-<td>Public method to get the online state.</td>
-</tr>
-<tr>
<td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td>
<td>Public slot to start the help viewer/web browser.</td>
</tr>
@@ -1027,12 +1010,8 @@
<td>Public method to get a reference to the network access manager object.</td>
</tr>
<tr>
-<td><a href="#UserInterface.notificationsEnabled">notificationsEnabled</a></td>
-<td>Public method to check, if notifications are enabled.</td>
-</tr>
-<tr>
<td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td>
-<td>Public method to check the internet for an eric6 update.</td>
+<td>Public method to check the internet for an eric update.</td>
</tr>
<tr>
<td><a href="#UserInterface.processArgs">processArgs</a></td>
@@ -1064,7 +1043,7 @@
</tr>
<tr>
<td><a href="#UserInterface.showAvailableVersionsInfo">showAvailableVersionsInfo</a></td>
-<td>Public method to show the eric6 versions available for download.</td>
+<td>Public method to show the eric versions available for download.</td>
</tr>
<tr>
<td><a href="#UserInterface.showEmailDialog">showEmailDialog</a></td>
@@ -1112,7 +1091,7 @@
</tr>
<tr>
<td><a href="#UserInterface.versionIsNewer">versionIsNewer</a></td>
-<td>Public method to check, if the eric6 version is good compared to the required version.</td>
+<td>Public method to check, if the eric version is good compared to the required version.</td>
</tr>
</table>
<h3>Static Methods</h3>
@@ -1457,7 +1436,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
error indication (1 = connection not possible, 0 = ok,
-1 = server exited with an error code)
@@ -1484,7 +1463,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the generated dock window (QDockWindow)
</dd>
@@ -1658,7 +1637,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list giving the widget's geometry and its visibility
</dd>
@@ -1671,7 +1650,7 @@
Private method to check, if an error log file exists.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the existence of an error log file (boolean)
</dd>
@@ -1716,7 +1695,7 @@
<b>__initEricDocAction</b>(<i></i>)
<p>
- Private slot to initialize the action to show the eric6 documentation.
+ Private slot to initialize the action to show the eric documentation.
</p>
<a NAME="UserInterface.__initExternalToolsActions" ID="UserInterface.__initExternalToolsActions"></a>
<h4>UserInterface.__initExternalToolsActions</h4>
@@ -1826,13 +1805,13 @@
<dd>
filename of file to be shown or URL to be opened
</dd>
-<dt><i>searchWord=</i> (str)</dt>
+<dt><i>searchWord</i> (str)</dt>
<dd>
word to search for
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a successful launch
</dd>
@@ -1894,22 +1873,8 @@
<b>__newWindow</b>(<i></i>)
<p>
- Private slot to start a new instance of eric6.
+ Private slot to start a new instance of eric.
</p>
-<a NAME="UserInterface.__onlineStateChanged" ID="UserInterface.__onlineStateChanged"></a>
-<h4>UserInterface.__onlineStateChanged</h4>
-<b>__onlineStateChanged</b>(<i>online</i>)
-
-<p>
- Private slot handling changes in online state.
-</p>
-<dl>
-
-<dt><i>online</i> (bool)</dt>
-<dd>
-flag indicating the online state
-</dd>
-</dl>
<a NAME="UserInterface.__openHexEditor" ID="UserInterface.__openHexEditor"></a>
<h4>UserInterface.__openHexEditor</h4>
<b>__openHexEditor</b>(<i>fn=""</i>)
@@ -2034,7 +1999,7 @@
Private method to check for and read a crash session.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a crash session file was found and read
</dd>
@@ -2060,7 +2025,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -2237,7 +2202,7 @@
<p>
Private slot to display a dialog show a list of external tools used
- by eric6.
+ by eric.
</p>
<a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a>
<h4>UserInterface.__showExtrasMenu</h4>
@@ -2310,25 +2275,32 @@
<p>
Private slot used to show the previous tab or file.
</p>
-<a NAME="UserInterface.__showPyQt5Doc" ID="UserInterface.__showPyQt5Doc"></a>
-<h4>UserInterface.__showPyQt5Doc</h4>
-<b>__showPyQt5Doc</b>(<i></i>)
+<a NAME="UserInterface.__showPyQtDoc" ID="UserInterface.__showPyQtDoc"></a>
+<h4>UserInterface.__showPyQtDoc</h4>
+<b>__showPyQtDoc</b>(<i>variant=5</i>)
<p>
- Private slot to show the PyQt5 documentation.
+ Private slot to show the PyQt5/6 documentation.
</p>
+<dl>
+
+<dt><i>variant</i> (int or str)</dt>
+<dd>
+PyQt variant to show documentation for (5 or 6)
+</dd>
+</dl>
<a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a>
<h4>UserInterface.__showPySideDoc</h4>
-<b>__showPySideDoc</b>(<i>variant="2"</i>)
+<b>__showPySideDoc</b>(<i>variant=2</i>)
<p>
- Private slot to show the PySide2 documentation.
+ Private slot to show the PySide2/PySide6 documentation.
</p>
<dl>
-<dt><i>variant</i> (str)</dt>
+<dt><i>variant</i> (int or str)</dt>
<dd>
-PySide variant (2)
+PySide variant (2 or 6)
</dd>
</dl>
<a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a>
@@ -2338,13 +2310,6 @@
<p>
Private slot to show the Python 3 documentation.
</p>
-<a NAME="UserInterface.__showQt5Doc" ID="UserInterface.__showQt5Doc"></a>
-<h4>UserInterface.__showQt5Doc</h4>
-<b>__showQt5Doc</b>(<i></i>)
-
-<p>
- Private slot to show the Qt5 documentation.
-</p>
<a NAME="UserInterface.__showQtDoc" ID="UserInterface.__showQtDoc"></a>
<h4>UserInterface.__showQtDoc</h4>
<b>__showQtDoc</b>(<i>version</i>)
@@ -2354,9 +2319,9 @@
</p>
<dl>
-<dt><i>version</i></dt>
+<dt><i>version</i> (int)</dt>
<dd>
-Qt version to show documentation for (integer)
+Qt version to show documentation for
</dd>
</dl>
<a NAME="UserInterface.__showSettingsMenu" ID="UserInterface.__showSettingsMenu"></a>
@@ -2461,7 +2426,7 @@
Private method to perform all necessary steps to close down the IDE.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -2517,7 +2482,7 @@
<b>__startWebBrowser</b>(<i></i>)
<p>
- Private slot to start the eric6 web browser.
+ Private slot to start the eric web browser.
</p>
<a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a>
<h4>UserInterface.__switchTab</h4>
@@ -2584,7 +2549,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, if the window was shown (boolean)
</dd>
@@ -2770,7 +2735,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
version tuple
</dd>
@@ -2808,7 +2773,7 @@
<b>__webBrowser</b>(<i>home=""</i>)
<p>
- Private slot to start the eric6 web browser.
+ Private slot to start the eric web browser.
</p>
<dl>
@@ -2864,7 +2829,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -2996,7 +2961,7 @@
<b>checkConfigurationStatus</b>(<i></i>)
<p>
- Public method to check, if eric6 has been configured. If it is not,
+ Public method to check, if eric has been configured. If it is not,
the configuration dialog is shown.
</p>
<a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a>
@@ -3047,7 +3012,7 @@
Public method to create the toolbars menu for Qt.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
toolbars menu (QMenu)
</dd>
@@ -3060,7 +3025,7 @@
Public method to provide a reference to the code documentation viewer.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the code documentation viewer
</dd>
@@ -3143,7 +3108,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of all actions (list of E5Action)
</dd>
@@ -3156,7 +3121,7 @@
Public method to get the current layout type.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
current layout type
</dd>
@@ -3175,7 +3140,7 @@
Public method to get the locale of the IDE.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
locale of the IDE (string or None)
</dd>
@@ -3195,7 +3160,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the menu (QMenu)
</dd>
@@ -3220,7 +3185,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the menu action (QAction)
</dd>
@@ -3240,7 +3205,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the menu bar action (QAction)
</dd>
@@ -3251,10 +3216,10 @@
<p>
Public method to get the original PATH environment variable
- (i.e. before modifications by eric6 and PyQt5).
+ (i.e. before modifications by eric and PyQt5).
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
original PATH environment variable
</dd>
@@ -3273,7 +3238,7 @@
Public method to get the toolbar icon size.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
toolbar icon size (QSize)
</dd>
@@ -3293,7 +3258,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the toolbar entry (tuple of string and QToolBar)
</dd>
@@ -3314,7 +3279,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of toolbars
</dd>
@@ -3333,7 +3298,7 @@
Public method to get the current view profile.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the name of the current view profile (string)
</dd>
@@ -3352,25 +3317,6 @@
URL to be shown
</dd>
</dl>
-<a NAME="UserInterface.isOnline" ID="UserInterface.isOnline"></a>
-<h4>UserInterface.isOnline</h4>
-<b>isOnline</b>(<i></i>)
-
-<p>
- Public method to get the online state.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-online state
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl>
<a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a>
<h4>UserInterface.launchHelpViewer</h4>
<b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>)
@@ -3384,11 +3330,11 @@
<dd>
filename of file to be shown or URL to be opened
</dd>
-<dt><i>searchWord=</i> (str)</dt>
+<dt><i>searchWord</i> (str)</dt>
<dd>
word to search for
</dd>
-<dt><i>useSingle=</i> (bool)</dt>
+<dt><i>useSingle</i> (bool)</dt>
<dd>
flag indicating to use a single browser window
</dd>
@@ -3401,7 +3347,7 @@
Public method to get a reference to the network access manager object.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the network access manager object
</dd>
@@ -3412,25 +3358,12 @@
QNetworkAccessManager
</dd>
</dl>
-<a NAME="UserInterface.notificationsEnabled" ID="UserInterface.notificationsEnabled"></a>
-<h4>UserInterface.notificationsEnabled</h4>
-<b>notificationsEnabled</b>(<i></i>)
-
-<p>
- Public method to check, if notifications are enabled.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating, if notifications are enabled (boolean)
-</dd>
-</dl>
<a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a>
<h4>UserInterface.performVersionCheck</h4>
<b>performVersionCheck</b>(<i>manual=True, alternative=0, showVersions=False</i>)
<p>
- Public method to check the internet for an eric6 update.
+ Public method to check the internet for an eric update.
</p>
<dl>
@@ -3442,7 +3375,7 @@
<dd>
index of server to download from (integer)
</dd>
-<dt><i>showVersions=</i></dt>
+<dt><i>showVersions</i></dt>
<dd>
flag indicating the show versions mode (boolean)
</dd>
@@ -3588,7 +3521,7 @@
<b>showAvailableVersionsInfo</b>(<i></i>)
<p>
- Public method to show the eric6 versions available for download.
+ Public method to show the eric versions available for download.
</p>
<a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a>
<h4>UserInterface.showEmailDialog</h4>
@@ -3643,15 +3576,15 @@
</p>
<dl>
-<dt><i>txt=</i></dt>
+<dt><i>txt</i></dt>
<dd>
text to search for (string)
</dd>
-<dt><i>searchDir=</i></dt>
+<dt><i>searchDir</i></dt>
<dd>
directory to search in (string)
</dd>
-<dt><i>openFiles=</i></dt>
+<dt><i>openFiles</i></dt>
<dd>
flag indicating to operate on open files (boolean)
</dd>
@@ -3665,7 +3598,7 @@
</p>
<a NAME="UserInterface.showNotification" ID="UserInterface.showNotification"></a>
<h4>UserInterface.showNotification</h4>
-<b>showNotification</b>(<i>icon, heading, text, timeout=None</i>)
+<b>showNotification</b>(<i>icon, heading, text, kind=NotificationTypes.Information, timeout=None</i>)
<p>
Public method to show a desktop notification.
@@ -3684,6 +3617,10 @@
<dd>
text of the notification
</dd>
+<dt><i>kind</i> (NotificationTypes)</dt>
+<dd>
+kind of notification to be shown
+</dd>
<dt><i>timeout</i> (int)</dt>
<dd>
time in seconds the notification should be shown
@@ -3720,15 +3657,15 @@
</p>
<dl>
-<dt><i>txt=</i></dt>
+<dt><i>txt</i></dt>
<dd>
text to search for (string)
</dd>
-<dt><i>searchDir=</i></dt>
+<dt><i>searchDir</i></dt>
<dd>
directory to search in (string)
</dd>
-<dt><i>openFiles=</i></dt>
+<dt><i>openFiles</i></dt>
<dd>
flag indicating to operate on open files (boolean)
</dd>
@@ -3766,7 +3703,7 @@
<b>versionIsNewer</b>(<i>required, snapshot=None</i>)
<p>
- Public method to check, if the eric6 version is good compared to
+ Public method to check, if the eric version is good compared to
the required version.
</p>
<dl>
@@ -3781,7 +3718,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, that the version is newer than the required
one (boolean)
