Mercurial Repositories > eric / changeset

changeset

Updated source docu.

Sun, 02 May 2021 18:14:11 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 02 May 2021 18:14:11 +0200
changeset 8284
eeaed80810ff
parent 8283
3139cbc98a14
child 8285
1816b622aef2

Updated source docu.

eric6/APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
eric6/APIs/Python3/eric6.bas file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.E5Network.E5Ftp.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Graphics.UMLDialog.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.UI.Browser.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.UI.UserInterface.html file | annotate | diff | comparison | revisions 
--- a/eric6/APIs/Python3/eric6.api	Sun May 02 18:13:23 2021 +0200
+++ b/eric6/APIs/Python3/eric6.api	Sun May 02 18:14:11 2021 +0200
@@ -1654,18 +1654,18 @@
 eric6.E5Gui.E5ZoomWidget.E5ZoomWidget?1(outPix, inPix, resetPix, parent=None)
 eric6.E5Network.E5Ftp.E5Ftp.connect?4(host="", port=0, timeout=-999)
 eric6.E5Network.E5Ftp.E5Ftp.login?4(user="", password="", acct="")
-eric6.E5Network.E5Ftp.E5Ftp.setProxy?4(proxyType=E5FtpProxyType.NoProxy, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="")
+eric6.E5Network.E5Ftp.E5Ftp.setProxy?4(proxyType=E5FtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="")
 eric6.E5Network.E5Ftp.E5Ftp.setProxyAuthentication?4(proxyUser="", proxyPassword="", proxyAccount="")
-eric6.E5Network.E5Ftp.E5Ftp?1(host="", user="", password="", acct="", proxyType=E5FtpProxyType.NoProxy, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT)
-eric6.E5Network.E5Ftp.E5FtpProxyType.AuthResp?7
-eric6.E5Network.E5Ftp.E5FtpProxyType.Bluecoat?7
-eric6.E5Network.E5Ftp.E5FtpProxyType.NoProxy?7
-eric6.E5Network.E5Ftp.E5FtpProxyType.NonAuthorizing?7
-eric6.E5Network.E5Ftp.E5FtpProxyType.Open?7
-eric6.E5Network.E5Ftp.E5FtpProxyType.ProxyuserAtServer?7
-eric6.E5Network.E5Ftp.E5FtpProxyType.Site?7
-eric6.E5Network.E5Ftp.E5FtpProxyType.UserAtProxyuserAtServer?7
-eric6.E5Network.E5Ftp.E5FtpProxyType.UserAtServer?7
+eric6.E5Network.E5Ftp.E5Ftp?1(host="", user="", password="", acct="", proxyType=E5FtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT)
+eric6.E5Network.E5Ftp.E5FtpProxyType.AUTH_RESP?7
+eric6.E5Network.E5Ftp.E5FtpProxyType.BLUECOAT?7
+eric6.E5Network.E5Ftp.E5FtpProxyType.NON_AUTHORIZING?7
+eric6.E5Network.E5Ftp.E5FtpProxyType.NO_PROXY?7
+eric6.E5Network.E5Ftp.E5FtpProxyType.OPEN?7
+eric6.E5Network.E5Ftp.E5FtpProxyType.PROXYUSER_SERVER?7
+eric6.E5Network.E5Ftp.E5FtpProxyType.SITE?7
+eric6.E5Network.E5Ftp.E5FtpProxyType.USER_PROXYUSER_SERVER?7
+eric6.E5Network.E5Ftp.E5FtpProxyType.USER_SERVER?7
 eric6.E5Network.E5GoogleMail.E5GoogleMail.sendMessage?4(message)
 eric6.E5Network.E5GoogleMail.E5GoogleMail.sendResult?7
 eric6.E5Network.E5GoogleMail.E5GoogleMail?1(parent=None)
@@ -2042,7 +2042,7 @@
 eric6.Graphics.UMLDiagramBuilder.UMLDiagramBuilder.parsePersistenceData?4(version, data)
 eric6.Graphics.UMLDiagramBuilder.UMLDiagramBuilder?1(dialog, view, project)
 eric6.Graphics.UMLDialog.UMLDialog.FileVersions?7
-eric6.Graphics.UMLDialog.UMLDialog.load?4()
+eric6.Graphics.UMLDialog.UMLDialog.load?4(filename="")
 eric6.Graphics.UMLDialog.UMLDialog.show?4(fromFile=False)
 eric6.Graphics.UMLDialog.UMLDialog?1(diagramType, project, path="", parent=None, initBuilder=True, **kwargs)
 eric6.Graphics.UMLDialog.UMLDialogType.APPLICATION_DIAGRAM?7
@@ -9140,6 +9140,7 @@
 eric6.UI.Browser.Browser.sourceFile?7
 eric6.UI.Browser.Browser.svgFile?7
 eric6.UI.Browser.Browser.trpreview?7
+eric6.UI.Browser.Browser.umlFile?7
 eric6.UI.Browser.Browser.unittestOpen?7
 eric6.UI.Browser.Browser.wantedItem?4(itm, filterList=None)
 eric6.UI.Browser.Browser?1(parent=None)
--- a/eric6/APIs/Python3/eric6.bas	Sun May 02 18:13:23 2021 +0200
+++ b/eric6/APIs/Python3/eric6.bas	Sun May 02 18:14:11 2021 +0200
@@ -187,6 +187,7 @@
 E5FileSaveConfirmDialog QDialog
 E5Ftp ftplib.FTP
 E5FtpProxyError ftplib.Error
+E5FtpProxyType enum.Enum
 E5GenericDiffHighlighter QSyntaxHighlighter
 E5GoogleMail QObject
 E5GoogleMailAuthBrowser QDialog
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Sun May 02 18:13:23 2021 +0200
+++ b/eric6/Documentation/Help/source.qhp	Sun May 02 18:14:11 2021 +0200
@@ -15827,6 +15827,7 @@
       <keyword name="UserInterface.__showSystemEmailClient" id="UserInterface.__showSystemEmailClient" ref="eric6.UI.UserInterface.html#UserInterface.__showSystemEmailClient" />
       <keyword name="UserInterface.__showToolGroupsMenu" id="UserInterface.__showToolGroupsMenu" ref="eric6.UI.UserInterface.html#UserInterface.__showToolGroupsMenu" />
       <keyword name="UserInterface.__showToolbarsMenu" id="UserInterface.__showToolbarsMenu" ref="eric6.UI.UserInterface.html#UserInterface.__showToolbarsMenu" />
+      <keyword name="UserInterface.__showUml" id="UserInterface.__showUml" ref="eric6.UI.UserInterface.html#UserInterface.__showUml" />
       <keyword name="UserInterface.__showUserToolsMenu" id="UserInterface.__showUserToolsMenu" ref="eric6.UI.UserInterface.html#UserInterface.__showUserToolsMenu" />
       <keyword name="UserInterface.__showVersions" id="UserInterface.__showVersions" ref="eric6.UI.UserInterface.html#UserInterface.__showVersions" />
       <keyword name="UserInterface.__showWindowMenu" id="UserInterface.__showWindowMenu" ref="eric6.UI.UserInterface.html#UserInterface.__showWindowMenu" />
--- a/eric6/Documentation/Source/eric6.E5Network.E5Ftp.html	Sun May 02 18:13:23 2021 +0200
+++ b/eric6/Documentation/Source/eric6.E5Network.E5Ftp.html	Sun May 02 18:14:11 2021 +0200
@@ -107,56 +107,56 @@
 
 <a NAME="E5Ftp.__init__" ID="E5Ftp.__init__"></a>
 <h4>E5Ftp (Constructor)</h4>
-<b>E5Ftp</b>(<i>host="", user="", password="", acct="", proxyType=E5FtpProxyType.NoProxy, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT</i>)
+<b>E5Ftp</b>(<i>host="", user="", password="", acct="", proxyType=E5FtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT</i>)
 
 <p>
         Constructor
 </p>
 <dl>
 
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-name of the FTP host (string)
+name of the FTP host
 </dd>
-<dt><i>user</i></dt>
+<dt><i>user</i> (str)</dt>
 <dd>
-user name for login to FTP host (string)
+user name for login to FTP host
 </dd>
-<dt><i>password</i></dt>
+<dt><i>password</i> (str)</dt>
 <dd>
-password for login to FTP host (string)
+password for login to FTP host
 </dd>
-<dt><i>acct</i></dt>
+<dt><i>acct</i> (str)</dt>
 <dd>
-account for login to FTP host (string)
+account for login to FTP host
 </dd>
-<dt><i>proxyType</i></dt>
+<dt><i>proxyType</i> (E5FtpProxyType)</dt>
 <dd>
-type of the FTP proxy (integer 0 to 8)
+type of the FTP proxy
 </dd>
-<dt><i>proxyHost</i></dt>
+<dt><i>proxyHost</i> (str)</dt>
 <dd>
-name of the FTP proxy (string)
+name of the FTP proxy
 </dd>
-<dt><i>proxyPort</i></dt>
+<dt><i>proxyPort</i> (int)</dt>
 <dd>
-port of the FTP proxy (integer)
+port of the FTP proxy
 </dd>
-<dt><i>proxyUser</i></dt>
+<dt><i>proxyUser</i> (str)</dt>
 <dd>
-user name for login to the proxy (string)
+user name for login to the proxy
 </dd>
-<dt><i>proxyPassword</i></dt>
+<dt><i>proxyPassword</i> (str)</dt>
 <dd>
-password for login to the proxy (string)
+password for login to the proxy
 </dd>
-<dt><i>proxyAccount</i></dt>
+<dt><i>proxyAccount</i> (str)</dt>
 <dd>
-accounting info for the proxy (string)
+accounting info for the proxy
 </dd>
-<dt><i>timeout</i></dt>
+<dt><i>timeout</i> (int)</dt>
 <dd>
-timeout in seconds for blocking operations (integer)
+timeout in seconds for blocking operations
 </dd>
 </dl>
 <a NAME="E5Ftp.connect" ID="E5Ftp.connect"></a>
@@ -173,23 +173,29 @@
 </p>
 <dl>
 
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-name of the FTP host (string)
+name of the FTP host
 </dd>
-<dt><i>port</i></dt>
+<dt><i>port</i> (int)</dt>
 <dd>
-port of the FTP host (integer)
+port of the FTP host
 </dd>
-<dt><i>timeout</i></dt>
+<dt><i>timeout</i> (int)</dt>
 <dd>
-timeout in seconds for blocking operations (integer)
+timeout in seconds for blocking operations
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-welcome message of the server (string)
+welcome message of the server
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <dl>
@@ -205,36 +211,36 @@
 
 <a NAME="E5Ftp.setProxy" ID="E5Ftp.setProxy"></a>
 <h4>E5Ftp.setProxy</h4>
-<b>setProxy</b>(<i>proxyType=E5FtpProxyType.NoProxy, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount=""</i>)
+<b>setProxy</b>(<i>proxyType=E5FtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount=""</i>)
 
 <p>
         Public method to set the proxy configuration.
 </p>
 <dl>
 
-<dt><i>proxyType</i></dt>
+<dt><i>proxyType</i> (E5FtpProxyType)</dt>
 <dd>
-type of the FTP proxy (integer 0 to 8)
+type of the FTP proxy
 </dd>
-<dt><i>proxyHost</i></dt>
+<dt><i>proxyHost</i> (str)</dt>
 <dd>
-name of the FTP proxy (string)
+name of the FTP proxy
 </dd>
-<dt><i>proxyPort</i></dt>
+<dt><i>proxyPort</i> (int)</dt>
 <dd>
-port of the FTP proxy (integer)
+port of the FTP proxy
 </dd>
-<dt><i>proxyUser</i></dt>
+<dt><i>proxyUser</i> (str)</dt>
 <dd>
-user name for login to the proxy (string)
+user name for login to the proxy
 </dd>
-<dt><i>proxyPassword</i></dt>
+<dt><i>proxyPassword</i> (str)</dt>
 <dd>
-password  for login to the proxy (string)
+password  for login to the proxy
 </dd>
-<dt><i>proxyAccount</i></dt>
+<dt><i>proxyAccount</i> (str)</dt>
 <dd>
-accounting info for the proxy (string)
+accounting info for the proxy
 </dd>
 </dl>
 <a NAME="E5Ftp.setProxyAuthentication" ID="E5Ftp.setProxyAuthentication"></a>
@@ -246,17 +252,17 @@
 </p>
 <dl>
 
-<dt><i>proxyUser</i></dt>
+<dt><i>proxyUser</i> (str)</dt>
 <dd>
-user name for login to the proxy (string)
+user name for login to the proxy
 </dd>
-<dt><i>proxyPassword</i></dt>
+<dt><i>proxyPassword</i> (str)</dt>
 <dd>
-password  for login to the proxy (string)
+password  for login to the proxy
 </dd>
-<dt><i>proxyAccount</i></dt>
+<dt><i>proxyAccount</i> (str)</dt>
 <dd>
-accounting info for the proxy (string)
+accounting info for the proxy
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -322,11 +328,11 @@
     Class defining the supported FTP proxy types.
 </p>
 <h3>Derived from</h3>
-None
+enum.Enum
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>AuthResp</td></tr><tr><td>Bluecoat</td></tr><tr><td>NoProxy</td></tr><tr><td>NonAuthorizing</td></tr><tr><td>Open</td></tr><tr><td>ProxyuserAtServer</td></tr><tr><td>Site</td></tr><tr><td>UserAtProxyuserAtServer</td></tr><tr><td>UserAtServer</td></tr>
+<tr><td>AUTH_RESP</td></tr><tr><td>BLUECOAT</td></tr><tr><td>NON_AUTHORIZING</td></tr><tr><td>NO_PROXY</td></tr><tr><td>OPEN</td></tr><tr><td>PROXYUSER_SERVER</td></tr><tr><td>SITE</td></tr><tr><td>USER_PROXYUSER_SERVER</td></tr><tr><td>USER_SERVER</td></tr>
 </table>
 <h3>Class Methods</h3>
 
--- a/eric6/Documentation/Source/eric6.Graphics.UMLDialog.html	Sun May 02 18:13:23 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Graphics.UMLDialog.html	Sun May 02 18:14:11 2021 +0200
@@ -250,15 +250,28 @@
 </dl>
 <a NAME="UMLDialog.load" ID="UMLDialog.load"></a>
 <h4>UMLDialog.load</h4>
-<b>load</b>(<i></i>)
+<b>load</b>(<i>filename=""</i>)
 
 <p>
         Public method to load a diagram from a file.
 </p>
 <dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the file to be loaded
+</dd>
+</dl>
+<dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="UMLDialog.show" ID="UMLDialog.show"></a>
--- a/eric6/Documentation/Source/eric6.UI.Browser.html	Sun May 02 18:13:23 2021 +0200
+++ b/eric6/Documentation/Source/eric6.UI.Browser.html	Sun May 02 18:14:11 2021 +0200
@@ -124,6 +124,10 @@
         files indicating whether non-existent files shall be ignored
         (list of str, bool)
 </dd>
+<dt>umlFile(filename)</dt>
+<dd>
+emitted to open an eric UML file (str)
+</dd>
 <dt>unittestOpen(filename)</dt>
 <dd>
 emitted to open a Python file for a
--- a/eric6/Documentation/Source/eric6.UI.UserInterface.html	Sun May 02 18:13:23 2021 +0200
+++ b/eric6/Documentation/Source/eric6.UI.UserInterface.html	Sun May 02 18:14:11 2021 +0200
@@ -706,6 +706,10 @@
 <td>Private slot to display the Toolbars menu.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.__showUml">__showUml</a></td>
+<td>Private slot to show an eric graphics file in a dialog.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.__showUserToolsMenu">__showUserToolsMenu</a></td>
 <td>Private slot to display the User Tools menu.</td>
 </tr>
@@ -2390,6 +2394,20 @@
 <p>
         Private slot to display the Toolbars menu.
 </p>
+<a NAME="UserInterface.__showUml" ID="UserInterface.__showUml"></a>
+<h4>UserInterface.__showUml</h4>
+<b>__showUml</b>(<i>fn</i>)
+
+<p>
+        Private slot to show an eric graphics file in a dialog.
+</p>
+<dl>
+
+<dt><i>fn</i> (str)</dt>
+<dd>
+name of the file to be shown
+</dd>
+</dl>
 <a NAME="UserInterface.__showUserToolsMenu" ID="UserInterface.__showUserToolsMenu"></a>
 <h4>UserInterface.__showUserToolsMenu</h4>
 <b>__showUserToolsMenu</b>(<i></i>)

Mercurial Repository: eric

eric ide

mercurial