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

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

eric ide

mercurial