Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.VCS.StatusMonitorThread.html
src/eric7/Documentation/Source/eric7.VCS.StatusMonitorThread.html
- branch
- eric7
- changeset 10436
- f6881d10e995
- parent 10070
- 9f5758c0fec1
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10435:c712d09cc839 | 10436:f6881d10e995 |
|---|---|
| 139 <p> | 139 <p> |
| 140 Constructor | 140 Constructor |
| 141 </p> | 141 </p> |
| 142 <dl> | 142 <dl> |
| 143 | 143 |
| 144 <dt><i>interval</i></dt> | 144 <dt><i>interval</i> (int)</dt> |
| 145 <dd> | 145 <dd> |
| 146 new interval in seconds (integer) | 146 new interval in seconds |
| 147 </dd> | 147 </dd> |
| 148 <dt><i>project</i></dt> | 148 <dt><i>project</i> (Project)</dt> |
| 149 <dd> | 149 <dd> |
| 150 reference to the project object (Project) | 150 reference to the project object |
| 151 </dd> | 151 </dd> |
| 152 <dt><i>vcs</i></dt> | 152 <dt><i>vcs</i> (VersionControl)</dt> |
| 153 <dd> | 153 <dd> |
| 154 reference to the version control object | 154 reference to the version control object |
| 155 </dd> | 155 </dd> |
| 156 <dt><i>parent</i></dt> | 156 <dt><i>parent</i> (QObject)</dt> |
| 157 <dd> | 157 <dd> |
| 158 reference to the parent object (QObject) | 158 reference to the parent object |
| 159 </dd> | 159 </dd> |
| 160 </dl> | 160 </dl> |
| 161 <a NAME="VcsStatusMonitorThread._getInfo" ID="VcsStatusMonitorThread._getInfo"></a> | 161 <a NAME="VcsStatusMonitorThread._getInfo" ID="VcsStatusMonitorThread._getInfo"></a> |
| 162 <h4>VcsStatusMonitorThread._getInfo</h4> | 162 <h4>VcsStatusMonitorThread._getInfo</h4> |
| 163 <b>_getInfo</b>(<i></i>) | 163 <b>_getInfo</b>(<i></i>) |
| 206 </ul> | 206 </ul> |
| 207 </p> | 207 </p> |
| 208 <dl> | 208 <dl> |
| 209 <dt>Return:</dt> | 209 <dt>Return:</dt> |
| 210 <dd> | 210 <dd> |
| 211 tuple of flag indicating successful operation (boolean) and | 211 tuple of flag indicating successful operation and |
| 212 a status message in case of non successful operation (string) | 212 a status message in case of non successful operation |
| 213 </dd> | |
| 214 </dl> | |
| 215 <dl> | |
| 216 <dt>Return Type:</dt> | |
| 217 <dd> | |
| 218 tuple of (bool, str) | |
| 213 </dd> | 219 </dd> |
| 214 </dl> | 220 </dl> |
| 215 <dl> | 221 <dl> |
| 216 | 222 |
| 217 <dt>Raises <b>NotImplementedError</b>:</dt> | 223 <dt>Raises <b>NotImplementedError</b>:</dt> |
| 244 <p> | 250 <p> |
| 245 Public method to clear the cached VCS state of a file/directory. | 251 Public method to clear the cached VCS state of a file/directory. |
| 246 </p> | 252 </p> |
| 247 <dl> | 253 <dl> |
| 248 | 254 |
| 249 <dt><i>name</i></dt> | 255 <dt><i>name</i> (str)</dt> |
| 250 <dd> | 256 <dd> |
| 251 name of the entry to be cleared (string) | 257 name of the entry to be cleared |
| 252 </dd> | 258 </dd> |
| 253 </dl> | 259 </dl> |
| 254 <a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a> | 260 <a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a> |
| 255 <h4>VcsStatusMonitorThread.getAutoUpdate</h4> | 261 <h4>VcsStatusMonitorThread.getAutoUpdate</h4> |
| 256 <b>getAutoUpdate</b>(<i></i>) | 262 <b>getAutoUpdate</b>(<i></i>) |
| 259 Public method to retrieve the status of the auto update function. | 265 Public method to retrieve the status of the auto update function. |
| 260 </p> | 266 </p> |
| 261 <dl> | 267 <dl> |
| 262 <dt>Return:</dt> | 268 <dt>Return:</dt> |
| 263 <dd> | 269 <dd> |
| 264 status of the auto update function (boolean) | 270 status of the auto update function |
| 271 </dd> | |
| 272 </dl> | |
| 273 <dl> | |
| 274 <dt>Return Type:</dt> | |
| 275 <dd> | |
| 276 bool | |
| 265 </dd> | 277 </dd> |
| 266 </dl> | 278 </dl> |
| 267 <a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a> | 279 <a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a> |
| 268 <h4>VcsStatusMonitorThread.getInterval</h4> | 280 <h4>VcsStatusMonitorThread.getInterval</h4> |
| 269 <b>getInterval</b>(<i></i>) | 281 <b>getInterval</b>(<i></i>) |
| 272 Public method to get the monitor interval. | 284 Public method to get the monitor interval. |
| 273 </p> | 285 </p> |
| 274 <dl> | 286 <dl> |
| 275 <dt>Return:</dt> | 287 <dt>Return:</dt> |
| 276 <dd> | 288 <dd> |
| 277 interval in seconds (integer) | 289 interval in seconds |
| 290 </dd> | |
| 291 </dl> | |
| 292 <dl> | |
| 293 <dt>Return Type:</dt> | |
| 294 <dd> | |
| 295 int | |
| 278 </dd> | 296 </dd> |
| 279 </dl> | 297 </dl> |
| 280 <a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a> | 298 <a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a> |
| 281 <h4>VcsStatusMonitorThread.run</h4> | 299 <h4>VcsStatusMonitorThread.run</h4> |
| 282 <b>run</b>(<i></i>) | 300 <b>run</b>(<i></i>) |
| 291 <p> | 309 <p> |
| 292 Public method to enable the auto update function. | 310 Public method to enable the auto update function. |
| 293 </p> | 311 </p> |
| 294 <dl> | 312 <dl> |
| 295 | 313 |
| 296 <dt><i>auto</i></dt> | 314 <dt><i>auto</i> (bool)</dt> |
| 297 <dd> | 315 <dd> |
| 298 status of the auto update function (boolean) | 316 status of the auto update function |
| 299 </dd> | 317 </dd> |
| 300 </dl> | 318 </dl> |
| 301 <a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a> | 319 <a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a> |
| 302 <h4>VcsStatusMonitorThread.setInterval</h4> | 320 <h4>VcsStatusMonitorThread.setInterval</h4> |
| 303 <b>setInterval</b>(<i>interval</i>) | 321 <b>setInterval</b>(<i>interval</i>) |
| 305 <p> | 323 <p> |
| 306 Public method to change the monitor interval. | 324 Public method to change the monitor interval. |
| 307 </p> | 325 </p> |
| 308 <dl> | 326 <dl> |
| 309 | 327 |
| 310 <dt><i>interval</i></dt> | 328 <dt><i>interval</i> (int)</dt> |
| 311 <dd> | 329 <dd> |
| 312 new interval in seconds (integer) | 330 new interval in seconds |
| 313 </dd> | 331 </dd> |
| 314 </dl> | 332 </dl> |
| 315 <a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a> | 333 <a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a> |
| 316 <h4>VcsStatusMonitorThread.stop</h4> | 334 <h4>VcsStatusMonitorThread.stop</h4> |
| 317 <b>stop</b>(<i></i>) | 335 <b>stop</b>(<i></i>) |
