--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,157 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.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 /> +<a NAME="SvnDialogMixin" ID="SvnDialogMixin"></a> +<h2>SvnDialogMixin</h2> +<p> + Class implementing a dialog mixin providing common callback methods for + the pysvn client. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</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> +<td><a href="#SvnDialogMixin._cancel">_cancel</a></td> +<td>Protected method to request a cancellation of the current action.</td> +</tr><tr> +<td><a href="#SvnDialogMixin._clientCancelCallback">_clientCancelCallback</a></td> +<td>Protected method called by the client to check for cancellation.</td> +</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> +<td><a href="#SvnDialogMixin._clientLoginCallback">_clientLoginCallback</a></td> +<td>Protected method called by the client to get login information.</td> +</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> +<td><a href="#SvnDialogMixin._reset">_reset</a></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> + Constructor +</p><dl> +<dt><i>log</i></dt> +<dd> +optional log message (string) +</dd> +</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> +<h4>SvnDialogMixin._clientCancelCallback</h4> +<b>_clientCancelCallback</b>(<i></i>) +<p> + Protected method called by the client to check for cancellation. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating a cancellation +</dd> +</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> +<dt>Returns:</dt> +<dd> +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> + Protected method called by the client to get login information. +</p><dl> +<dt><i>realm</i></dt> +<dd> +name of the realm of the requested credentials (string) +</dd><dt><i>username</i></dt> +<dd> +username as supplied by subversion (string) +</dd><dt><i>may_save</i></dt> +<dd> +flag indicating, that subversion is willing to save + the answers returned (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +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> + Protected method called by the client to request acceptance for a + ssl server certificate. +</p><dl> +<dt><i>trust_dict</i></dt> +<dd> +dictionary containing the trust data +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +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> + Protected method to reset the internal state of the dialog. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file