Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the output of the hg status command
27 process.
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#HgStatusDialog">HgStatusDialog</a></td>
40 <td>Class implementing a dialog to show the output of the hg status command process.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr />
49 <hr />
50 <a NAME="HgStatusDialog" ID="HgStatusDialog"></a>
51 <h2>HgStatusDialog</h2>
52
53 <p>
54 Class implementing a dialog to show the output of the hg status command
55 process.
56 </p>
57 <h3>Derived from</h3>
58 QWidget, Ui_HgStatusDialog
59 <h3>Class Attributes</h3>
60
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Class Methods</h3>
65
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70
71 <table>
72
73 <tr>
74 <td><a href="#HgStatusDialog.__init__">HgStatusDialog</a></td>
75 <td>Constructor</td>
76 </tr>
77 <tr>
78 <td><a href="#HgStatusDialog.__abortMerge">__abortMerge</a></td>
79 <td>Private slot used to abort an uncommitted merge.</td>
80 </tr>
81 <tr>
82 <td><a href="#HgStatusDialog.__add">__add</a></td>
83 <td>Private slot to handle the Add context menu entry.</td>
84 </tr>
85 <tr>
86 <td><a href="#HgStatusDialog.__commit">__commit</a></td>
87 <td>Private slot to handle the Commit context menu entry.</td>
88 </tr>
89 <tr>
90 <td><a href="#HgStatusDialog.__commitDeselectAll">__commitDeselectAll</a></td>
91 <td>Private slot to deselect all entries from commit.</td>
92 </tr>
93 <tr>
94 <td><a href="#HgStatusDialog.__commitMerge">__commitMerge</a></td>
95 <td>Private slot to handle the Commit Merge context menu entry.</td>
96 </tr>
97 <tr>
98 <td><a href="#HgStatusDialog.__commitSelect">__commitSelect</a></td>
99 <td>Private slot to select or deselect all entries.</td>
100 </tr>
101 <tr>
102 <td><a href="#HgStatusDialog.__commitSelectAll">__commitSelectAll</a></td>
103 <td>Private slot to select all entries for commit.</td>
104 </tr>
105 <tr>
106 <td><a href="#HgStatusDialog.__committed">__committed</a></td>
107 <td>Private slot called after the commit has finished.</td>
108 </tr>
109 <tr>
110 <td><a href="#HgStatusDialog.__diff">__diff</a></td>
111 <td>Private slot to handle the Diff context menu entry.</td>
112 </tr>
113 <tr>
114 <td><a href="#HgStatusDialog.__finish">__finish</a></td>
115 <td>Private slot called when the process finished or the user pressed the button.</td>
116 </tr>
117 <tr>
118 <td><a href="#HgStatusDialog.__forget">__forget</a></td>
119 <td>Private slot to handle the Remove context menu entry.</td>
120 </tr>
121 <tr>
122 <td><a href="#HgStatusDialog.__generateDiffs">__generateDiffs</a></td>
123 <td>Private slot to generate diff outputs for the selected item.</td>
124 </tr>
125 <tr>
126 <td><a href="#HgStatusDialog.__generateItem">__generateItem</a></td>
127 <td>Private method to generate a status item in the status list.</td>
128 </tr>
129 <tr>
130 <td><a href="#HgStatusDialog.__generatorFinished">__generatorFinished</a></td>
131 <td>Private slot connected to the finished signal of the diff generator.</td>
132 </tr>
133 <tr>
134 <td><a href="#HgStatusDialog.__getCommitableItems">__getCommitableItems</a></td>
135 <td>Private method to retrieve all entries the user wants to commit.</td>
136 </tr>
137 <tr>
138 <td><a href="#HgStatusDialog.__getCommitableUnselectedItems">__getCommitableUnselectedItems</a></td>
139 <td>Private method to retrieve all entries the user may commit but hasn't selected.</td>
140 </tr>
141 <tr>
142 <td><a href="#HgStatusDialog.__getMissingItems">__getMissingItems</a></td>
143 <td>Private method to retrieve all entries, that have a missing status.</td>
144 </tr>
145 <tr>
146 <td><a href="#HgStatusDialog.__getModifiedItems">__getModifiedItems</a></td>
147 <td>Private method to retrieve all entries, that have a modified status.</td>
148 </tr>
149 <tr>
150 <td><a href="#HgStatusDialog.__getUnversionedItems">__getUnversionedItems</a></td>
151 <td>Private method to retrieve all entries, that have an unversioned status.</td>
152 </tr>
153 <tr>
154 <td><a href="#HgStatusDialog.__initActionsMenu">__initActionsMenu</a></td>
155 <td>Private method to initialize the actions menu.</td>
156 </tr>
157 <tr>
158 <td><a href="#HgStatusDialog.__lfAdd">__lfAdd</a></td>
159 <td>Private slot to add a file to the repository.</td>
160 </tr>
161 <tr>
162 <td><a href="#HgStatusDialog.__processOutputLine">__processOutputLine</a></td>
163 <td>Private method to process the lines of output.</td>
164 </tr>
165 <tr>
166 <td><a href="#HgStatusDialog.__refreshDiff">__refreshDiff</a></td>
167 <td>Private method to refresh the diff output after a refresh.</td>
168 </tr>
169 <tr>
170 <td><a href="#HgStatusDialog.__resizeColumns">__resizeColumns</a></td>
171 <td>Private method to resize the list columns.</td>
172 </tr>
173 <tr>
174 <td><a href="#HgStatusDialog.__resort">__resort</a></td>
175 <td>Private method to resort the tree.</td>
176 </tr>
177 <tr>
178 <td><a href="#HgStatusDialog.__restoreMissing">__restoreMissing</a></td>
179 <td>Private slot to handle the Restore Missing context menu entry.</td>
180 </tr>
181 <tr>
182 <td><a href="#HgStatusDialog.__revert">__revert</a></td>
183 <td>Private slot to handle the Revert context menu entry.</td>
184 </tr>
185 <tr>
186 <td><a href="#HgStatusDialog.__sbsDiff">__sbsDiff</a></td>
187 <td>Private slot to handle the Diff context menu entry.</td>
188 </tr>
189 <tr>
190 <td><a href="#HgStatusDialog.__showActionsMenu">__showActionsMenu</a></td>
191 <td>Private slot to prepare the actions button menu before it is shown.</td>
192 </tr>
193 <tr>
194 <td><a href="#HgStatusDialog.__showError">__showError</a></td>
195 <td>Private slot to show some error.</td>
196 </tr>
197 <tr>
198 <td><a href="#HgStatusDialog.closeEvent">closeEvent</a></td>
199 <td>Protected slot implementing a close event handler.</td>
200 </tr>
201 <tr>
202 <td><a href="#HgStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
203 <td>Private slot called by a button of the button box clicked.</td>
204 </tr>
205 <tr>
206 <td><a href="#HgStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
207 <td>Private slot to refresh the status display.</td>
208 </tr>
209 <tr>
210 <td><a href="#HgStatusDialog.on_statusFilterCombo_activated">on_statusFilterCombo_activated</a></td>
211 <td>Private slot to react to the selection of a status filter.</td>
212 </tr>
213 <tr>
214 <td><a href="#HgStatusDialog.on_statusList_itemSelectionChanged">on_statusList_itemSelectionChanged</a></td>
215 <td>Private slot to act upon changes of selected items.</td>
216 </tr>
217 <tr>
218 <td><a href="#HgStatusDialog.show">show</a></td>
219 <td>Public slot to show the dialog.</td>
220 </tr>
221 <tr>
222 <td><a href="#HgStatusDialog.start">start</a></td>
223 <td>Public slot to start the hg status command.</td>
224 </tr>
225 </table>
226 <h3>Static Methods</h3>
227
228 <table>
229 <tr><td>None</td></tr>
230 </table>
231
232 <a NAME="HgStatusDialog.__init__" ID="HgStatusDialog.__init__"></a>
233 <h4>HgStatusDialog (Constructor)</h4>
234 <b>HgStatusDialog</b>(<i>vcs, mq=False, parent=None</i>)
235
236 <p>
237 Constructor
238 </p>
239 <dl>
240
241 <dt><i>vcs</i></dt>
242 <dd>
243 reference to the vcs object
244 </dd>
245 <dt><i>mq</i></dt>
246 <dd>
247 flag indicating to show a queue repo status (boolean)
248 </dd>
249 <dt><i>parent</i></dt>
250 <dd>
251 parent widget (QWidget)
252 </dd>
253 </dl>
254 <a NAME="HgStatusDialog.__abortMerge" ID="HgStatusDialog.__abortMerge"></a>
255 <h4>HgStatusDialog.__abortMerge</h4>
256 <b>__abortMerge</b>(<i></i>)
257
258 <p>
259 Private slot used to abort an uncommitted merge.
260 </p>
261 <a NAME="HgStatusDialog.__add" ID="HgStatusDialog.__add"></a>
262 <h4>HgStatusDialog.__add</h4>
263 <b>__add</b>(<i></i>)
264
265 <p>
266 Private slot to handle the Add context menu entry.
267 </p>
268 <a NAME="HgStatusDialog.__commit" ID="HgStatusDialog.__commit"></a>
269 <h4>HgStatusDialog.__commit</h4>
270 <b>__commit</b>(<i></i>)
271
272 <p>
273 Private slot to handle the Commit context menu entry.
274 </p>
275 <a NAME="HgStatusDialog.__commitDeselectAll" ID="HgStatusDialog.__commitDeselectAll"></a>
276 <h4>HgStatusDialog.__commitDeselectAll</h4>
277 <b>__commitDeselectAll</b>(<i></i>)
278
279 <p>
280 Private slot to deselect all entries from commit.
281 </p>
282 <a NAME="HgStatusDialog.__commitMerge" ID="HgStatusDialog.__commitMerge"></a>
283 <h4>HgStatusDialog.__commitMerge</h4>
284 <b>__commitMerge</b>(<i></i>)
285
286 <p>
287 Private slot to handle the Commit Merge context menu entry.
288 </p>
289 <a NAME="HgStatusDialog.__commitSelect" ID="HgStatusDialog.__commitSelect"></a>
290 <h4>HgStatusDialog.__commitSelect</h4>
291 <b>__commitSelect</b>(<i>selected</i>)
292
293 <p>
294 Private slot to select or deselect all entries.
295 </p>
296 <dl>
297
298 <dt><i>selected</i></dt>
299 <dd>
300 commit selection state to be set (boolean)
301 </dd>
302 </dl>
303 <a NAME="HgStatusDialog.__commitSelectAll" ID="HgStatusDialog.__commitSelectAll"></a>
304 <h4>HgStatusDialog.__commitSelectAll</h4>
305 <b>__commitSelectAll</b>(<i></i>)
306
307 <p>
308 Private slot to select all entries for commit.
309 </p>
310 <a NAME="HgStatusDialog.__committed" ID="HgStatusDialog.__committed"></a>
311 <h4>HgStatusDialog.__committed</h4>
312 <b>__committed</b>(<i></i>)
313
314 <p>
315 Private slot called after the commit has finished.
316 </p>
317 <a NAME="HgStatusDialog.__diff" ID="HgStatusDialog.__diff"></a>
318 <h4>HgStatusDialog.__diff</h4>
319 <b>__diff</b>(<i></i>)
320
321 <p>
322 Private slot to handle the Diff context menu entry.
323 </p>
324 <a NAME="HgStatusDialog.__finish" ID="HgStatusDialog.__finish"></a>
325 <h4>HgStatusDialog.__finish</h4>
326 <b>__finish</b>(<i></i>)
327
328 <p>
329 Private slot called when the process finished or the user pressed
330 the button.
331 </p>
332 <a NAME="HgStatusDialog.__forget" ID="HgStatusDialog.__forget"></a>
333 <h4>HgStatusDialog.__forget</h4>
334 <b>__forget</b>(<i></i>)
335
336 <p>
337 Private slot to handle the Remove context menu entry.
338 </p>
339 <a NAME="HgStatusDialog.__generateDiffs" ID="HgStatusDialog.__generateDiffs"></a>
340 <h4>HgStatusDialog.__generateDiffs</h4>
341 <b>__generateDiffs</b>(<i></i>)
342
343 <p>
344 Private slot to generate diff outputs for the selected item.
345 </p>
346 <a NAME="HgStatusDialog.__generateItem" ID="HgStatusDialog.__generateItem"></a>
347 <h4>HgStatusDialog.__generateItem</h4>
348 <b>__generateItem</b>(<i>status, path</i>)
349
350 <p>
351 Private method to generate a status item in the status list.
352 </p>
353 <dl>
354
355 <dt><i>status</i></dt>
356 <dd>
357 status indicator (string)
358 </dd>
359 <dt><i>path</i></dt>
360 <dd>
361 path of the file or directory (string)
362 </dd>
363 </dl>
364 <a NAME="HgStatusDialog.__generatorFinished" ID="HgStatusDialog.__generatorFinished"></a>
365 <h4>HgStatusDialog.__generatorFinished</h4>
366 <b>__generatorFinished</b>(<i></i>)
367
368 <p>
369 Private slot connected to the finished signal of the diff generator.
370 </p>
371 <a NAME="HgStatusDialog.__getCommitableItems" ID="HgStatusDialog.__getCommitableItems"></a>
372 <h4>HgStatusDialog.__getCommitableItems</h4>
373 <b>__getCommitableItems</b>(<i></i>)
374
375 <p>
376 Private method to retrieve all entries the user wants to commit.
377 </p>
378 <dl>
379 <dt>Return:</dt>
380 <dd>
381 list of all items, the user has checked
382 </dd>
383 </dl>
384 <a NAME="HgStatusDialog.__getCommitableUnselectedItems" ID="HgStatusDialog.__getCommitableUnselectedItems"></a>
385 <h4>HgStatusDialog.__getCommitableUnselectedItems</h4>
386 <b>__getCommitableUnselectedItems</b>(<i></i>)
387
388 <p>
389 Private method to retrieve all entries the user may commit but hasn't
390 selected.
391 </p>
392 <dl>
393 <dt>Return:</dt>
394 <dd>
395 list of all items, the user has checked
396 </dd>
397 </dl>
398 <a NAME="HgStatusDialog.__getMissingItems" ID="HgStatusDialog.__getMissingItems"></a>
399 <h4>HgStatusDialog.__getMissingItems</h4>
400 <b>__getMissingItems</b>(<i></i>)
401
402 <p>
403 Private method to retrieve all entries, that have a missing status.
404 </p>
405 <dl>
406 <dt>Return:</dt>
407 <dd>
408 list of all items with a missing status
409 </dd>
410 </dl>
411 <a NAME="HgStatusDialog.__getModifiedItems" ID="HgStatusDialog.__getModifiedItems"></a>
412 <h4>HgStatusDialog.__getModifiedItems</h4>
413 <b>__getModifiedItems</b>(<i></i>)
414
415 <p>
416 Private method to retrieve all entries, that have a modified status.
417 </p>
418 <dl>
419 <dt>Return:</dt>
420 <dd>
421 list of all items with a modified status
422 </dd>
423 </dl>
424 <a NAME="HgStatusDialog.__getUnversionedItems" ID="HgStatusDialog.__getUnversionedItems"></a>
425 <h4>HgStatusDialog.__getUnversionedItems</h4>
426 <b>__getUnversionedItems</b>(<i></i>)
427
428 <p>
429 Private method to retrieve all entries, that have an unversioned
430 status.
431 </p>
432 <dl>
433 <dt>Return:</dt>
434 <dd>
435 list of all items with an unversioned status
436 </dd>
437 </dl>
438 <a NAME="HgStatusDialog.__initActionsMenu" ID="HgStatusDialog.__initActionsMenu"></a>
439 <h4>HgStatusDialog.__initActionsMenu</h4>
440 <b>__initActionsMenu</b>(<i></i>)
441
442 <p>
443 Private method to initialize the actions menu.
444 </p>
445 <a NAME="HgStatusDialog.__lfAdd" ID="HgStatusDialog.__lfAdd"></a>
446 <h4>HgStatusDialog.__lfAdd</h4>
447 <b>__lfAdd</b>(<i>mode</i>)
448
449 <p>
450 Private slot to add a file to the repository.
451 </p>
452 <dl>
453
454 <dt><i>mode</i></dt>
455 <dd>
456 add mode (string one of 'normal' or 'large')
457 </dd>
458 </dl>
459 <a NAME="HgStatusDialog.__processOutputLine" ID="HgStatusDialog.__processOutputLine"></a>
460 <h4>HgStatusDialog.__processOutputLine</h4>
461 <b>__processOutputLine</b>(<i>line</i>)
462
463 <p>
464 Private method to process the lines of output.
465 </p>
466 <dl>
467
468 <dt><i>line</i></dt>
469 <dd>
470 output line to be processed (string)
471 </dd>
472 </dl>
473 <a NAME="HgStatusDialog.__refreshDiff" ID="HgStatusDialog.__refreshDiff"></a>
474 <h4>HgStatusDialog.__refreshDiff</h4>
475 <b>__refreshDiff</b>(<i></i>)
476
477 <p>
478 Private method to refresh the diff output after a refresh.
479 </p>
480 <a NAME="HgStatusDialog.__resizeColumns" ID="HgStatusDialog.__resizeColumns"></a>
481 <h4>HgStatusDialog.__resizeColumns</h4>
482 <b>__resizeColumns</b>(<i></i>)
483
484 <p>
485 Private method to resize the list columns.
486 </p>
487 <a NAME="HgStatusDialog.__resort" ID="HgStatusDialog.__resort"></a>
488 <h4>HgStatusDialog.__resort</h4>
489 <b>__resort</b>(<i></i>)
490
491 <p>
492 Private method to resort the tree.
493 </p>
494 <a NAME="HgStatusDialog.__restoreMissing" ID="HgStatusDialog.__restoreMissing"></a>
495 <h4>HgStatusDialog.__restoreMissing</h4>
496 <b>__restoreMissing</b>(<i></i>)
497
498 <p>
499 Private slot to handle the Restore Missing context menu entry.
500 </p>
501 <a NAME="HgStatusDialog.__revert" ID="HgStatusDialog.__revert"></a>
502 <h4>HgStatusDialog.__revert</h4>
503 <b>__revert</b>(<i></i>)
504
505 <p>
506 Private slot to handle the Revert context menu entry.
507 </p>
508 <a NAME="HgStatusDialog.__sbsDiff" ID="HgStatusDialog.__sbsDiff"></a>
509 <h4>HgStatusDialog.__sbsDiff</h4>
510 <b>__sbsDiff</b>(<i></i>)
511
512 <p>
513 Private slot to handle the Diff context menu entry.
514 </p>
515 <a NAME="HgStatusDialog.__showActionsMenu" ID="HgStatusDialog.__showActionsMenu"></a>
516 <h4>HgStatusDialog.__showActionsMenu</h4>
517 <b>__showActionsMenu</b>(<i></i>)
518
519 <p>
520 Private slot to prepare the actions button menu before it is shown.
521 </p>
522 <a NAME="HgStatusDialog.__showError" ID="HgStatusDialog.__showError"></a>
523 <h4>HgStatusDialog.__showError</h4>
524 <b>__showError</b>(<i>out</i>)
525
526 <p>
527 Private slot to show some error.
528 </p>
529 <dl>
530
531 <dt><i>out</i></dt>
532 <dd>
533 error to be shown (string)
534 </dd>
535 </dl>
536 <a NAME="HgStatusDialog.closeEvent" ID="HgStatusDialog.closeEvent"></a>
537 <h4>HgStatusDialog.closeEvent</h4>
538 <b>closeEvent</b>(<i>e</i>)
539
540 <p>
541 Protected slot implementing a close event handler.
542 </p>
543 <dl>
544
545 <dt><i>e</i></dt>
546 <dd>
547 close event (QCloseEvent)
548 </dd>
549 </dl>
550 <a NAME="HgStatusDialog.on_buttonBox_clicked" ID="HgStatusDialog.on_buttonBox_clicked"></a>
551 <h4>HgStatusDialog.on_buttonBox_clicked</h4>
552 <b>on_buttonBox_clicked</b>(<i>button</i>)
553
554 <p>
555 Private slot called by a button of the button box clicked.
556 </p>
557 <dl>
558
559 <dt><i>button</i></dt>
560 <dd>
561 button that was clicked (QAbstractButton)
562 </dd>
563 </dl>
564 <a NAME="HgStatusDialog.on_refreshButton_clicked" ID="HgStatusDialog.on_refreshButton_clicked"></a>
565 <h4>HgStatusDialog.on_refreshButton_clicked</h4>
566 <b>on_refreshButton_clicked</b>(<i></i>)
567
568 <p>
569 Private slot to refresh the status display.
570 </p>
571 <a NAME="HgStatusDialog.on_statusFilterCombo_activated" ID="HgStatusDialog.on_statusFilterCombo_activated"></a>
572 <h4>HgStatusDialog.on_statusFilterCombo_activated</h4>
573 <b>on_statusFilterCombo_activated</b>(<i>index</i>)
574
575 <p>
576 Private slot to react to the selection of a status filter.
577 </p>
578 <dl>
579
580 <dt><i>index</i> (int)</dt>
581 <dd>
582 index of the selected entry
583 </dd>
584 </dl>
585 <a NAME="HgStatusDialog.on_statusList_itemSelectionChanged" ID="HgStatusDialog.on_statusList_itemSelectionChanged"></a>
586 <h4>HgStatusDialog.on_statusList_itemSelectionChanged</h4>
587 <b>on_statusList_itemSelectionChanged</b>(<i></i>)
588
589 <p>
590 Private slot to act upon changes of selected items.
591 </p>
592 <a NAME="HgStatusDialog.show" ID="HgStatusDialog.show"></a>
593 <h4>HgStatusDialog.show</h4>
594 <b>show</b>(<i></i>)
595
596 <p>
597 Public slot to show the dialog.
598 </p>
599 <a NAME="HgStatusDialog.start" ID="HgStatusDialog.start"></a>
600 <h4>HgStatusDialog.start</h4>
601 <b>start</b>(<i>fn</i>)
602
603 <p>
604 Public slot to start the hg status command.
605 </p>
606 <dl>
607
608 <dt><i>fn</i></dt>
609 <dd>
610 filename(s)/directoryname(s) to show the status of
611 (string or list of strings)
612 </dd>
613 </dl>
614 <div align="right"><a href="#top">Up</a></div>
615 <hr />
616 </body></html>

Mercurial Repository: eric

eric ide

mercurial