diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,30 +18,38 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin</h1> + <p> Module implementing a dialog mixin class providing common callback methods for the pysvn client. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#SvnDialogMixin">SvnDialogMixin</a></td> <td>Class implementing a dialog mixin providing common callback methods for the pysvn client.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="SvnDialogMixin" ID="SvnDialogMixin"></a> <h2>SvnDialogMixin</h2> + <p> Class implementing a dialog mixin providing common callback methods for the pysvn client. @@ -49,95 +57,125 @@ <h3>Derived from</h3> object <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#SvnDialogMixin.__init__">SvnDialogMixin</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialogMixin._cancel">_cancel</a></td> <td>Protected method to request a cancellation of the current action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialogMixin._clientCancelCallback">_clientCancelCallback</a></td> <td>Protected method called by the client to check for cancellation.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialogMixin._clientLogCallback">_clientLogCallback</a></td> <td>Protected method called by the client to request a log message.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialogMixin._clientLoginCallback">_clientLoginCallback</a></td> <td>Protected method called by the client to get login information.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialogMixin._clientSslServerTrustPromptCallback">_clientSslServerTrustPromptCallback</a></td> <td>Protected method called by the client to request acceptance for a ssl server certificate.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialogMixin._reset">_reset</a></td> <td>Protected method to reset the internal state of the dialog.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="SvnDialogMixin.__init__" ID="SvnDialogMixin.__init__"></a> <h4>SvnDialogMixin (Constructor)</h4> <b>SvnDialogMixin</b>(<i>log=""</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>log</i></dt> <dd> optional log message (string) </dd> -</dl><a NAME="SvnDialogMixin._cancel" ID="SvnDialogMixin._cancel"></a> +</dl> +<a NAME="SvnDialogMixin._cancel" ID="SvnDialogMixin._cancel"></a> <h4>SvnDialogMixin._cancel</h4> <b>_cancel</b>(<i></i>) + <p> Protected method to request a cancellation of the current action. -</p><a NAME="SvnDialogMixin._clientCancelCallback" ID="SvnDialogMixin._clientCancelCallback"></a> +</p> +<a NAME="SvnDialogMixin._clientCancelCallback" ID="SvnDialogMixin._clientCancelCallback"></a> <h4>SvnDialogMixin._clientCancelCallback</h4> <b>_clientCancelCallback</b>(<i></i>) + <p> Protected method called by the client to check for cancellation. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating a cancellation </dd> -</dl><a NAME="SvnDialogMixin._clientLogCallback" ID="SvnDialogMixin._clientLogCallback"></a> +</dl> +<a NAME="SvnDialogMixin._clientLogCallback" ID="SvnDialogMixin._clientLogCallback"></a> <h4>SvnDialogMixin._clientLogCallback</h4> <b>_clientLogCallback</b>(<i></i>) + <p> Protected method called by the client to request a log message. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> a flag indicating success and the log message (string) </dd> -</dl><a NAME="SvnDialogMixin._clientLoginCallback" ID="SvnDialogMixin._clientLoginCallback"></a> +</dl> +<a NAME="SvnDialogMixin._clientLoginCallback" ID="SvnDialogMixin._clientLoginCallback"></a> <h4>SvnDialogMixin._clientLoginCallback</h4> <b>_clientLoginCallback</b>(<i>realm, username, may_save</i>) + <p> Protected method called by the client to get login information. -</p><dl> +</p> +<dl> + <dt><i>realm</i></dt> <dd> name of the realm of the requested credentials (string) -</dd><dt><i>username</i></dt> +</dd> +<dt><i>username</i></dt> <dd> username as supplied by subversion (string) -</dd><dt><i>may_save</i></dt> +</dd> +<dt><i>may_save</i></dt> <dd> flag indicating, that subversion is willing to save the answers returned (boolean) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> tuple of four values (retcode, username, password, save). @@ -146,18 +184,23 @@ as strings and save is a flag indicating, that username and password should be saved. </dd> -</dl><a NAME="SvnDialogMixin._clientSslServerTrustPromptCallback" ID="SvnDialogMixin._clientSslServerTrustPromptCallback"></a> +</dl> +<a NAME="SvnDialogMixin._clientSslServerTrustPromptCallback" ID="SvnDialogMixin._clientSslServerTrustPromptCallback"></a> <h4>SvnDialogMixin._clientSslServerTrustPromptCallback</h4> <b>_clientSslServerTrustPromptCallback</b>(<i>trust_dict</i>) + <p> Protected method called by the client to request acceptance for a ssl server certificate. -</p><dl> +</p> +<dl> + <dt><i>trust_dict</i></dt> <dd> dictionary containing the trust data </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> tuple of three values (retcode, acceptedFailures, save). @@ -165,9 +208,11 @@ acceptedFailures should indicate the accepted certificate failures and save should be True, if subversion should save the certificate. </dd> -</dl><a NAME="SvnDialogMixin._reset" ID="SvnDialogMixin._reset"></a> +</dl> +<a NAME="SvnDialogMixin._reset" ID="SvnDialogMixin._reset"></a> <h4>SvnDialogMixin._reset</h4> <b>_reset</b>(<i></i>) + <p> Protected method to reset the internal state of the dialog. </p>