|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a dialog mixin class providing common callback methods for |
|
27 the pysvn client. |
|
28 </p> |
|
29 <h3>Global Attributes</h3> |
|
30 |
|
31 <table> |
|
32 <tr><td>None</td></tr> |
|
33 </table> |
|
34 <h3>Classes</h3> |
|
35 |
|
36 <table> |
|
37 |
|
38 <tr> |
|
39 <td><a href="#SvnDialogMixin">SvnDialogMixin</a></td> |
|
40 <td>Class implementing a dialog mixin providing common callback methods for the pysvn client.</td> |
|
41 </tr> |
|
42 </table> |
|
43 <h3>Functions</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <hr /> |
|
49 <hr /> |
|
50 <a NAME="SvnDialogMixin" ID="SvnDialogMixin"></a> |
|
51 <h2>SvnDialogMixin</h2> |
|
52 |
|
53 <p> |
|
54 Class implementing a dialog mixin providing common callback methods for |
|
55 the pysvn client. |
|
56 </p> |
|
57 <h3>Derived from</h3> |
|
58 None |
|
59 <h3>Class Attributes</h3> |
|
60 |
|
61 <table> |
|
62 <tr><td>None</td></tr> |
|
63 </table> |
|
64 <h3>Class Methods</h3> |
|
65 |
|
66 <table> |
|
67 <tr><td>None</td></tr> |
|
68 </table> |
|
69 <h3>Methods</h3> |
|
70 |
|
71 <table> |
|
72 |
|
73 <tr> |
|
74 <td><a href="#SvnDialogMixin.__init__">SvnDialogMixin</a></td> |
|
75 <td>Constructor</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#SvnDialogMixin._cancel">_cancel</a></td> |
|
79 <td>Protected method to request a cancellation of the current action.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#SvnDialogMixin._clientCancelCallback">_clientCancelCallback</a></td> |
|
83 <td>Protected method called by the client to check for cancellation.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#SvnDialogMixin._clientLogCallback">_clientLogCallback</a></td> |
|
87 <td>Protected method called by the client to request a log message.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#SvnDialogMixin._clientLoginCallback">_clientLoginCallback</a></td> |
|
91 <td>Protected method called by the client to get login information.</td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td><a href="#SvnDialogMixin._clientSslServerTrustPromptCallback">_clientSslServerTrustPromptCallback</a></td> |
|
95 <td>Protected method called by the client to request acceptance for a ssl server certificate.</td> |
|
96 </tr> |
|
97 <tr> |
|
98 <td><a href="#SvnDialogMixin._reset">_reset</a></td> |
|
99 <td>Protected method to reset the internal state of the dialog.</td> |
|
100 </tr> |
|
101 </table> |
|
102 <h3>Static Methods</h3> |
|
103 |
|
104 <table> |
|
105 <tr><td>None</td></tr> |
|
106 </table> |
|
107 |
|
108 <a NAME="SvnDialogMixin.__init__" ID="SvnDialogMixin.__init__"></a> |
|
109 <h4>SvnDialogMixin (Constructor)</h4> |
|
110 <b>SvnDialogMixin</b>(<i>log=""</i>) |
|
111 |
|
112 <p> |
|
113 Constructor |
|
114 </p> |
|
115 <dl> |
|
116 |
|
117 <dt><i>log</i></dt> |
|
118 <dd> |
|
119 optional log message (string) |
|
120 </dd> |
|
121 </dl> |
|
122 <a NAME="SvnDialogMixin._cancel" ID="SvnDialogMixin._cancel"></a> |
|
123 <h4>SvnDialogMixin._cancel</h4> |
|
124 <b>_cancel</b>(<i></i>) |
|
125 |
|
126 <p> |
|
127 Protected method to request a cancellation of the current action. |
|
128 </p> |
|
129 <a NAME="SvnDialogMixin._clientCancelCallback" ID="SvnDialogMixin._clientCancelCallback"></a> |
|
130 <h4>SvnDialogMixin._clientCancelCallback</h4> |
|
131 <b>_clientCancelCallback</b>(<i></i>) |
|
132 |
|
133 <p> |
|
134 Protected method called by the client to check for cancellation. |
|
135 </p> |
|
136 <dl> |
|
137 <dt>Return:</dt> |
|
138 <dd> |
|
139 flag indicating a cancellation |
|
140 </dd> |
|
141 </dl> |
|
142 <a NAME="SvnDialogMixin._clientLogCallback" ID="SvnDialogMixin._clientLogCallback"></a> |
|
143 <h4>SvnDialogMixin._clientLogCallback</h4> |
|
144 <b>_clientLogCallback</b>(<i></i>) |
|
145 |
|
146 <p> |
|
147 Protected method called by the client to request a log message. |
|
148 </p> |
|
149 <dl> |
|
150 <dt>Return:</dt> |
|
151 <dd> |
|
152 a flag indicating success and the log message (string) |
|
153 </dd> |
|
154 </dl> |
|
155 <a NAME="SvnDialogMixin._clientLoginCallback" ID="SvnDialogMixin._clientLoginCallback"></a> |
|
156 <h4>SvnDialogMixin._clientLoginCallback</h4> |
|
157 <b>_clientLoginCallback</b>(<i>realm, username, may_save</i>) |
|
158 |
|
159 <p> |
|
160 Protected method called by the client to get login information. |
|
161 </p> |
|
162 <dl> |
|
163 |
|
164 <dt><i>realm</i></dt> |
|
165 <dd> |
|
166 name of the realm of the requested credentials (string) |
|
167 </dd> |
|
168 <dt><i>username</i></dt> |
|
169 <dd> |
|
170 username as supplied by subversion (string) |
|
171 </dd> |
|
172 <dt><i>may_save</i></dt> |
|
173 <dd> |
|
174 flag indicating, that subversion is willing to save |
|
175 the answers returned (boolean) |
|
176 </dd> |
|
177 </dl> |
|
178 <dl> |
|
179 <dt>Return:</dt> |
|
180 <dd> |
|
181 tuple of four values (retcode, username, password, save). |
|
182 Retcode should be True, if username and password should be used |
|
183 by subversion, username and password contain the relevant data |
|
184 as strings and save is a flag indicating, that username and |
|
185 password should be saved. |
|
186 </dd> |
|
187 </dl> |
|
188 <a NAME="SvnDialogMixin._clientSslServerTrustPromptCallback" ID="SvnDialogMixin._clientSslServerTrustPromptCallback"></a> |
|
189 <h4>SvnDialogMixin._clientSslServerTrustPromptCallback</h4> |
|
190 <b>_clientSslServerTrustPromptCallback</b>(<i>trust_dict</i>) |
|
191 |
|
192 <p> |
|
193 Protected method called by the client to request acceptance for a |
|
194 ssl server certificate. |
|
195 </p> |
|
196 <dl> |
|
197 |
|
198 <dt><i>trust_dict</i></dt> |
|
199 <dd> |
|
200 dictionary containing the trust data |
|
201 </dd> |
|
202 </dl> |
|
203 <dl> |
|
204 <dt>Return:</dt> |
|
205 <dd> |
|
206 tuple of three values (retcode, acceptedFailures, save). |
|
207 Retcode should be true, if the certificate should be accepted, |
|
208 acceptedFailures should indicate the accepted certificate failures |
|
209 and save should be True, if subversion should save the certificate. |
|
210 </dd> |
|
211 </dl> |
|
212 <a NAME="SvnDialogMixin._reset" ID="SvnDialogMixin._reset"></a> |
|
213 <h4>SvnDialogMixin._reset</h4> |
|
214 <b>_reset</b>(<i></i>) |
|
215 |
|
216 <p> |
|
217 Protected method to reset the internal state of the dialog. |
|
218 </p> |
|
219 <div align="right"><a href="#top">Up</a></div> |
|
220 <hr /> |
|
221 </body></html> |