Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,8 +22,8 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#109;&#105;x&#105;&#110; &#99;&#108;&#97;&#115;&#115; &#112;&#114;&#111;v&#105;&#100;&#105;&#110;&#103; &#99;&#111;&#109;&#109;&#111;&#110; &#99;&#97;&#108;&#108;&#98;&#97;&#99;&#107; &#109;&#101;&#116;&#104;&#111;&#100;&#115; &#102;&#111;&#114; 
-&#116;&#104;&#101; &#112;y&#115;v&#110; &#99;&#108;&#105;&#101;&#110;&#116;.
+Module implementing a dialog mixin class providing common callback methods for 
+the pysvn client.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -33,7 +33,7 @@
 <table>
 <tr>
 <td><a href="#SvnDialogMixin">SvnDialogMixin</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#109;&#105;x&#105;&#110; &#112;&#114;&#111;v&#105;&#100;&#105;&#110;&#103; &#99;&#111;&#109;&#109;&#111;&#110; &#99;&#97;&#108;&#108;&#98;&#97;&#99;&#107; &#109;&#101;&#116;&#104;&#111;&#100;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#112;y&#115;v&#110; &#99;&#108;&#105;&#101;&#110;&#116;.</td>
+<td>Class implementing a dialog mixin providing common callback methods for the pysvn client.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -44,8 +44,8 @@
 <a NAME="SvnDialogMixin" ID="SvnDialogMixin"></a>
 <h2>SvnDialogMixin</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#109;&#105;x&#105;&#110; &#112;&#114;&#111;v&#105;&#100;&#105;&#110;&#103; &#99;&#111;&#109;&#109;&#111;&#110; &#99;&#97;&#108;&#108;&#98;&#97;&#99;&#107; &#109;&#101;&#116;&#104;&#111;&#100;&#115; &#102;&#111;&#114; 
-    &#116;&#104;&#101; &#112;y&#115;v&#110; &#99;&#108;&#105;&#101;&#110;&#116;.
+    Class implementing a dialog mixin providing common callback methods for 
+    the pysvn client.
 </p>
 <h3>Derived from</h3>
 object
@@ -57,112 +57,112 @@
 <table>
 <tr>
 <td><a href="#SvnDialogMixin.__init__">SvnDialogMixin</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#SvnDialogMixin._cancel">_cancel</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#113;&#117;&#101;&#115;&#116; &#97; &#99;&#97;&#110;&#99;&#101;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#97;&#99;&#116;&#105;&#111;&#110;.</td>
+<td>Protected method to request a cancellation of the current action.</td>
 </tr><tr>
 <td><a href="#SvnDialogMixin._clientCancelCallback">_clientCancelCallback</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#108;&#105;&#101;&#110;&#116; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#102;&#111;&#114; &#99;&#97;&#110;&#99;&#101;&#108;&#108;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Protected method called by the client to check for cancellation.</td>
 </tr><tr>
 <td><a href="#SvnDialogMixin._clientLogCallback">_clientLogCallback</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#108;&#105;&#101;&#110;&#116; &#116;&#111; &#114;&#101;&#113;&#117;&#101;&#115;&#116; &#97; &#108;&#111;&#103; &#109;&#101;&#115;&#115;&#97;&#103;&#101;.</td>
+<td>Protected method called by the client to request a log message.</td>
 </tr><tr>
 <td><a href="#SvnDialogMixin._clientLoginCallback">_clientLoginCallback</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#108;&#105;&#101;&#110;&#116; &#116;&#111; &#103;&#101;&#116; &#108;&#111;&#103;&#105;&#110; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Protected method called by the client to get login information.</td>
 </tr><tr>
 <td><a href="#SvnDialogMixin._clientSslServerTrustPromptCallback">_clientSslServerTrustPromptCallback</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#108;&#105;&#101;&#110;&#116; &#116;&#111; &#114;&#101;&#113;&#117;&#101;&#115;&#116; &#97;&#99;&#99;&#101;&#112;&#116;&#97;&#110;&#99;&#101; &#102;&#111;&#114; &#97; &#115;&#115;&#108; &#115;&#101;&#114;v&#101;&#114; &#99;&#101;&#114;&#116;&#105;&#102;&#105;&#99;&#97;&#116;&#101;.</td>
+<td>Protected method called by the client to request acceptance for a ssl server certificate.</td>
 </tr><tr>
 <td><a href="#SvnDialogMixin._reset">_reset</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#115;&#101;&#116; &#116;&#104;&#101; &#105;&#110;&#116;&#101;&#114;&#110;&#97;&#108; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Protected method to reset the internal state of the dialog.</td>
 </tr>
 </table>
 <a NAME="SvnDialogMixin.__init__" ID="SvnDialogMixin.__init__"></a>
 <h4>SvnDialogMixin (Constructor)</h4>
 <b>SvnDialogMixin</b>(<i>log = ""</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>log</i></dt>
 <dd>
-&#111;&#112;&#116;&#105;&#111;&#110;&#97;&#108; &#108;&#111;&#103; &#109;&#101;&#115;&#115;&#97;&#103;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+optional log message (string)
 </dd>
 </dl><a NAME="SvnDialogMixin._cancel" ID="SvnDialogMixin._cancel"></a>
 <h4>SvnDialogMixin._cancel</h4>
 <b>_cancel</b>(<i></i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#113;&#117;&#101;&#115;&#116; &#97; &#99;&#97;&#110;&#99;&#101;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#97;&#99;&#116;&#105;&#111;&#110;.
+        Protected method to request a cancellation of the current action.
 </p><a NAME="SvnDialogMixin._clientCancelCallback" ID="SvnDialogMixin._clientCancelCallback"></a>
 <h4>SvnDialogMixin._clientCancelCallback</h4>
 <b>_clientCancelCallback</b>(<i></i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#108;&#105;&#101;&#110;&#116; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#102;&#111;&#114; &#99;&#97;&#110;&#99;&#101;&#108;&#108;&#97;&#116;&#105;&#111;&#110;.
+        Protected method called by the client to check for cancellation.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#99;&#97;&#110;&#99;&#101;&#108;&#108;&#97;&#116;&#105;&#111;&#110;
+flag indicating a cancellation
 </dd>
 </dl><a NAME="SvnDialogMixin._clientLogCallback" ID="SvnDialogMixin._clientLogCallback"></a>
 <h4>SvnDialogMixin._clientLogCallback</h4>
 <b>_clientLogCallback</b>(<i></i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#108;&#105;&#101;&#110;&#116; &#116;&#111; &#114;&#101;&#113;&#117;&#101;&#115;&#116; &#97; &#108;&#111;&#103; &#109;&#101;&#115;&#115;&#97;&#103;&#101;.
+        Protected method called by the client to request a log message.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#97; &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#115;&#117;&#99;&#99;&#101;&#115;&#115; &#97;&#110;&#100; &#116;&#104;&#101; &#108;&#111;&#103; &#109;&#101;&#115;&#115;&#97;&#103;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+a flag indicating success and the log message (string)
 </dd>
 </dl><a NAME="SvnDialogMixin._clientLoginCallback" ID="SvnDialogMixin._clientLoginCallback"></a>
 <h4>SvnDialogMixin._clientLoginCallback</h4>
 <b>_clientLoginCallback</b>(<i>realm, username, may_save</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#108;&#105;&#101;&#110;&#116; &#116;&#111; &#103;&#101;&#116; &#108;&#111;&#103;&#105;&#110; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.
+        Protected method called by the client to get login information.
 </p><dl>
 <dt><i>realm</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#114;&#101;&#97;&#108;&#109; &#111;&#102; &#116;&#104;&#101; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100; &#99;&#114;&#101;&#100;&#101;&#110;&#116;&#105;&#97;&#108;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the realm of the requested credentials (string)
 </dd><dt><i>username</i></dt>
 <dd>
-&#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; &#97;&#115; &#115;&#117;&#112;&#112;&#108;&#105;&#101;&#100; &#98;y &#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+username as supplied by subversion (string)
 </dd><dt><i>may_save</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#116;&#104;&#97;&#116; &#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#115; w&#105;&#108;&#108;&#105;&#110;&#103; &#116;&#111; &#115;&#97;v&#101;
-            &#116;&#104;&#101; &#97;&#110;&#115;w&#101;&#114;&#115; &#114;&#101;&#116;&#117;&#114;&#110;&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating, that subversion is willing to save
+            the answers returned (boolean)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#102;&#111;&#117;&#114; v&#97;&#108;&#117;&#101;&#115; (&#114;&#101;&#116;&#99;&#111;&#100;&#101;, &#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101;, &#112;&#97;&#115;&#115;w&#111;&#114;&#100;, &#115;&#97;v&#101;).
-            &#82;&#101;&#116;&#99;&#111;&#100;&#101; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#84;&#114;&#117;&#101;, &#105;&#102; &#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; &#97;&#110;&#100; &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#117;&#115;&#101;&#100; 
-            &#98;y &#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110;, &#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; &#97;&#110;&#100; &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#99;&#111;&#110;&#116;&#97;&#105;&#110; &#116;&#104;&#101; &#114;&#101;&#108;&#101;v&#97;&#110;&#116; &#100;&#97;&#116;&#97; 
-            &#97;&#115; &#115;&#116;&#114;&#105;&#110;&#103;&#115; &#97;&#110;&#100; &#115;&#97;v&#101; &#105;&#115; &#97; &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#116;&#104;&#97;&#116; &#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; &#97;&#110;&#100;
-            &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#115;&#97;v&#101;&#100;.
+tuple of four values (retcode, username, password, save).
+            Retcode should be True, if username and password should be used 
+            by subversion, username and password contain the relevant data 
+            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>
 <h4>SvnDialogMixin._clientSslServerTrustPromptCallback</h4>
 <b>_clientSslServerTrustPromptCallback</b>(<i>trust_dict</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#108;&#105;&#101;&#110;&#116; &#116;&#111; &#114;&#101;&#113;&#117;&#101;&#115;&#116; &#97;&#99;&#99;&#101;&#112;&#116;&#97;&#110;&#99;&#101; &#102;&#111;&#114; &#97;
-        &#115;&#115;&#108; &#115;&#101;&#114;v&#101;&#114; &#99;&#101;&#114;&#116;&#105;&#102;&#105;&#99;&#97;&#116;&#101;.
+        Protected method called by the client to request acceptance for a
+        ssl server certificate.
 </p><dl>
 <dt><i>trust_dict</i></dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#116;&#114;&#117;&#115;&#116; &#100;&#97;&#116;&#97;
+dictionary containing the trust data
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;&#104;&#114;&#101;&#101; v&#97;&#108;&#117;&#101;&#115; (&#114;&#101;&#116;&#99;&#111;&#100;&#101;, &#97;&#99;&#99;&#101;&#112;&#116;&#101;&#100;&#70;&#97;&#105;&#108;&#117;&#114;&#101;&#115;, &#115;&#97;v&#101;).
-            &#82;&#101;&#116;&#99;&#111;&#100;&#101; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#116;&#114;&#117;&#101;, &#105;&#102; &#116;&#104;&#101; &#99;&#101;&#114;&#116;&#105;&#102;&#105;&#99;&#97;&#116;&#101; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#97;&#99;&#99;&#101;&#112;&#116;&#101;&#100;,
-            &#97;&#99;&#99;&#101;&#112;&#116;&#101;&#100;&#70;&#97;&#105;&#108;&#117;&#114;&#101;&#115; &#115;&#104;&#111;&#117;&#108;&#100; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#99;&#99;&#101;&#112;&#116;&#101;&#100; &#99;&#101;&#114;&#116;&#105;&#102;&#105;&#99;&#97;&#116;&#101; &#102;&#97;&#105;&#108;&#117;&#114;&#101;&#115;
-            &#97;&#110;&#100; &#115;&#97;v&#101; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#84;&#114;&#117;&#101;, &#105;&#102; &#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#104;&#111;&#117;&#108;&#100; &#115;&#97;v&#101; &#116;&#104;&#101; &#99;&#101;&#114;&#116;&#105;&#102;&#105;&#99;&#97;&#116;&#101;.
+tuple of three values (retcode, acceptedFailures, save).
+            Retcode should be true, if the certificate should be accepted,
+            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>
 <h4>SvnDialogMixin._reset</h4>
 <b>_reset</b>(<i></i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#115;&#101;&#116; &#116;&#104;&#101; &#105;&#110;&#116;&#101;&#114;&#110;&#97;&#108; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.
+        Protected method to reset the internal state of the dialog.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial