|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread</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.SvnStatusMonitorThread</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing the VCS status monitor thread class for Subversion. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#SvnStatusMonitorThread">SvnStatusMonitorThread</a></td> |
|
39 <td>Class implementing the VCS status monitor thread class for Subversion.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="SvnStatusMonitorThread" ID="SvnStatusMonitorThread"></a> |
|
50 <h2>SvnStatusMonitorThread</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing the VCS status monitor thread class for Subversion. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 VcsStatusMonitorThread |
|
57 <h3>Class Attributes</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 |
|
64 <table> |
|
65 <tr><td>None</td></tr> |
|
66 </table> |
|
67 <h3>Methods</h3> |
|
68 |
|
69 <table> |
|
70 |
|
71 <tr> |
|
72 <td><a href="#SvnStatusMonitorThread.__init__">SvnStatusMonitorThread</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#SvnStatusMonitorThread.__clientLoginCallback">__clientLoginCallback</a></td> |
|
77 <td>Private method called by the client to get login information.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#SvnStatusMonitorThread.__clientSslServerTrustPromptCallback">__clientSslServerTrustPromptCallback</a></td> |
|
81 <td>Private method called by the client to request acceptance for a ssl server certificate.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#SvnStatusMonitorThread._performMonitor">_performMonitor</a></td> |
|
85 <td>Protected method implementing the monitoring action.</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="SvnStatusMonitorThread.__init__" ID="SvnStatusMonitorThread.__init__"></a> |
|
95 <h4>SvnStatusMonitorThread (Constructor)</h4> |
|
96 <b>SvnStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) |
|
97 |
|
98 <p> |
|
99 Constructor |
|
100 </p> |
|
101 <dl> |
|
102 |
|
103 <dt><i>interval</i></dt> |
|
104 <dd> |
|
105 new interval in seconds (integer) |
|
106 </dd> |
|
107 <dt><i>project</i></dt> |
|
108 <dd> |
|
109 reference to the project object (Project) |
|
110 </dd> |
|
111 <dt><i>vcs</i></dt> |
|
112 <dd> |
|
113 reference to the version control object |
|
114 </dd> |
|
115 <dt><i>parent</i></dt> |
|
116 <dd> |
|
117 reference to the parent object (QObject) |
|
118 </dd> |
|
119 </dl> |
|
120 <a NAME="SvnStatusMonitorThread.__clientLoginCallback" ID="SvnStatusMonitorThread.__clientLoginCallback"></a> |
|
121 <h4>SvnStatusMonitorThread.__clientLoginCallback</h4> |
|
122 <b>__clientLoginCallback</b>(<i>realm, username, may_save</i>) |
|
123 |
|
124 <p> |
|
125 Private method called by the client to get login information. |
|
126 </p> |
|
127 <dl> |
|
128 |
|
129 <dt><i>realm</i></dt> |
|
130 <dd> |
|
131 name of the realm of the requested credentials (string) |
|
132 </dd> |
|
133 <dt><i>username</i></dt> |
|
134 <dd> |
|
135 username as supplied by subversion (string) |
|
136 </dd> |
|
137 <dt><i>may_save</i></dt> |
|
138 <dd> |
|
139 flag indicating, that subversion is willing to save |
|
140 the answers returned (boolean) |
|
141 </dd> |
|
142 </dl> |
|
143 <dl> |
|
144 <dt>Return:</dt> |
|
145 <dd> |
|
146 tuple of four values (retcode, username, password, save). |
|
147 Retcode should be True, if username and password should be used |
|
148 by subversion, username and password contain the relevant data |
|
149 as strings and save is a flag indicating, that username and |
|
150 password should be saved. Always returns (False, "", "", False). |
|
151 </dd> |
|
152 </dl> |
|
153 <a NAME="SvnStatusMonitorThread.__clientSslServerTrustPromptCallback" ID="SvnStatusMonitorThread.__clientSslServerTrustPromptCallback"></a> |
|
154 <h4>SvnStatusMonitorThread.__clientSslServerTrustPromptCallback</h4> |
|
155 <b>__clientSslServerTrustPromptCallback</b>(<i>trust_dict</i>) |
|
156 |
|
157 <p> |
|
158 Private method called by the client to request acceptance for a |
|
159 ssl server certificate. |
|
160 </p> |
|
161 <dl> |
|
162 |
|
163 <dt><i>trust_dict</i></dt> |
|
164 <dd> |
|
165 dictionary containing the trust data |
|
166 </dd> |
|
167 </dl> |
|
168 <dl> |
|
169 <dt>Return:</dt> |
|
170 <dd> |
|
171 tuple of three values (retcode, acceptedFailures, save). |
|
172 Retcode should be true, if the certificate should be accepted, |
|
173 acceptedFailures should indicate the accepted certificate failures |
|
174 and save should be True, if subversion should save the certificate. |
|
175 Always returns (False, 0, False). |
|
176 </dd> |
|
177 </dl> |
|
178 <a NAME="SvnStatusMonitorThread._performMonitor" ID="SvnStatusMonitorThread._performMonitor"></a> |
|
179 <h4>SvnStatusMonitorThread._performMonitor</h4> |
|
180 <b>_performMonitor</b>(<i></i>) |
|
181 |
|
182 <p> |
|
183 Protected method implementing the monitoring action. |
|
184 </p> |
|
185 <p> |
|
186 This method populates the statusList member variable |
|
187 with a list of strings giving the status in the first column and the |
|
188 path relative to the project directory starting with the third column. |
|
189 The allowed status flags are: |
|
190 <ul> |
|
191 <li>"A" path was added but not yet comitted</li> |
|
192 <li>"M" path has local changes</li> |
|
193 <li>"O" path was removed</li> |
|
194 <li>"R" path was deleted and then re-added</li> |
|
195 <li>"U" path needs an update</li> |
|
196 <li>"Z" path contains a conflict</li> |
|
197 <li>" " path is back at normal</li> |
|
198 </ul> |
|
199 </p> |
|
200 <dl> |
|
201 <dt>Return:</dt> |
|
202 <dd> |
|
203 tuple of flag indicating successful operation (boolean) and |
|
204 a status message in case of non successful operation (string) |
|
205 </dd> |
|
206 </dl> |
|
207 <div align="right"><a href="#top">Up</a></div> |
|
208 <hr /> |
|
209 </body></html> |