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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsGit.GitWorktreePathsDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitWorktreePathsDialog</h1>

<p>
Module implementing a dialog to enter a list of worktree paths.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#GitWorktreePathsDialog">GitWorktreePathsDialog</a></td>
<td>Class implementing a dialog to enter a list of worktree paths.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="GitWorktreePathsDialog" ID="GitWorktreePathsDialog"></a>
<h2>GitWorktreePathsDialog</h2>

<p>
    Class implementing a dialog to enter a list of worktree paths.
</p>
<h3>Derived from</h3>
QDialog, Ui_GitWorktreePathsDialog
<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="#GitWorktreePathsDialog.__init__">GitWorktreePathsDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitWorktreePathsDialog.__updateOK">__updateOK</a></td>
<td>Private method to set the enabled state of the OK button.</td>
</tr>
<tr>
<td><a href="#GitWorktreePathsDialog.getPathsList">getPathsList</a></td>
<td>Public method to get the entered worktree paths.</td>
</tr>
<tr>
<td><a href="#GitWorktreePathsDialog.on_addButton_clicked">on_addButton_clicked</a></td>
<td>Private slot to add a path entry.</td>
</tr>
<tr>
<td><a href="#GitWorktreePathsDialog.on_pathsList_itemSelectionChanged">on_pathsList_itemSelectionChanged</a></td>
<td>Private slot handling a change of selected items.</td>
</tr>
<tr>
<td><a href="#GitWorktreePathsDialog.on_removeAllButton_clicked">on_removeAllButton_clicked</a></td>
<td>Private slot to remove all items from the list.</td>
</tr>
<tr>
<td><a href="#GitWorktreePathsDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
<td>Private slot to remove the selected items.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="GitWorktreePathsDialog.__init__" ID="GitWorktreePathsDialog.__init__"></a>
<h4>GitWorktreePathsDialog (Constructor)</h4>
<b>GitWorktreePathsDialog</b>(<i>parentDirectory, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parentDirectory</i> (str)</dt>
<dd>
path of the worktrees parent directory
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="GitWorktreePathsDialog.__updateOK" ID="GitWorktreePathsDialog.__updateOK"></a>
<h4>GitWorktreePathsDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)

<p>
        Private method to set the enabled state of the OK button.
</p>
<a NAME="GitWorktreePathsDialog.getPathsList" ID="GitWorktreePathsDialog.getPathsList"></a>
<h4>GitWorktreePathsDialog.getPathsList</h4>
<b>getPathsList</b>(<i></i>)

<p>
        Public method to get the entered worktree paths.
</p>
<dl>
<dt>Return:</dt>
<dd>
list of worktree paths
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="GitWorktreePathsDialog.on_addButton_clicked" ID="GitWorktreePathsDialog.on_addButton_clicked"></a>
<h4>GitWorktreePathsDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)

<p>
        Private slot to add a path entry.
</p>
<a NAME="GitWorktreePathsDialog.on_pathsList_itemSelectionChanged" ID="GitWorktreePathsDialog.on_pathsList_itemSelectionChanged"></a>
<h4>GitWorktreePathsDialog.on_pathsList_itemSelectionChanged</h4>
<b>on_pathsList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot handling a change of selected items.
</p>
<a NAME="GitWorktreePathsDialog.on_removeAllButton_clicked" ID="GitWorktreePathsDialog.on_removeAllButton_clicked"></a>
<h4>GitWorktreePathsDialog.on_removeAllButton_clicked</h4>
<b>on_removeAllButton_clicked</b>(<i></i>)

<p>
        Private slot to remove all items from the list.
</p>
<a NAME="GitWorktreePathsDialog.on_removeButton_clicked" ID="GitWorktreePathsDialog.on_removeButton_clicked"></a>
<h4>GitWorktreePathsDialog.on_removeButton_clicked</h4>
<b>on_removeButton_clicked</b>(<i></i>)

<p>
        Private slot to remove the selected items.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>