src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html

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

eric ide

mercurial