--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,55 +7,52 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog</h1> - <p> Module implementing a dialog to show the output of the hg status command process. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#HgStatusDialog">HgStatusDialog</a></td> <td>Class implementing a dialog to show the output of the hg status command process.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="HgStatusDialog" ID="HgStatusDialog"></a> <h2>HgStatusDialog</h2> - <p> Class implementing a dialog to show the output of the hg status command process. </p> + <h3>Derived from</h3> QWidget, Ui_HgStatusDialog <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#HgStatusDialog.__init__">HgStatusDialog</a></td> <td>Constructor</td> @@ -209,19 +206,20 @@ <td>Public slot to start the hg status command.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="HgStatusDialog.__init__" ID="HgStatusDialog.__init__"></a> <h4>HgStatusDialog (Constructor)</h4> <b>HgStatusDialog</b>(<i>vcs, mq=False, parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>vcs</i> (Hg)</dt> @@ -240,45 +238,45 @@ <a NAME="HgStatusDialog.__abortMerge" ID="HgStatusDialog.__abortMerge"></a> <h4>HgStatusDialog.__abortMerge</h4> <b>__abortMerge</b>(<i></i>) - <p> Private slot used to abort an uncommitted merge. </p> + <a NAME="HgStatusDialog.__add" ID="HgStatusDialog.__add"></a> <h4>HgStatusDialog.__add</h4> <b>__add</b>(<i></i>) - <p> Private slot to handle the Add context menu entry. </p> + <a NAME="HgStatusDialog.__commit" ID="HgStatusDialog.__commit"></a> <h4>HgStatusDialog.__commit</h4> <b>__commit</b>(<i></i>) - <p> Private slot to handle the Commit context menu entry. </p> + <a NAME="HgStatusDialog.__commitDeselectAll" ID="HgStatusDialog.__commitDeselectAll"></a> <h4>HgStatusDialog.__commitDeselectAll</h4> <b>__commitDeselectAll</b>(<i></i>) - <p> Private slot to deselect all entries from commit. </p> + <a NAME="HgStatusDialog.__commitMerge" ID="HgStatusDialog.__commitMerge"></a> <h4>HgStatusDialog.__commitMerge</h4> <b>__commitMerge</b>(<i></i>) - <p> Private slot to handle the Commit Merge context menu entry. </p> + <a NAME="HgStatusDialog.__commitSelect" ID="HgStatusDialog.__commitSelect"></a> <h4>HgStatusDialog.__commitSelect</h4> <b>__commitSelect</b>(<i>selected</i>) - <p> Private slot to select or deselect all entries. </p> + <dl> <dt><i>selected</i> (bool)</dt> @@ -289,53 +287,53 @@ <a NAME="HgStatusDialog.__commitSelectAll" ID="HgStatusDialog.__commitSelectAll"></a> <h4>HgStatusDialog.__commitSelectAll</h4> <b>__commitSelectAll</b>(<i></i>) - <p> Private slot to select all entries for commit. </p> + <a NAME="HgStatusDialog.__committed" ID="HgStatusDialog.__committed"></a> <h4>HgStatusDialog.__committed</h4> <b>__committed</b>(<i></i>) - <p> Private slot called after the commit has finished. </p> + <a NAME="HgStatusDialog.__diff" ID="HgStatusDialog.__diff"></a> <h4>HgStatusDialog.__diff</h4> <b>__diff</b>(<i></i>) - <p> Private slot to handle the Diff context menu entry. </p> + <a NAME="HgStatusDialog.__finish" ID="HgStatusDialog.__finish"></a> <h4>HgStatusDialog.__finish</h4> <b>__finish</b>(<i></i>) - <p> Private slot called when the process finished or the user pressed the button. </p> + <a NAME="HgStatusDialog.__forget" ID="HgStatusDialog.__forget"></a> <h4>HgStatusDialog.__forget</h4> <b>__forget</b>(<i></i>) - <p> Private slot to handle the Forget Missing context menu entry. </p> + <a NAME="HgStatusDialog.__generateDiffs" ID="HgStatusDialog.__generateDiffs"></a> <h4>HgStatusDialog.__generateDiffs</h4> <b>__generateDiffs</b>(<i></i>) - <p> Private slot to generate diff outputs for the selected item. </p> + <a NAME="HgStatusDialog.__generateItem" ID="HgStatusDialog.__generateItem"></a> <h4>HgStatusDialog.__generateItem</h4> <b>__generateItem</b>(<i>status, path</i>) - <p> Private method to generate a status item in the status list. </p> + <dl> <dt><i>status</i> (str)</dt> @@ -350,17 +348,17 @@ <a NAME="HgStatusDialog.__generatorFinished" ID="HgStatusDialog.__generatorFinished"></a> <h4>HgStatusDialog.__generatorFinished</h4> <b>__generatorFinished</b>(<i></i>) - <p> Private slot connected to the finished signal of the diff generator. </p> + <a NAME="HgStatusDialog.__getCommitableItems" ID="HgStatusDialog.__getCommitableItems"></a> <h4>HgStatusDialog.__getCommitableItems</h4> <b>__getCommitableItems</b>(<i></i>) - <p> Private method to retrieve all entries the user wants to commit. </p> + <dl> <dt>Return:</dt> <dd> @@ -376,11 +374,11 @@ <a NAME="HgStatusDialog.__getCommitableUnselectedItems" ID="HgStatusDialog.__getCommitableUnselectedItems"></a> <h4>HgStatusDialog.__getCommitableUnselectedItems</h4> <b>__getCommitableUnselectedItems</b>(<i></i>) - <p> Private method to retrieve all entries the user may commit but hasn't selected. </p> + <dl> <dt>Return:</dt> <dd> @@ -396,10 +394,10 @@ <a NAME="HgStatusDialog.__getMissingItems" ID="HgStatusDialog.__getMissingItems"></a> <h4>HgStatusDialog.__getMissingItems</h4> <b>__getMissingItems</b>(<i></i>) - <p> Private method to retrieve all entries, that have a missing status. </p> + <dl> <dt>Return:</dt> <dd> @@ -415,10 +413,10 @@ <a NAME="HgStatusDialog.__getModifiedItems" ID="HgStatusDialog.__getModifiedItems"></a> <h4>HgStatusDialog.__getModifiedItems</h4> <b>__getModifiedItems</b>(<i></i>) - <p> Private method to retrieve all entries, that have a modified status. </p> + <dl> <dt>Return:</dt> <dd> @@ -434,11 +432,11 @@ <a NAME="HgStatusDialog.__getUnversionedItems" ID="HgStatusDialog.__getUnversionedItems"></a> <h4>HgStatusDialog.__getUnversionedItems</h4> <b>__getUnversionedItems</b>(<i></i>) - <p> Private method to retrieve all entries, that have an unversioned status. </p> + <dl> <dt>Return:</dt> <dd> @@ -454,17 +452,17 @@ <a NAME="HgStatusDialog.__initActionsMenu" ID="HgStatusDialog.__initActionsMenu"></a> <h4>HgStatusDialog.__initActionsMenu</h4> <b>__initActionsMenu</b>(<i></i>) - <p> Private method to initialize the actions menu. </p> + <a NAME="HgStatusDialog.__lfAdd" ID="HgStatusDialog.__lfAdd"></a> <h4>HgStatusDialog.__lfAdd</h4> <b>__lfAdd</b>(<i>mode</i>) - <p> Private slot to add a file to the repository. </p> + <dl> <dt><i>mode</i> (str)</dt> @@ -475,10 +473,10 @@ <a NAME="HgStatusDialog.__processOutputLine" ID="HgStatusDialog.__processOutputLine"></a> <h4>HgStatusDialog.__processOutputLine</h4> <b>__processOutputLine</b>(<i>line</i>) - <p> Private method to process the lines of output. </p> + <dl> <dt><i>line</i> (str)</dt> @@ -489,59 +487,59 @@ <a NAME="HgStatusDialog.__refreshDiff" ID="HgStatusDialog.__refreshDiff"></a> <h4>HgStatusDialog.__refreshDiff</h4> <b>__refreshDiff</b>(<i></i>) - <p> Private method to refresh the diff output after a refresh. </p> + <a NAME="HgStatusDialog.__resizeColumns" ID="HgStatusDialog.__resizeColumns"></a> <h4>HgStatusDialog.__resizeColumns</h4> <b>__resizeColumns</b>(<i></i>) - <p> Private method to resize the list columns. </p> + <a NAME="HgStatusDialog.__resort" ID="HgStatusDialog.__resort"></a> <h4>HgStatusDialog.__resort</h4> <b>__resort</b>(<i></i>) - <p> Private method to resort the tree. </p> + <a NAME="HgStatusDialog.__restoreMissing" ID="HgStatusDialog.__restoreMissing"></a> <h4>HgStatusDialog.__restoreMissing</h4> <b>__restoreMissing</b>(<i></i>) - <p> Private slot to handle the Restore Missing context menu entry. </p> + <a NAME="HgStatusDialog.__revert" ID="HgStatusDialog.__revert"></a> <h4>HgStatusDialog.__revert</h4> <b>__revert</b>(<i></i>) - <p> Private slot to handle the Revert context menu entry. </p> + <a NAME="HgStatusDialog.__sbsDiff" ID="HgStatusDialog.__sbsDiff"></a> <h4>HgStatusDialog.__sbsDiff</h4> <b>__sbsDiff</b>(<i></i>) - <p> Private slot to handle the Side-By-Side Diff context menu entry. </p> + <a NAME="HgStatusDialog.__showActionsMenu" ID="HgStatusDialog.__showActionsMenu"></a> <h4>HgStatusDialog.__showActionsMenu</h4> <b>__showActionsMenu</b>(<i></i>) - <p> Private slot to prepare the actions button menu before it is shown. </p> + <a NAME="HgStatusDialog.__showError" ID="HgStatusDialog.__showError"></a> <h4>HgStatusDialog.__showError</h4> <b>__showError</b>(<i>out</i>) - <p> Private slot to show some error. </p> + <dl> <dt><i>out</i> (str)</dt> @@ -552,10 +550,10 @@ <a NAME="HgStatusDialog.closeEvent" ID="HgStatusDialog.closeEvent"></a> <h4>HgStatusDialog.closeEvent</h4> <b>closeEvent</b>(<i>e</i>) - <p> Protected slot implementing a close event handler. </p> + <dl> <dt><i>e</i> (QCloseEvent)</dt> @@ -566,10 +564,10 @@ <a NAME="HgStatusDialog.on_buttonBox_clicked" ID="HgStatusDialog.on_buttonBox_clicked"></a> <h4>HgStatusDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) - <p> Private slot called by a button of the button box clicked. </p> + <dl> <dt><i>button</i> (QAbstractButton)</dt> @@ -580,17 +578,17 @@ <a NAME="HgStatusDialog.on_refreshButton_clicked" ID="HgStatusDialog.on_refreshButton_clicked"></a> <h4>HgStatusDialog.on_refreshButton_clicked</h4> <b>on_refreshButton_clicked</b>(<i></i>) - <p> Private slot to refresh the status display. </p> + <a NAME="HgStatusDialog.on_statusFilterCombo_activated" ID="HgStatusDialog.on_statusFilterCombo_activated"></a> <h4>HgStatusDialog.on_statusFilterCombo_activated</h4> <b>on_statusFilterCombo_activated</b>(<i>index</i>) - <p> Private slot to react to the selection of a status filter. </p> + <dl> <dt><i>index</i> (int)</dt> @@ -601,24 +599,24 @@ <a NAME="HgStatusDialog.on_statusList_itemSelectionChanged" ID="HgStatusDialog.on_statusList_itemSelectionChanged"></a> <h4>HgStatusDialog.on_statusList_itemSelectionChanged</h4> <b>on_statusList_itemSelectionChanged</b>(<i></i>) - <p> Private slot to act upon changes of selected items. </p> + <a NAME="HgStatusDialog.show" ID="HgStatusDialog.show"></a> <h4>HgStatusDialog.show</h4> <b>show</b>(<i></i>) - <p> Public slot to show the dialog. </p> + <a NAME="HgStatusDialog.start" ID="HgStatusDialog.start"></a> <h4>HgStatusDialog.start</h4> <b>start</b>(<i>fn</i>) - <p> Public slot to start the hg status command. </p> + <dl> <dt><i>fn</i> (str or list of str)</dt> @@ -628,4 +626,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>