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