--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeDialog</h1>
-
<p>
Module implementing a dialog to offer the worktree management functionality.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#GitWorktreeDialog">GitWorktreeDialog</a></td>
<td>Class implementing a dialog to offer the worktree management functionality.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="GitWorktreeDialog" ID="GitWorktreeDialog"></a>
<h2>GitWorktreeDialog</h2>
-
<p>
Class implementing a dialog to offer the worktree management functionality.
</p>
+
<h3>Derived from</h3>
QWidget, Ui_GitWorktreeDialog
<h3>Class Attributes</h3>
-
<table>
<tr><td>StatusRole</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#GitWorktreeDialog.__init__">GitWorktreeDialog</a></td>
<td>Constructor</td>
@@ -159,19 +156,20 @@
<td>Public slot to start the git worktree list command.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="GitWorktreeDialog.__init__" ID="GitWorktreeDialog.__init__"></a>
<h4>GitWorktreeDialog (Constructor)</h4>
<b>GitWorktreeDialog</b>(<i>vcs, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>vcs</i> (Git)</dt>
@@ -186,18 +184,18 @@
<a NAME="GitWorktreeDialog.__finish" ID="GitWorktreeDialog.__finish"></a>
<h4>GitWorktreeDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private slot called when the process finished or the user pressed
the button.
</p>
+
<a NAME="GitWorktreeDialog.__generateItem" ID="GitWorktreeDialog.__generateItem"></a>
<h4>GitWorktreeDialog.__generateItem</h4>
<b>__generateItem</b>(<i>dataLines</i>)
-
<p>
Private method to generate a worktree entry with the given data.
</p>
+
<dl>
<dt><i>dataLines</i> (list of str)</dt>
@@ -209,17 +207,17 @@
<a NAME="GitWorktreeDialog.__initActionsMenu" ID="GitWorktreeDialog.__initActionsMenu"></a>
<h4>GitWorktreeDialog.__initActionsMenu</h4>
<b>__initActionsMenu</b>(<i></i>)
-
<p>
Private method to initialize the actions menu.
</p>
+
<a NAME="GitWorktreeDialog.__procFinished" ID="GitWorktreeDialog.__procFinished"></a>
<h4>GitWorktreeDialog.__procFinished</h4>
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
-
<p>
Private slot connected to the finished signal.
</p>
+
<dl>
<dt><i>exitCode</i> (int)</dt>
@@ -234,7 +232,6 @@
<a NAME="GitWorktreeDialog.__readStderr" ID="GitWorktreeDialog.__readStderr"></a>
<h4>GitWorktreeDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardError signal.
</p>
@@ -242,10 +239,10 @@
It reads the error output of the process and inserts it into the
error pane.
</p>
+
<a NAME="GitWorktreeDialog.__readStdout" ID="GitWorktreeDialog.__readStdout"></a>
<h4>GitWorktreeDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardOutput signal.
</p>
@@ -253,69 +250,70 @@
It reads the output of the process, formats it and inserts it into
the contents pane.
</p>
+
<a NAME="GitWorktreeDialog.__refreshButtonClicked" ID="GitWorktreeDialog.__refreshButtonClicked"></a>
<h4>GitWorktreeDialog.__refreshButtonClicked</h4>
<b>__refreshButtonClicked</b>(<i></i>)
-
<p>
Private slot to refresh the worktree display.
</p>
+
<a NAME="GitWorktreeDialog.__resizeColumns" ID="GitWorktreeDialog.__resizeColumns"></a>
<h4>GitWorktreeDialog.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)
-
<p>
Private method to resize the list columns.
</p>
+
<a NAME="GitWorktreeDialog.__resort" ID="GitWorktreeDialog.__resort"></a>
<h4>GitWorktreeDialog.__resort</h4>
<b>__resort</b>(<i></i>)
-
<p>
Private method to resort the tree.
</p>
+
<a NAME="GitWorktreeDialog.__showActionsMenu" ID="GitWorktreeDialog.__showActionsMenu"></a>
<h4>GitWorktreeDialog.__showActionsMenu</h4>
<b>__showActionsMenu</b>(<i></i>)
-
<p>
Private slot to prepare the actions button menu before it is shown.
</p>
+
<a NAME="GitWorktreeDialog.__worktreeAdd" ID="GitWorktreeDialog.__worktreeAdd"></a>
<h4>GitWorktreeDialog.__worktreeAdd</h4>
<b>__worktreeAdd</b>(<i></i>)
-
<p>
Private slot to add a linked worktree.
</p>
+
<a NAME="GitWorktreeDialog.__worktreeLock" ID="GitWorktreeDialog.__worktreeLock"></a>
<h4>GitWorktreeDialog.__worktreeLock</h4>
<b>__worktreeLock</b>(<i></i>)
-
<p>
Private slot to lock a worktree.
</p>
+
<a NAME="GitWorktreeDialog.__worktreeMove" ID="GitWorktreeDialog.__worktreeMove"></a>
<h4>GitWorktreeDialog.__worktreeMove</h4>
<b>__worktreeMove</b>(<i></i>)
-
<p>
Private slot to move a worktree to a new location.
</p>
+
<a NAME="GitWorktreeDialog.__worktreePrune" ID="GitWorktreeDialog.__worktreePrune"></a>
<h4>GitWorktreeDialog.__worktreePrune</h4>
<b>__worktreePrune</b>(<i></i>)
-
<p>
Private slot to prune worktree information.
</p>
+
<a NAME="GitWorktreeDialog.__worktreeRemove" ID="GitWorktreeDialog.__worktreeRemove"></a>
<h4>GitWorktreeDialog.__worktreeRemove</h4>
<b>__worktreeRemove</b>(<i>force=False</i>)
-
<p>
Private slot to remove a linked worktree.
</p>
+
<dl>
<dt><i>force</i> (bool (optional)</dt>
@@ -326,17 +324,17 @@
<a NAME="GitWorktreeDialog.__worktreeRemoveForced" ID="GitWorktreeDialog.__worktreeRemoveForced"></a>
<h4>GitWorktreeDialog.__worktreeRemoveForced</h4>
<b>__worktreeRemoveForced</b>(<i></i>)
-
<p>
Private slot to remove a linked worktree forcefully.
</p>
+
<a NAME="GitWorktreeDialog.__worktreeRepair" ID="GitWorktreeDialog.__worktreeRepair"></a>
<h4>GitWorktreeDialog.__worktreeRepair</h4>
<b>__worktreeRepair</b>(<i>worktreePaths=None</i>)
-
<p>
Private slot to repair worktree administrative files.
</p>
+
<dl>
<dt><i>worktreePaths</i> (list of str (optional))</dt>
@@ -347,25 +345,25 @@
<a NAME="GitWorktreeDialog.__worktreeRepairMultiple" ID="GitWorktreeDialog.__worktreeRepairMultiple"></a>
<h4>GitWorktreeDialog.__worktreeRepairMultiple</h4>
<b>__worktreeRepairMultiple</b>(<i></i>)
-
<p>
Private slot to repair worktree administrative files for multiple worktree
paths.
</p>
+
<a NAME="GitWorktreeDialog.__worktreeUnlock" ID="GitWorktreeDialog.__worktreeUnlock"></a>
<h4>GitWorktreeDialog.__worktreeUnlock</h4>
<b>__worktreeUnlock</b>(<i></i>)
-
<p>
Private slot to unlock a worktree.
</p>
+
<a NAME="GitWorktreeDialog.closeEvent" ID="GitWorktreeDialog.closeEvent"></a>
<h4>GitWorktreeDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)
-
<p>
Protected slot implementing a close event handler.
</p>
+
<dl>
<dt><i>e</i> (QCloseEvent)</dt>
@@ -376,10 +374,10 @@
<a NAME="GitWorktreeDialog.on_buttonBox_clicked" ID="GitWorktreeDialog.on_buttonBox_clicked"></a>
<h4>GitWorktreeDialog.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>
@@ -390,10 +388,10 @@
<a NAME="GitWorktreeDialog.on_expireCheckBox_toggled" ID="GitWorktreeDialog.on_expireCheckBox_toggled"></a>
<h4>GitWorktreeDialog.on_expireCheckBox_toggled</h4>
<b>on_expireCheckBox_toggled</b>(<i>checked</i>)
-
<p>
Private slot to handle a change of the expire checkbox.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -404,10 +402,10 @@
<a NAME="GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged" ID="GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged"></a>
<h4>GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged</h4>
<b>on_expireDateTimeEdit_dateTimeChanged</b>(<i>dateTime</i>)
-
<p>
Private slot to handle a change of the expire date and time.
</p>
+
<dl>
<dt><i>dateTime</i> (QDateTime)</dt>
@@ -418,17 +416,17 @@
<a NAME="GitWorktreeDialog.show" ID="GitWorktreeDialog.show"></a>
<h4>GitWorktreeDialog.show</h4>
<b>show</b>(<i></i>)
-
<p>
Public slot to show the dialog.
</p>
+
<a NAME="GitWorktreeDialog.start" ID="GitWorktreeDialog.start"></a>
<h4>GitWorktreeDialog.start</h4>
<b>start</b>(<i>projectDir</i>)
-
<p>
Public slot to start the git worktree list command.
</p>
+
<dl>
<dt><i>projectDir</i> (str)</dt>
@@ -438,4 +436,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
