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

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

eric ide

mercurial