|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin</title> |
|
6 <style> |
|
7 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' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin</h1> |
|
12 <p> |
|
13 Module implementing a dialog mixin class providing common callback methods for |
|
14 the pysvn client. |
|
15 </p> |
|
16 <h3>Global Attributes</h3> |
|
17 <table> |
|
18 <tr><td>None</td></tr> |
|
19 </table> |
|
20 <h3>Classes</h3> |
|
21 <table> |
|
22 <tr> |
|
23 <td><a href="#SvnDialogMixin">SvnDialogMixin</a></td> |
|
24 <td>Class implementing a dialog mixin providing common callback methods for the pysvn client.</td> |
|
25 </tr> |
|
26 </table> |
|
27 <h3>Functions</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <hr /><hr /> |
|
32 <a NAME="SvnDialogMixin" ID="SvnDialogMixin"></a> |
|
33 <h2>SvnDialogMixin</h2> |
|
34 <p> |
|
35 Class implementing a dialog mixin providing common callback methods for |
|
36 the pysvn client. |
|
37 </p> |
|
38 <h3>Derived from</h3> |
|
39 object |
|
40 <h3>Class Attributes</h3> |
|
41 <table> |
|
42 <tr><td>None</td></tr> |
|
43 </table> |
|
44 <h3>Methods</h3> |
|
45 <table> |
|
46 <tr> |
|
47 <td><a href="#SvnDialogMixin.__init__">SvnDialogMixin</a></td> |
|
48 <td>Constructor</td> |
|
49 </tr><tr> |
|
50 <td><a href="#SvnDialogMixin._cancel">_cancel</a></td> |
|
51 <td>Protected method to request a cancellation of the current action.</td> |
|
52 </tr><tr> |
|
53 <td><a href="#SvnDialogMixin._clientCancelCallback">_clientCancelCallback</a></td> |
|
54 <td>Protected method called by the client to check for cancellation.</td> |
|
55 </tr><tr> |
|
56 <td><a href="#SvnDialogMixin._clientLogCallback">_clientLogCallback</a></td> |
|
57 <td>Protected method called by the client to request a log message.</td> |
|
58 </tr><tr> |
|
59 <td><a href="#SvnDialogMixin._clientLoginCallback">_clientLoginCallback</a></td> |
|
60 <td>Protected method called by the client to get login information.</td> |
|
61 </tr><tr> |
|
62 <td><a href="#SvnDialogMixin._clientSslServerTrustPromptCallback">_clientSslServerTrustPromptCallback</a></td> |
|
63 <td>Protected method called by the client to request acceptance for a ssl server certificate.</td> |
|
64 </tr><tr> |
|
65 <td><a href="#SvnDialogMixin._reset">_reset</a></td> |
|
66 <td>Protected method to reset the internal state of the dialog.</td> |
|
67 </tr> |
|
68 </table> |
|
69 <a NAME="SvnDialogMixin.__init__" ID="SvnDialogMixin.__init__"></a> |
|
70 <h4>SvnDialogMixin (Constructor)</h4> |
|
71 <b>SvnDialogMixin</b>(<i>log = ""</i>) |
|
72 <p> |
|
73 Constructor |
|
74 </p><dl> |
|
75 <dt><i>log</i></dt> |
|
76 <dd> |
|
77 optional log message (string) |
|
78 </dd> |
|
79 </dl><a NAME="SvnDialogMixin._cancel" ID="SvnDialogMixin._cancel"></a> |
|
80 <h4>SvnDialogMixin._cancel</h4> |
|
81 <b>_cancel</b>(<i></i>) |
|
82 <p> |
|
83 Protected method to request a cancellation of the current action. |
|
84 </p><a NAME="SvnDialogMixin._clientCancelCallback" ID="SvnDialogMixin._clientCancelCallback"></a> |
|
85 <h4>SvnDialogMixin._clientCancelCallback</h4> |
|
86 <b>_clientCancelCallback</b>(<i></i>) |
|
87 <p> |
|
88 Protected method called by the client to check for cancellation. |
|
89 </p><dl> |
|
90 <dt>Returns:</dt> |
|
91 <dd> |
|
92 flag indicating a cancellation |
|
93 </dd> |
|
94 </dl><a NAME="SvnDialogMixin._clientLogCallback" ID="SvnDialogMixin._clientLogCallback"></a> |
|
95 <h4>SvnDialogMixin._clientLogCallback</h4> |
|
96 <b>_clientLogCallback</b>(<i></i>) |
|
97 <p> |
|
98 Protected method called by the client to request a log message. |
|
99 </p><dl> |
|
100 <dt>Returns:</dt> |
|
101 <dd> |
|
102 a flag indicating success and the log message (string) |
|
103 </dd> |
|
104 </dl><a NAME="SvnDialogMixin._clientLoginCallback" ID="SvnDialogMixin._clientLoginCallback"></a> |
|
105 <h4>SvnDialogMixin._clientLoginCallback</h4> |
|
106 <b>_clientLoginCallback</b>(<i>realm, username, may_save</i>) |
|
107 <p> |
|
108 Protected method called by the client to get login information. |
|
109 </p><dl> |
|
110 <dt><i>realm</i></dt> |
|
111 <dd> |
|
112 name of the realm of the requested credentials (string) |
|
113 </dd><dt><i>username</i></dt> |
|
114 <dd> |
|
115 username as supplied by subversion (string) |
|
116 </dd><dt><i>may_save</i></dt> |
|
117 <dd> |
|
118 flag indicating, that subversion is willing to save |
|
119 the answers returned (boolean) |
|
120 </dd> |
|
121 </dl><dl> |
|
122 <dt>Returns:</dt> |
|
123 <dd> |
|
124 tuple of four values (retcode, username, password, save). |
|
125 Retcode should be True, if username and password should be used |
|
126 by subversion, username and password contain the relevant data |
|
127 as strings and save is a flag indicating, that username and |
|
128 password should be saved. |
|
129 </dd> |
|
130 </dl><a NAME="SvnDialogMixin._clientSslServerTrustPromptCallback" ID="SvnDialogMixin._clientSslServerTrustPromptCallback"></a> |
|
131 <h4>SvnDialogMixin._clientSslServerTrustPromptCallback</h4> |
|
132 <b>_clientSslServerTrustPromptCallback</b>(<i>trust_dict</i>) |
|
133 <p> |
|
134 Protected method called by the client to request acceptance for a |
|
135 ssl server certificate. |
|
136 </p><dl> |
|
137 <dt><i>trust_dict</i></dt> |
|
138 <dd> |
|
139 dictionary containing the trust data |
|
140 </dd> |
|
141 </dl><dl> |
|
142 <dt>Returns:</dt> |
|
143 <dd> |
|
144 tuple of three values (retcode, acceptedFailures, save). |
|
145 Retcode should be true, if the certificate should be accepted, |
|
146 acceptedFailures should indicate the accepted certificate failures |
|
147 and save should be True, if subversion should save the certificate. |
|
148 </dd> |
|
149 </dl><a NAME="SvnDialogMixin._reset" ID="SvnDialogMixin._reset"></a> |
|
150 <h4>SvnDialogMixin._reset</h4> |
|
151 <b>_reset</b>(<i></i>) |
|
152 <p> |
|
153 Protected method to reset the internal state of the dialog. |
|
154 </p> |
|
155 <div align="right"><a href="#top">Up</a></div> |
|
156 <hr /> |
|
157 </body></html> |