Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog.html

src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog.html

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog.html	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog.html	Sat Dec 23 15:40:23 2023 +0100
@@ -292,13 +292,13 @@
 </p>
 <dl>
 
-<dt><i>vcs</i></dt>
+<dt><i>vcs</i> (Git)</dt>
 <dd>
 reference to the vcs object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
 <a NAME="GitStatusDialog.__add" ID="GitStatusDialog.__add"></a>
@@ -324,9 +324,9 @@
 </p>
 <dl>
 
-<dt><i>amend</i></dt>
+<dt><i>amend</i> (bool)</dt>
 <dd>
-flag indicating to perform an amend operation (boolean)
+flag indicating to perform an amend operation
 </dd>
 </dl>
 <a NAME="GitStatusDialog.__commitDeselectAll" ID="GitStatusDialog.__commitDeselectAll"></a>
@@ -345,9 +345,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="GitStatusDialog.__commitSelectAll" ID="GitStatusDialog.__commitSelectAll"></a>
@@ -409,13 +409,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="GitStatusDialog.__generatorFinished" ID="GitStatusDialog.__generatorFinished"></a>
@@ -438,6 +438,12 @@
 list of all items, the user has checked
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__getCommitableUnselectedItems" ID="GitStatusDialog.__getCommitableUnselectedItems"></a>
 <h4>GitStatusDialog.__getCommitableUnselectedItems</h4>
 <b>__getCommitableUnselectedItems</b>(<i></i>)
@@ -452,6 +458,12 @@
 list of all items, the user has not checked
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__getConflictingItems" ID="GitStatusDialog.__getConflictingItems"></a>
 <h4>GitStatusDialog.__getConflictingItems</h4>
 <b>__getConflictingItems</b>(<i></i>)
@@ -465,6 +477,12 @@
 list of all items with a conflict status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__getMissingItems" ID="GitStatusDialog.__getMissingItems"></a>
 <h4>GitStatusDialog.__getMissingItems</h4>
 <b>__getMissingItems</b>(<i></i>)
@@ -478,6 +496,12 @@
 list of all items with a missing status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__getModifiedItems" ID="GitStatusDialog.__getModifiedItems"></a>
 <h4>GitStatusDialog.__getModifiedItems</h4>
 <b>__getModifiedItems</b>(<i></i>)
@@ -491,6 +515,12 @@
 list of all items with a modified status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__getModifiedOnlyItems" ID="GitStatusDialog.__getModifiedOnlyItems"></a>
 <h4>GitStatusDialog.__getModifiedOnlyItems</h4>
 <b>__getModifiedOnlyItems</b>(<i></i>)
@@ -504,6 +534,12 @@
 list of all items with a modified status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__getStageableItems" ID="GitStatusDialog.__getStageableItems"></a>
 <h4>GitStatusDialog.__getStageableItems</h4>
 <b>__getStageableItems</b>(<i></i>)
@@ -518,6 +554,12 @@
 list of all items with a stageable status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__getUnstageableItems" ID="GitStatusDialog.__getUnstageableItems"></a>
 <h4>GitStatusDialog.__getUnstageableItems</h4>
 <b>__getUnstageableItems</b>(<i></i>)
@@ -532,6 +574,12 @@
 list of all items with an unstageable status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__getUnversionedItems" ID="GitStatusDialog.__getUnversionedItems"></a>
 <h4>GitStatusDialog.__getUnversionedItems</h4>
 <b>__getUnversionedItems</b>(<i></i>)
@@ -546,6 +594,12 @@
 list of all items with an unversioned status
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="GitStatusDialog.__initActionsMenu" ID="GitStatusDialog.__initActionsMenu"></a>
 <h4>GitStatusDialog.__initActionsMenu</h4>
 <b>__initActionsMenu</b>(<i></i>)
@@ -562,13 +616,13 @@
 </p>
 <dl>
 
-<dt><i>exitCode</i></dt>
+<dt><i>exitCode</i> (int)</dt>
 <dd>
-exit code of the process (integer)
+exit code of the process
 </dd>
-<dt><i>exitStatus</i></dt>
+<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
 <dd>
-exit status of the process (QProcess.ExitStatus)
+exit status of the process
 </dd>
 </dl>
 <a NAME="GitStatusDialog.__readStderr" ID="GitStatusDialog.__readStderr"></a>
@@ -651,15 +705,21 @@
 </p>
 <dl>
 
-<dt><i>diffEdit</i></dt>
+<dt><i>diffEdit</i> (QTextEdit)</dt>
 <dd>
-reference to the edit widget (QTextEdit)
+reference to the edit widget
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of start and end indexes (integer, integer)
+tuple of start and end indexes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int)
 </dd>
 </dl>
 <a NAME="GitStatusDialog.__showActionsMenu" ID="GitStatusDialog.__showActionsMenu"></a>
@@ -678,9 +738,9 @@
 </p>
 <dl>
 
-<dt><i>coord</i></dt>
+<dt><i>coord</i> (QPoint)</dt>
 <dd>
-position of the mouse pointer (QPoint)
+position of the mouse pointer
 </dd>
 </dl>
 <a NAME="GitStatusDialog.__showRDiffContextMenu" ID="GitStatusDialog.__showRDiffContextMenu"></a>
@@ -692,9 +752,9 @@
 </p>
 <dl>
 
-<dt><i>coord</i></dt>
+<dt><i>coord</i> (QPoint)</dt>
 <dd>
-position of the mouse pointer (QPoint)
+position of the mouse pointer
 </dd>
 </dl>
 <a NAME="GitStatusDialog.__stage" ID="GitStatusDialog.__stage"></a>
@@ -721,7 +781,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the temporary file (string)
+name of the temporary file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="GitStatusDialog.__unstage" ID="GitStatusDialog.__unstage"></a>
@@ -747,9 +813,9 @@
 </p>
 <dl>
 
-<dt><i>e</i></dt>
+<dt><i>e</i> (QCloseEvent)</dt>
 <dd>
-close event (QCloseEvent)
+close event
 </dd>
 </dl>
 <a NAME="GitStatusDialog.keyPressEvent" ID="GitStatusDialog.keyPressEvent"></a>
@@ -761,9 +827,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QKeyEvent)</dt>
 <dd>
-the key press event (QKeyEvent)
+the key press event
 </dd>
 </dl>
 <a NAME="GitStatusDialog.on_buttonBox_clicked" ID="GitStatusDialog.on_buttonBox_clicked"></a>
@@ -775,9 +841,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="GitStatusDialog.on_input_returnPressed" ID="GitStatusDialog.on_input_returnPressed"></a>
@@ -796,9 +862,9 @@
 </p>
 <dl>
 
-<dt><i>isOn</i></dt>
+<dt><i>isOn</i> (bool)</dt>
 <dd>
-flag indicating the status of the check box (boolean)
+flag indicating the status of the check box
 </dd>
 </dl>
 <a NAME="GitStatusDialog.on_refreshButton_clicked" ID="GitStatusDialog.on_refreshButton_clicked"></a>
@@ -852,10 +918,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>

Mercurial Repository: eric

eric ide

mercurial