src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html

branch
eric7
changeset 10493
f795d68d8e09
parent 10479
856476537696
child 11006
a671918232f3
equal deleted inserted replaced
10492:53eac4c7d10b 10493:f795d68d8e09
17 </table> 17 </table>
18 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 <table> 20 <table>
21 <tr> 21 <tr>
22 <td><a href="#QueueOperation">QueueOperation</a></td>
23 <td>Class defining the supported queue operations.</td>
24 </tr>
25 <tr>
26 <td><a href="#QueuePatchesListType">QueuePatchesListType</a></td>
27 <td>Class defining the supported queue patch list types.</td>
28 </tr>
29 <tr>
22 <td><a href="#Queues">Queues</a></td> 30 <td><a href="#Queues">Queues</a></td>
23 <td>Class implementing the queues extension interface.</td> 31 <td>Class implementing the queues extension interface.</td>
24 </tr> 32 </tr>
25 </table> 33 </table>
26 34
27 <h3>Functions</h3> 35 <h3>Functions</h3>
28 <table> 36 <table>
29 <tr><td>None</td></tr> 37 <tr><td>None</td></tr>
30 </table> 38 </table>
31 39
40 <hr />
41 <hr />
42 <a NAME="QueueOperation" ID="QueueOperation"></a>
43 <h2>QueueOperation</h2>
44 <p>
45 Class defining the supported queue operations.
46 </p>
47
48 <h3>Derived from</h3>
49 enum.Enum
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>ACTIVATE</td></tr>
53 <tr><td>DELETE</td></tr>
54 <tr><td>GOTO</td></tr>
55 <tr><td>POP</td></tr>
56 <tr><td>PURGE</td></tr>
57 <tr><td>PUSH</td></tr>
58 </table>
59
60 <h3>Class Methods</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64
65 <h3>Methods</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69
70 <h3>Static Methods</h3>
71 <table>
72 <tr><td>None</td></tr>
73 </table>
74
75
76 <div align="right"><a href="#top">Up</a></div>
77 <hr />
78 <hr />
79 <a NAME="QueuePatchesListType" ID="QueuePatchesListType"></a>
80 <h2>QueuePatchesListType</h2>
81 <p>
82 Class defining the supported queue patch list types.
83 </p>
84
85 <h3>Derived from</h3>
86 enum.Enum
87 <h3>Class Attributes</h3>
88 <table>
89 <tr><td>APPLIED</td></tr>
90 <tr><td>SERIES</td></tr>
91 <tr><td>UNAPPLIED</td></tr>
92 </table>
93
94 <h3>Class Methods</h3>
95 <table>
96 <tr><td>None</td></tr>
97 </table>
98
99 <h3>Methods</h3>
100 <table>
101 <tr><td>None</td></tr>
102 </table>
103
104 <h3>Static Methods</h3>
105 <table>
106 <tr><td>None</td></tr>
107 </table>
108
109
110 <div align="right"><a href="#top">Up</a></div>
32 <hr /> 111 <hr />
33 <hr /> 112 <hr />
34 <a NAME="Queues" ID="Queues"></a> 113 <a NAME="Queues" ID="Queues"></a>
35 <h2>Queues</h2> 114 <h2>Queues</h2>
36 <p> 115 <p>
39 118
40 <h3>Derived from</h3> 119 <h3>Derived from</h3>
41 HgExtension 120 HgExtension
42 <h3>Class Attributes</h3> 121 <h3>Class Attributes</h3>
43 <table> 122 <table>
44 <tr><td>APPLIED_LIST</td></tr> 123 <tr><td>None</td></tr>
45 <tr><td>GOTO</td></tr>
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> 124 </table>
54 125
55 <h3>Class Methods</h3> 126 <h3>Class Methods</h3>
56 <table> 127 <table>
57 <tr><td>None</td></tr> 128 <tr><td>None</td></tr>
238 Private method to get a list of patches of a given type. 309 Private method to get a list of patches of a given type.
239 </p> 310 </p>
240 311
241 <dl> 312 <dl>
242 313
243 <dt><i>listType</i> (int)</dt> 314 <dt><i>listType</i> (QueuePatchesListType)</dt>
244 <dd> 315 <dd>
245 type of patches list to get 316 type of patches list to get
246 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST)
247 </dd> 317 </dd>
248 <dt><i>withSummary</i> (bool)</dt> 318 <dt><i>withSummary</i> (bool)</dt>
249 <dd> 319 <dd>
250 flag indicating to get a summary as well 320 flag indicating to get a summary as well
251 </dd> 321 </dd>
324 remove the patch directory or set the active queue. 394 remove the patch directory or set the active queue.
325 </p> 395 </p>
326 396
327 <dl> 397 <dl>
328 398
329 <dt><i>operation</i> (int)</dt> 399 <dt><i>operation</i> (QueueOperation)</dt>
330 <dd> 400 <dd>
331 operation to be performed (Queues.QUEUE_DELETE, 401 operation to be performed (PURGE, DELETE or ACTIVATE)
332 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE)
333 </dd> 402 </dd>
334 </dl> 403 </dl>
335 <dl> 404 <dl>
336 405
337 <dt>Raises <b>ValueError</b>:</dt> 406 <dt>Raises <b>ValueError</b>:</dt>
438 stack. 507 stack.
439 </p> 508 </p>
440 509
441 <dl> 510 <dl>
442 511
443 <dt><i>operation</i> (int)</dt> 512 <dt><i>operation</i> (QueueOperation)</dt>
444 <dd> 513 <dd>
445 operation type to be performed (Queues.POP, 514 operation to be performed (POP, PUSH or GOTO)
446 Queues.PUSH, Queues.GOTO)
447 </dd> 515 </dd>
448 <dt><i>doAll</i> (bool)</dt> 516 <dt><i>doAll</i> (bool)</dt>
449 <dd> 517 <dd>
450 flag indicating to push/pop all 518 flag indicating to push/pop all
451 </dd> 519 </dd>

eric ide

mercurial