Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html
- branch
- eric7
- changeset 10438
- 4cd7e5a8b3cf
- parent 10070
- 9f5758c0fec1
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10437:2f70ca07f0af | 10438:4cd7e5a8b3cf |
|---|---|
| 180 <p> | 180 <p> |
| 181 Constructor | 181 Constructor |
| 182 </p> | 182 </p> |
| 183 <dl> | 183 <dl> |
| 184 | 184 |
| 185 <dt><i>vcs</i></dt> | 185 <dt><i>vcs</i> (Hg)</dt> |
| 186 <dd> | 186 <dd> |
| 187 reference to the Mercurial vcs object | 187 reference to the Mercurial vcs object |
| 188 </dd> | 188 </dd> |
| 189 </dl> | 189 </dl> |
| 190 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a> | 190 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a> |
| 195 Private method to get the commit message of the current patch. | 195 Private method to get the commit message of the current patch. |
| 196 </p> | 196 </p> |
| 197 <dl> | 197 <dl> |
| 198 <dt>Return:</dt> | 198 <dt>Return:</dt> |
| 199 <dd> | 199 <dd> |
| 200 name of the current patch (string) | 200 name of the current patch |
| 201 </dd> | |
| 202 </dl> | |
| 203 <dl> | |
| 204 <dt>Return Type:</dt> | |
| 205 <dd> | |
| 206 str | |
| 201 </dd> | 207 </dd> |
| 202 </dl> | 208 </dl> |
| 203 <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a> | 209 <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a> |
| 204 <h4>Queues.__getCurrentPatch</h4> | 210 <h4>Queues.__getCurrentPatch</h4> |
| 205 <b>__getCurrentPatch</b>(<i></i>) | 211 <b>__getCurrentPatch</b>(<i></i>) |
| 208 Private method to get the name of the current patch. | 214 Private method to get the name of the current patch. |
| 209 </p> | 215 </p> |
| 210 <dl> | 216 <dl> |
| 211 <dt>Return:</dt> | 217 <dt>Return:</dt> |
| 212 <dd> | 218 <dd> |
| 213 name of the current patch (string) | 219 name of the current patch |
| 220 </dd> | |
| 221 </dl> | |
| 222 <dl> | |
| 223 <dt>Return Type:</dt> | |
| 224 <dd> | |
| 225 str | |
| 214 </dd> | 226 </dd> |
| 215 </dl> | 227 </dl> |
| 216 <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a> | 228 <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a> |
| 217 <h4>Queues.__getPatchesList</h4> | 229 <h4>Queues.__getPatchesList</h4> |
| 218 <b>__getPatchesList</b>(<i>listType, withSummary=False</i>) | 230 <b>__getPatchesList</b>(<i>listType, withSummary=False</i>) |
| 220 <p> | 232 <p> |
| 221 Private method to get a list of patches of a given type. | 233 Private method to get a list of patches of a given type. |
| 222 </p> | 234 </p> |
| 223 <dl> | 235 <dl> |
| 224 | 236 |
| 225 <dt><i>listType</i></dt> | 237 <dt><i>listType</i> (int)</dt> |
| 226 <dd> | 238 <dd> |
| 227 type of patches list to get | 239 type of patches list to get |
| 228 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST) | 240 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST) |
| 229 </dd> | 241 </dd> |
| 230 <dt><i>withSummary</i></dt> | 242 <dt><i>withSummary</i> (bool)</dt> |
| 231 <dd> | 243 <dd> |
| 232 flag indicating to get a summary as well (boolean) | 244 flag indicating to get a summary as well |
| 233 </dd> | 245 </dd> |
| 234 </dl> | 246 </dl> |
| 235 <dl> | 247 <dl> |
| 236 <dt>Return:</dt> | 248 <dt>Return:</dt> |
| 237 <dd> | 249 <dd> |
| 238 list of patches (list of string) | 250 list of patches |
| 251 </dd> | |
| 252 </dl> | |
| 253 <dl> | |
| 254 <dt>Return Type:</dt> | |
| 255 <dd> | |
| 256 list of str | |
| 239 </dd> | 257 </dd> |
| 240 </dl> | 258 </dl> |
| 241 <dl> | 259 <dl> |
| 242 | 260 |
| 243 <dt>Raises <b>ValueError</b>:</dt> | 261 <dt>Raises <b>ValueError</b>:</dt> |
| 252 <p> | 270 <p> |
| 253 Public method to get a list of all guards defined. | 271 Public method to get a list of all guards defined. |
| 254 </p> | 272 </p> |
| 255 <dl> | 273 <dl> |
| 256 | 274 |
| 257 <dt><i>allGuards</i></dt> | 275 <dt><i>allGuards</i> (bool)</dt> |
| 258 <dd> | 276 <dd> |
| 259 flag indicating to get all guards (boolean) | 277 flag indicating to get all guards |
| 260 </dd> | 278 </dd> |
| 261 </dl> | 279 </dl> |
| 262 <dl> | 280 <dl> |
| 263 <dt>Return:</dt> | 281 <dt>Return:</dt> |
| 264 <dd> | 282 <dd> |
| 265 sorted list of guards (list of strings) | 283 sorted list of guards |
| 284 </dd> | |
| 285 </dl> | |
| 286 <dl> | |
| 287 <dt>Return Type:</dt> | |
| 288 <dd> | |
| 289 list of str | |
| 266 </dd> | 290 </dd> |
| 267 </dl> | 291 </dl> |
| 268 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a> | 292 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a> |
| 269 <h4>Queues.hgQueueCreateRenameQueue</h4> | 293 <h4>Queues.hgQueueCreateRenameQueue</h4> |
| 270 <b>hgQueueCreateRenameQueue</b>(<i>isCreate</i>) | 294 <b>hgQueueCreateRenameQueue</b>(<i>isCreate</i>) |
| 272 <p> | 296 <p> |
| 273 Public method to create a new queue or rename the active queue. | 297 Public method to create a new queue or rename the active queue. |
| 274 </p> | 298 </p> |
| 275 <dl> | 299 <dl> |
| 276 | 300 |
| 277 <dt><i>isCreate</i></dt> | 301 <dt><i>isCreate</i> (bool)</dt> |
| 278 <dd> | 302 <dd> |
| 279 flag indicating to create a new queue (boolean) | 303 flag indicating to create a new queue |
| 280 </dd> | 304 </dd> |
| 281 </dl> | 305 </dl> |
| 282 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a> | 306 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a> |
| 283 <h4>Queues.hgQueueDeletePatch</h4> | 307 <h4>Queues.hgQueueDeletePatch</h4> |
| 284 <b>hgQueueDeletePatch</b>(<i></i>) | 308 <b>hgQueueDeletePatch</b>(<i></i>) |
| 294 Public method to delete the reference to a queue and optionally | 318 Public method to delete the reference to a queue and optionally |
| 295 remove the patch directory or set the active queue. | 319 remove the patch directory or set the active queue. |
| 296 </p> | 320 </p> |
| 297 <dl> | 321 <dl> |
| 298 | 322 |
| 299 <dt><i>operation</i></dt> | 323 <dt><i>operation</i> (int)</dt> |
| 300 <dd> | 324 <dd> |
| 301 operation to be performed (Queues.QUEUE_DELETE, | 325 operation to be performed (Queues.QUEUE_DELETE, |
| 302 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE) | 326 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE) |
| 303 </dd> | 327 </dd> |
| 304 </dl> | 328 </dl> |
| 408 Public method to push patches onto the stack or pop patches off the | 432 Public method to push patches onto the stack or pop patches off the |
| 409 stack. | 433 stack. |
| 410 </p> | 434 </p> |
| 411 <dl> | 435 <dl> |
| 412 | 436 |
| 413 <dt><i>operation</i></dt> | 437 <dt><i>operation</i> (int)</dt> |
| 414 <dd> | 438 <dd> |
| 415 operation type to be performed (Queues.POP, | 439 operation type to be performed (Queues.POP, |
| 416 Queues.PUSH, Queues.GOTO) | 440 Queues.PUSH, Queues.GOTO) |
| 417 </dd> | 441 </dd> |
| 418 <dt><i>doAll</i></dt> | 442 <dt><i>doAll</i> (bool)</dt> |
| 419 <dd> | 443 <dd> |
| 420 flag indicating to push/pop all (boolean) | 444 flag indicating to push/pop all |
| 421 </dd> | 445 </dd> |
| 422 <dt><i>named</i></dt> | 446 <dt><i>named</i> (bool)</dt> |
| 423 <dd> | 447 <dd> |
| 424 flag indicating to push/pop until a named patch | 448 flag indicating to push/pop until a named patch |
| 425 is at the top of the stack (boolean) | 449 is at the top of the stack |
| 426 </dd> | 450 </dd> |
| 427 <dt><i>force</i></dt> | 451 <dt><i>force</i> (bool)</dt> |
| 428 <dd> | 452 <dd> |
| 429 flag indicating a forceful pop (boolean) | 453 flag indicating a forceful pop |
| 430 </dd> | 454 </dd> |
| 431 </dl> | 455 </dl> |
| 432 <dl> | 456 <dl> |
| 433 <dt>Return:</dt> | 457 <dt>Return:</dt> |
| 434 <dd> | 458 <dd> |
| 435 flag indicating that the project should be reread (boolean) | 459 flag indicating that the project should be reread |
| 460 </dd> | |
| 461 </dl> | |
| 462 <dl> | |
| 463 <dt>Return Type:</dt> | |
| 464 <dd> | |
| 465 bool | |
| 436 </dd> | 466 </dd> |
| 437 </dl> | 467 </dl> |
| 438 <dl> | 468 <dl> |
| 439 | 469 |
| 440 <dt>Raises <b>ValueError</b>:</dt> | 470 <dt>Raises <b>ValueError</b>:</dt> |
| 449 <p> | 479 <p> |
| 450 Public method to refresh the current patch. | 480 Public method to refresh the current patch. |
| 451 </p> | 481 </p> |
| 452 <dl> | 482 <dl> |
| 453 | 483 |
| 454 <dt><i>editMessage</i></dt> | 484 <dt><i>editMessage</i> (bool)</dt> |
| 455 <dd> | 485 <dd> |
| 456 flag indicating to edit the current | 486 flag indicating to edit the current |
| 457 commit message (boolean) | 487 commit message |
| 458 </dd> | 488 </dd> |
| 459 </dl> | 489 </dl> |
| 460 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a> | 490 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a> |
| 461 <h4>Queues.hgQueueRenamePatch</h4> | 491 <h4>Queues.hgQueueRenamePatch</h4> |
| 462 <b>hgQueueRenamePatch</b>(<i></i>) | 492 <b>hgQueueRenamePatch</b>(<i></i>) |
| 478 <p> | 508 <p> |
| 479 Public method to show the contents of the current patch. | 509 Public method to show the contents of the current patch. |
| 480 </p> | 510 </p> |
| 481 <dl> | 511 <dl> |
| 482 | 512 |
| 483 <dt><i>name</i></dt> | 513 <dt><i>name</i> (str)</dt> |
| 484 <dd> | 514 <dd> |
| 485 file/directory name (string) | 515 file/directory name |
| 486 </dd> | 516 </dd> |
| 487 </dl> | 517 </dl> |
| 488 <a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a> | 518 <a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a> |
| 489 <h4>Queues.hgQueueStatus</h4> | 519 <h4>Queues.hgQueueStatus</h4> |
| 490 <b>hgQueueStatus</b>(<i>name</i>) | 520 <b>hgQueueStatus</b>(<i>name</i>) |
| 492 <p> | 522 <p> |
| 493 Public method used to view the status of a queue repository. | 523 Public method used to view the status of a queue repository. |
| 494 </p> | 524 </p> |
| 495 <dl> | 525 <dl> |
| 496 | 526 |
| 497 <dt><i>name</i></dt> | 527 <dt><i>name</i> (str)</dt> |
| 498 <dd> | 528 <dd> |
| 499 directory name (string) | 529 directory name |
| 500 </dd> | 530 </dd> |
| 501 </dl> | 531 </dl> |
| 502 <a NAME="Queues.shutdown" ID="Queues.shutdown"></a> | 532 <a NAME="Queues.shutdown" ID="Queues.shutdown"></a> |
| 503 <h4>Queues.shutdown</h4> | 533 <h4>Queues.shutdown</h4> |
| 504 <b>shutdown</b>(<i></i>) | 534 <b>shutdown</b>(<i></i>) |
