5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</h1> |
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the queues extension interface. |
11 Module implementing the queues extension interface. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>None</td></tr> |
16 <tr><td>None</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#Queues">Queues</a></td> |
22 <td><a href="#Queues">Queues</a></td> |
25 <td>Class implementing the queues extension interface.</td> |
23 <td>Class implementing the queues extension interface.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
|
30 <table> |
28 <table> |
31 <tr><td>None</td></tr> |
29 <tr><td>None</td></tr> |
32 </table> |
30 </table> |
|
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="Queues" ID="Queues"></a> |
34 <a NAME="Queues" ID="Queues"></a> |
36 <h2>Queues</h2> |
35 <h2>Queues</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing the queues extension interface. |
37 Class implementing the queues extension interface. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Derived from</h3> |
40 <h3>Derived from</h3> |
42 HgExtension |
41 HgExtension |
43 <h3>Class Attributes</h3> |
42 <h3>Class Attributes</h3> |
44 |
43 <table> |
45 <table> |
44 <tr><td>APPLIED_LIST</td></tr> |
46 <tr><td>APPLIED_LIST</td></tr><tr><td>GOTO</td></tr><tr><td>POP</td></tr><tr><td>PUSH</td></tr><tr><td>QUEUE_ACTIVATE</td></tr><tr><td>QUEUE_DELETE</td></tr><tr><td>QUEUE_PURGE</td></tr><tr><td>SERIES_LIST</td></tr><tr><td>UNAPPLIED_LIST</td></tr> |
45 <tr><td>GOTO</td></tr> |
47 </table> |
46 <tr><td>POP</td></tr> |
|
47 <tr><td>PUSH</td></tr> |
|
48 <tr><td>QUEUE_ACTIVATE</td></tr> |
|
49 <tr><td>QUEUE_DELETE</td></tr> |
|
50 <tr><td>QUEUE_PURGE</td></tr> |
|
51 <tr><td>SERIES_LIST</td></tr> |
|
52 <tr><td>UNAPPLIED_LIST</td></tr> |
|
53 </table> |
|
54 |
48 <h3>Class Methods</h3> |
55 <h3>Class Methods</h3> |
49 |
|
50 <table> |
56 <table> |
51 <tr><td>None</td></tr> |
57 <tr><td>None</td></tr> |
52 </table> |
58 </table> |
|
59 |
53 <h3>Methods</h3> |
60 <h3>Methods</h3> |
54 |
61 <table> |
55 <table> |
|
56 |
|
57 <tr> |
62 <tr> |
58 <td><a href="#Queues.__init__">Queues</a></td> |
63 <td><a href="#Queues.__init__">Queues</a></td> |
59 <td>Constructor</td> |
64 <td>Constructor</td> |
60 </tr> |
65 </tr> |
61 <tr> |
66 <tr> |
165 <tr> |
170 <tr> |
166 <td><a href="#Queues.shutdown">shutdown</a></td> |
171 <td><a href="#Queues.shutdown">shutdown</a></td> |
167 <td>Public method used to shutdown the queues interface.</td> |
172 <td>Public method used to shutdown the queues interface.</td> |
168 </tr> |
173 </tr> |
169 </table> |
174 </table> |
|
175 |
170 <h3>Static Methods</h3> |
176 <h3>Static Methods</h3> |
171 |
|
172 <table> |
177 <table> |
173 <tr><td>None</td></tr> |
178 <tr><td>None</td></tr> |
174 </table> |
179 </table> |
|
180 |
175 |
181 |
176 <a NAME="Queues.__init__" ID="Queues.__init__"></a> |
182 <a NAME="Queues.__init__" ID="Queues.__init__"></a> |
177 <h4>Queues (Constructor)</h4> |
183 <h4>Queues (Constructor)</h4> |
178 <b>Queues</b>(<i>vcs</i>) |
184 <b>Queues</b>(<i>vcs</i>) |
179 |
|
180 <p> |
185 <p> |
181 Constructor |
186 Constructor |
182 </p> |
187 </p> |
|
188 |
183 <dl> |
189 <dl> |
184 |
190 |
185 <dt><i>vcs</i> (Hg)</dt> |
191 <dt><i>vcs</i> (Hg)</dt> |
186 <dd> |
192 <dd> |
187 reference to the Mercurial vcs object |
193 reference to the Mercurial vcs object |
188 </dd> |
194 </dd> |
189 </dl> |
195 </dl> |
190 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a> |
196 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a> |
191 <h4>Queues.__getCommitMessage</h4> |
197 <h4>Queues.__getCommitMessage</h4> |
192 <b>__getCommitMessage</b>(<i></i>) |
198 <b>__getCommitMessage</b>(<i></i>) |
193 |
|
194 <p> |
199 <p> |
195 Private method to get the commit message of the current patch. |
200 Private method to get the commit message of the current patch. |
196 </p> |
201 </p> |
|
202 |
197 <dl> |
203 <dl> |
198 <dt>Return:</dt> |
204 <dt>Return:</dt> |
199 <dd> |
205 <dd> |
200 name of the current patch |
206 name of the current patch |
201 </dd> |
207 </dd> |
290 </dd> |
296 </dd> |
291 </dl> |
297 </dl> |
292 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a> |
298 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a> |
293 <h4>Queues.hgQueueCreateRenameQueue</h4> |
299 <h4>Queues.hgQueueCreateRenameQueue</h4> |
294 <b>hgQueueCreateRenameQueue</b>(<i>isCreate</i>) |
300 <b>hgQueueCreateRenameQueue</b>(<i>isCreate</i>) |
295 |
|
296 <p> |
301 <p> |
297 Public method to create a new queue or rename the active queue. |
302 Public method to create a new queue or rename the active queue. |
298 </p> |
303 </p> |
|
304 |
299 <dl> |
305 <dl> |
300 |
306 |
301 <dt><i>isCreate</i> (bool)</dt> |
307 <dt><i>isCreate</i> (bool)</dt> |
302 <dd> |
308 <dd> |
303 flag indicating to create a new queue |
309 flag indicating to create a new queue |
304 </dd> |
310 </dd> |
305 </dl> |
311 </dl> |
306 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a> |
312 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a> |
307 <h4>Queues.hgQueueDeletePatch</h4> |
313 <h4>Queues.hgQueueDeletePatch</h4> |
308 <b>hgQueueDeletePatch</b>(<i></i>) |
314 <b>hgQueueDeletePatch</b>(<i></i>) |
309 |
|
310 <p> |
315 <p> |
311 Public method to delete a selected unapplied patch. |
316 Public method to delete a selected unapplied patch. |
312 </p> |
317 </p> |
|
318 |
313 <a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a> |
319 <a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a> |
314 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4> |
320 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4> |
315 <b>hgQueueDeletePurgeActivateQueue</b>(<i>operation</i>) |
321 <b>hgQueueDeletePurgeActivateQueue</b>(<i>operation</i>) |
316 |
|
317 <p> |
322 <p> |
318 Public method to delete the reference to a queue and optionally |
323 Public method to delete the reference to a queue and optionally |
319 remove the patch directory or set the active queue. |
324 remove the patch directory or set the active queue. |
320 </p> |
325 </p> |
|
326 |
321 <dl> |
327 <dl> |
322 |
328 |
323 <dt><i>operation</i> (int)</dt> |
329 <dt><i>operation</i> (int)</dt> |
324 <dd> |
330 <dd> |
325 operation to be performed (Queues.QUEUE_DELETE, |
331 operation to be performed (Queues.QUEUE_DELETE, |
334 </dd> |
340 </dd> |
335 </dl> |
341 </dl> |
336 <a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a> |
342 <a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a> |
337 <h4>Queues.hgQueueFinishAppliedPatches</h4> |
343 <h4>Queues.hgQueueFinishAppliedPatches</h4> |
338 <b>hgQueueFinishAppliedPatches</b>(<i></i>) |
344 <b>hgQueueFinishAppliedPatches</b>(<i></i>) |
339 |
|
340 <p> |
345 <p> |
341 Public method to finish all applied patches. |
346 Public method to finish all applied patches. |
342 </p> |
347 </p> |
|
348 |
343 <a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a> |
349 <a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a> |
344 <h4>Queues.hgQueueFoldUnappliedPatches</h4> |
350 <h4>Queues.hgQueueFoldUnappliedPatches</h4> |
345 <b>hgQueueFoldUnappliedPatches</b>(<i></i>) |
351 <b>hgQueueFoldUnappliedPatches</b>(<i></i>) |
346 |
|
347 <p> |
352 <p> |
348 Public method to fold patches into the current patch. |
353 Public method to fold patches into the current patch. |
349 </p> |
354 </p> |
|
355 |
350 <a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a> |
356 <a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a> |
351 <h4>Queues.hgQueueGuardsDeactivate</h4> |
357 <h4>Queues.hgQueueGuardsDeactivate</h4> |
352 <b>hgQueueGuardsDeactivate</b>(<i></i>) |
358 <b>hgQueueGuardsDeactivate</b>(<i></i>) |
353 |
|
354 <p> |
359 <p> |
355 Public method to deactivate all active guards. |
360 Public method to deactivate all active guards. |
356 </p> |
361 </p> |
|
362 |
357 <a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a> |
363 <a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a> |
358 <h4>Queues.hgQueueGuardsDefine</h4> |
364 <h4>Queues.hgQueueGuardsDefine</h4> |
359 <b>hgQueueGuardsDefine</b>(<i></i>) |
365 <b>hgQueueGuardsDefine</b>(<i></i>) |
360 |
|
361 <p> |
366 <p> |
362 Public method to define guards for the current or a named patch. |
367 Public method to define guards for the current or a named patch. |
363 </p> |
368 </p> |
|
369 |
364 <a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a> |
370 <a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a> |
365 <h4>Queues.hgQueueGuardsDropAll</h4> |
371 <h4>Queues.hgQueueGuardsDropAll</h4> |
366 <b>hgQueueGuardsDropAll</b>(<i></i>) |
372 <b>hgQueueGuardsDropAll</b>(<i></i>) |
367 |
|
368 <p> |
373 <p> |
369 Public method to drop all guards of the current or a named patch. |
374 Public method to drop all guards of the current or a named patch. |
370 </p> |
375 </p> |
|
376 |
371 <a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a> |
377 <a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a> |
372 <h4>Queues.hgQueueGuardsIdentifyActive</h4> |
378 <h4>Queues.hgQueueGuardsIdentifyActive</h4> |
373 <b>hgQueueGuardsIdentifyActive</b>(<i></i>) |
379 <b>hgQueueGuardsIdentifyActive</b>(<i></i>) |
374 |
|
375 <p> |
380 <p> |
376 Public method to list all active guards. |
381 Public method to list all active guards. |
377 </p> |
382 </p> |
|
383 |
378 <a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a> |
384 <a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a> |
379 <h4>Queues.hgQueueGuardsList</h4> |
385 <h4>Queues.hgQueueGuardsList</h4> |
380 <b>hgQueueGuardsList</b>(<i></i>) |
386 <b>hgQueueGuardsList</b>(<i></i>) |
381 |
|
382 <p> |
387 <p> |
383 Public method to list the guards for the current or a named patch. |
388 Public method to list the guards for the current or a named patch. |
384 </p> |
389 </p> |
|
390 |
385 <a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a> |
391 <a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a> |
386 <h4>Queues.hgQueueGuardsListAll</h4> |
392 <h4>Queues.hgQueueGuardsListAll</h4> |
387 <b>hgQueueGuardsListAll</b>(<i></i>) |
393 <b>hgQueueGuardsListAll</b>(<i></i>) |
388 |
|
389 <p> |
394 <p> |
390 Public method to list all guards of all patches. |
395 Public method to list all guards of all patches. |
391 </p> |
396 </p> |
|
397 |
392 <a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a> |
398 <a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a> |
393 <h4>Queues.hgQueueGuardsSetActive</h4> |
399 <h4>Queues.hgQueueGuardsSetActive</h4> |
394 <b>hgQueueGuardsSetActive</b>(<i></i>) |
400 <b>hgQueueGuardsSetActive</b>(<i></i>) |
395 |
|
396 <p> |
401 <p> |
397 Public method to set the active guards. |
402 Public method to set the active guards. |
398 </p> |
403 </p> |
|
404 |
399 <a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a> |
405 <a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a> |
400 <h4>Queues.hgQueueInit</h4> |
406 <h4>Queues.hgQueueInit</h4> |
401 <b>hgQueueInit</b>(<i></i>) |
407 <b>hgQueueInit</b>(<i></i>) |
402 |
|
403 <p> |
408 <p> |
404 Public method to initialize a new queue repository. |
409 Public method to initialize a new queue repository. |
405 </p> |
410 </p> |
|
411 |
406 <a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a> |
412 <a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a> |
407 <h4>Queues.hgQueueListPatches</h4> |
413 <h4>Queues.hgQueueListPatches</h4> |
408 <b>hgQueueListPatches</b>(<i></i>) |
414 <b>hgQueueListPatches</b>(<i></i>) |
409 |
|
410 <p> |
415 <p> |
411 Public method to show a list of all patches. |
416 Public method to show a list of all patches. |
412 </p> |
417 </p> |
|
418 |
413 <a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a> |
419 <a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a> |
414 <h4>Queues.hgQueueListQueues</h4> |
420 <h4>Queues.hgQueueListQueues</h4> |
415 <b>hgQueueListQueues</b>(<i></i>) |
421 <b>hgQueueListQueues</b>(<i></i>) |
416 |
|
417 <p> |
422 <p> |
418 Public method to list available queues. |
423 Public method to list available queues. |
419 </p> |
424 </p> |
|
425 |
420 <a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a> |
426 <a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a> |
421 <h4>Queues.hgQueueNewPatch</h4> |
427 <h4>Queues.hgQueueNewPatch</h4> |
422 <b>hgQueueNewPatch</b>(<i></i>) |
428 <b>hgQueueNewPatch</b>(<i></i>) |
423 |
|
424 <p> |
429 <p> |
425 Public method to create a new named patch. |
430 Public method to create a new named patch. |
426 </p> |
431 </p> |
|
432 |
427 <a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a> |
433 <a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a> |
428 <h4>Queues.hgQueuePushPopPatches</h4> |
434 <h4>Queues.hgQueuePushPopPatches</h4> |
429 <b>hgQueuePushPopPatches</b>(<i>operation, doAll=False, named=False, force=False</i>) |
435 <b>hgQueuePushPopPatches</b>(<i>operation, doAll=False, named=False, force=False</i>) |
430 |
|
431 <p> |
436 <p> |
432 Public method to push patches onto the stack or pop patches off the |
437 Public method to push patches onto the stack or pop patches off the |
433 stack. |
438 stack. |
434 </p> |
439 </p> |
|
440 |
435 <dl> |
441 <dl> |
436 |
442 |
437 <dt><i>operation</i> (int)</dt> |
443 <dt><i>operation</i> (int)</dt> |
438 <dd> |
444 <dd> |
439 operation type to be performed (Queues.POP, |
445 operation type to be performed (Queues.POP, |
488 </dd> |
494 </dd> |
489 </dl> |
495 </dl> |
490 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a> |
496 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a> |
491 <h4>Queues.hgQueueRenamePatch</h4> |
497 <h4>Queues.hgQueueRenamePatch</h4> |
492 <b>hgQueueRenamePatch</b>(<i></i>) |
498 <b>hgQueueRenamePatch</b>(<i></i>) |
493 |
|
494 <p> |
499 <p> |
495 Public method to rename the current or a selected patch. |
500 Public method to rename the current or a selected patch. |
496 </p> |
501 </p> |
|
502 |
497 <a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a> |
503 <a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a> |
498 <h4>Queues.hgQueueShowHeader</h4> |
504 <h4>Queues.hgQueueShowHeader</h4> |
499 <b>hgQueueShowHeader</b>(<i></i>) |
505 <b>hgQueueShowHeader</b>(<i></i>) |
500 |
|
501 <p> |
506 <p> |
502 Public method to show the commit message of the current patch. |
507 Public method to show the commit message of the current patch. |
503 </p> |
508 </p> |
|
509 |
504 <a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a> |
510 <a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a> |
505 <h4>Queues.hgQueueShowPatch</h4> |
511 <h4>Queues.hgQueueShowPatch</h4> |
506 <b>hgQueueShowPatch</b>(<i>name</i>) |
512 <b>hgQueueShowPatch</b>(<i>name</i>) |
507 |
|
508 <p> |
513 <p> |
509 Public method to show the contents of the current patch. |
514 Public method to show the contents of the current patch. |
510 </p> |
515 </p> |
|
516 |
511 <dl> |
517 <dl> |
512 |
518 |
513 <dt><i>name</i> (str)</dt> |
519 <dt><i>name</i> (str)</dt> |
514 <dd> |
520 <dd> |
515 file/directory name |
521 file/directory name |
516 </dd> |
522 </dd> |
517 </dl> |
523 </dl> |
518 <a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a> |
524 <a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a> |
519 <h4>Queues.hgQueueStatus</h4> |
525 <h4>Queues.hgQueueStatus</h4> |
520 <b>hgQueueStatus</b>(<i>name</i>) |
526 <b>hgQueueStatus</b>(<i>name</i>) |
521 |
|
522 <p> |
527 <p> |
523 Public method used to view the status of a queue repository. |
528 Public method used to view the status of a queue repository. |
524 </p> |
529 </p> |
|
530 |
525 <dl> |
531 <dl> |
526 |
532 |
527 <dt><i>name</i> (str)</dt> |
533 <dt><i>name</i> (str)</dt> |
528 <dd> |
534 <dd> |
529 directory name |
535 directory name |
530 </dd> |
536 </dd> |
531 </dl> |
537 </dl> |
532 <a NAME="Queues.shutdown" ID="Queues.shutdown"></a> |
538 <a NAME="Queues.shutdown" ID="Queues.shutdown"></a> |
533 <h4>Queues.shutdown</h4> |
539 <h4>Queues.shutdown</h4> |
534 <b>shutdown</b>(<i></i>) |
540 <b>shutdown</b>(<i></i>) |
535 |
|
536 <p> |
541 <p> |
537 Public method used to shutdown the queues interface. |
542 Public method used to shutdown the queues interface. |
538 </p> |
543 </p> |
|
544 |
539 <div align="right"><a href="#top">Up</a></div> |
545 <div align="right"><a href="#top">Up</a></div> |
540 <hr /> |
546 <hr /> |
541 </body></html> |
547 </body></html> |