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

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

eric ide

mercurial