Documentation/Source/eric4.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
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.SvnStatusMonitorThread</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.SvnStatusMonitorThread</h1>
24 <p>
25 Module implementing the VCS status monitor thread class for Subversion.
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="#SvnStatusMonitorThread">SvnStatusMonitorThread</a></td>
35 <td>Class implementing the VCS status monitor thread class for Subversion.</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="SvnStatusMonitorThread" ID="SvnStatusMonitorThread"></a>
44 <h2>SvnStatusMonitorThread</h2>
45 <p>
46 Class implementing the VCS status monitor thread class for Subversion.
47 </p>
48 <h3>Derived from</h3>
49 VcsStatusMonitorThread
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#SvnStatusMonitorThread.__init__">SvnStatusMonitorThread</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#SvnStatusMonitorThread.__clientLoginCallback">__clientLoginCallback</a></td>
61 <td>Private method called by the client to get login information.</td>
62 </tr><tr>
63 <td><a href="#SvnStatusMonitorThread.__clientSslServerTrustPromptCallback">__clientSslServerTrustPromptCallback</a></td>
64 <td>Private method called by the client to request acceptance for a ssl server certificate.</td>
65 </tr><tr>
66 <td><a href="#SvnStatusMonitorThread._performMonitor">_performMonitor</a></td>
67 <td>Protected method implementing the monitoring action.</td>
68 </tr>
69 </table>
70 <a NAME="SvnStatusMonitorThread.__init__" ID="SvnStatusMonitorThread.__init__"></a>
71 <h4>SvnStatusMonitorThread (Constructor)</h4>
72 <b>SvnStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>)
73 <p>
74 Constructor
75 </p><dl>
76 <dt><i>interval</i></dt>
77 <dd>
78 new interval in seconds (integer)
79 </dd><dt><i>projectDir</i></dt>
80 <dd>
81 project directory to monitor (string)
82 </dd><dt><i>vcs</i></dt>
83 <dd>
84 reference to the version control object
85 </dd><dt><i>parent</i></dt>
86 <dd>
87 reference to the parent object (QObject)
88 </dd>
89 </dl><a NAME="SvnStatusMonitorThread.__clientLoginCallback" ID="SvnStatusMonitorThread.__clientLoginCallback"></a>
90 <h4>SvnStatusMonitorThread.__clientLoginCallback</h4>
91 <b>__clientLoginCallback</b>(<i>realm, username, may_save</i>)
92 <p>
93 Private method called by the client to get login information.
94 </p><dl>
95 <dt><i>realm</i></dt>
96 <dd>
97 name of the realm of the requested credentials (string)
98 </dd><dt><i>username</i></dt>
99 <dd>
100 username as supplied by subversion (string)
101 </dd><dt><i>may_save</i></dt>
102 <dd>
103 flag indicating, that subversion is willing to save
104 the answers returned (boolean)
105 </dd>
106 </dl><dl>
107 <dt>Returns:</dt>
108 <dd>
109 tuple of four values (retcode, username, password, save).
110 Retcode should be True, if username and password should be used
111 by subversion, username and password contain the relevant data
112 as strings and save is a flag indicating, that username and
113 password should be saved. Always returns (False, "", "", False).
114 </dd>
115 </dl><a NAME="SvnStatusMonitorThread.__clientSslServerTrustPromptCallback" ID="SvnStatusMonitorThread.__clientSslServerTrustPromptCallback"></a>
116 <h4>SvnStatusMonitorThread.__clientSslServerTrustPromptCallback</h4>
117 <b>__clientSslServerTrustPromptCallback</b>(<i>trust_dict</i>)
118 <p>
119 Private method called by the client to request acceptance for a
120 ssl server certificate.
121 </p><dl>
122 <dt><i>trust_dict</i></dt>
123 <dd>
124 dictionary containing the trust data
125 </dd>
126 </dl><dl>
127 <dt>Returns:</dt>
128 <dd>
129 tuple of three values (retcode, acceptedFailures, save).
130 Retcode should be true, if the certificate should be accepted,
131 acceptedFailures should indicate the accepted certificate failures
132 and save should be True, if subversion should save the certificate.
133 Always returns (False, 0, False).
134 </dd>
135 </dl><a NAME="SvnStatusMonitorThread._performMonitor" ID="SvnStatusMonitorThread._performMonitor"></a>
136 <h4>SvnStatusMonitorThread._performMonitor</h4>
137 <b>_performMonitor</b>(<i></i>)
138 <p>
139 Protected method implementing the monitoring action.
140 </p><p>
141 This method populates the statusList member variable
142 with a list of strings giving the status in the first column and the
143 path relative to the project directory starting with the third column.
144 The allowed status flags are:
145 <ul>
146 <li>"A" path was added but not yet comitted</li>
147 <li>"M" path has local changes</li>
148 <li>"R" path was deleted and then re-added</li>
149 <li>"U" path needs an update</li>
150 <li>"Z" path contains a conflict</li>
151 <li>" " path is back at normal</li>
152 </ul>
153 </p><dl>
154 <dt>Returns:</dt>
155 <dd>
156 tuple of flag indicating successful operation (boolean) and
157 a status message in case of non successful operation (string)
158 </dd>
159 </dl>
160 <div align="right"><a href="#top">Up</a></div>
161 <hr />
162 </body></html>

eric ide

mercurial