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

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9209
b99e7fd55fd3
child 10479
856476537696
diff -r 2f70ca07f0af -r 4cd7e5a8b3cf src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html	Sat Dec 23 15:40:23 2023 +0100
@@ -224,17 +224,17 @@
 </p>
 <dl>
 
-<dt><i>vcs</i></dt>
+<dt><i>vcs</i> (Hg)</dt>
 <dd>
 reference to the vcs object
 </dd>
-<dt><i>mq</i></dt>
+<dt><i>mq</i> (bool)</dt>
 <dd>
-flag indicating to show a queue repo status (boolean)
+flag indicating to show a queue repo status
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
 <a NAME="HgStatusDialog.__abortMerge" ID="HgStatusDialog.__abortMerge"></a>
@@ -281,9 +281,9 @@
 </p>
 <dl>
 
-<dt><i>selected</i></dt>
+<dt><i>selected</i> (bool)</dt>
 <dd>
-commit selection state to be set (boolean)
+commit selection state to be set
 </dd>
 </dl>
 <a NAME="HgStatusDialog.__commitSelectAll" ID="HgStatusDialog.__commitSelectAll"></a>
@@ -338,13 +338,13 @@
 </p>
 <dl>
 
-<dt><i>status</i></dt>
+<dt><i>status</i> (str)</dt>
 <dd>
-status indicator (string)
+status indicator
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-path of the file or directory (string)
+path of the file or directory
 </dd>
 </dl>
 <a NAME="HgStatusDialog.__generatorFinished" ID="HgStatusDialog.__generatorFinished"></a>
@@ -367,6 +367,12 @@
 list of all items, the user has checked
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItems
+</dd>
+</dl>
 <a NAME="HgStatusDialog.__getCommitableUnselectedItems" ID="HgStatusDialog.__getCommitableUnselectedItems"></a>
 <h4>HgStatusDialog.__getCommitableUnselectedItems</h4>
 <b>__getCommitableUnselectedItems</b>(<i></i>)
@@ -381,6 +387,12 @@
 list of all items, the user has checked
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItems
+</dd>
+</dl>
 <a NAME="HgStatusDialog.__getMissingItems" ID="HgStatusDialog.__getMissingItems"></a>
 <h4>HgStatusDialog.__getMissingItems</h4>
 <b>__getMissingItems</b>(<i></i>)
@@ -394,6 +406,12 @@
 list of all items with a missing status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItems
+</dd>
+</dl>
 <a NAME="HgStatusDialog.__getModifiedItems" ID="HgStatusDialog.__getModifiedItems"></a>
 <h4>HgStatusDialog.__getModifiedItems</h4>
 <b>__getModifiedItems</b>(<i></i>)
@@ -407,6 +425,12 @@
 list of all items with a modified status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItems
+</dd>
+</dl>
 <a NAME="HgStatusDialog.__getUnversionedItems" ID="HgStatusDialog.__getUnversionedItems"></a>
 <h4>HgStatusDialog.__getUnversionedItems</h4>
 <b>__getUnversionedItems</b>(<i></i>)
@@ -421,6 +445,12 @@
 list of all items with an unversioned status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItems
+</dd>
+</dl>
 <a NAME="HgStatusDialog.__initActionsMenu" ID="HgStatusDialog.__initActionsMenu"></a>
 <h4>HgStatusDialog.__initActionsMenu</h4>
 <b>__initActionsMenu</b>(<i></i>)
@@ -437,9 +467,9 @@
 </p>
 <dl>
 
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (str)</dt>
 <dd>
-add mode (string one of 'normal' or 'large')
+add mode (one of 'normal' or 'large')
 </dd>
 </dl>
 <a NAME="HgStatusDialog.__processOutputLine" ID="HgStatusDialog.__processOutputLine"></a>
@@ -451,9 +481,9 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
+<dt><i>line</i> (str)</dt>
 <dd>
-output line to be processed (string)
+output line to be processed
 </dd>
 </dl>
 <a NAME="HgStatusDialog.__refreshDiff" ID="HgStatusDialog.__refreshDiff"></a>
@@ -514,9 +544,9 @@
 </p>
 <dl>
 
-<dt><i>out</i></dt>
+<dt><i>out</i> (str)</dt>
 <dd>
-error to be shown (string)
+error to be shown
 </dd>
 </dl>
 <a NAME="HgStatusDialog.closeEvent" ID="HgStatusDialog.closeEvent"></a>
@@ -528,9 +558,9 @@
 </p>
 <dl>
 
-<dt><i>e</i></dt>
+<dt><i>e</i> (QCloseEvent)</dt>
 <dd>
-close event (QCloseEvent)
+close event
 </dd>
 </dl>
 <a NAME="HgStatusDialog.on_buttonBox_clicked" ID="HgStatusDialog.on_buttonBox_clicked"></a>
@@ -542,9 +572,9 @@
 </p>
 <dl>
 
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
 <dd>
-button that was clicked (QAbstractButton)
+button that was clicked
 </dd>
 </dl>
 <a NAME="HgStatusDialog.on_refreshButton_clicked" ID="HgStatusDialog.on_refreshButton_clicked"></a>
@@ -591,10 +621,9 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str or list of str)</dt>
 <dd>
 filename(s)/directoryname(s) to show the status of
-            (string or list of strings)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial