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