src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManagerWidgets.html

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

<p>
Module implementing a dialog to manage the list of defined virtual
environments.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#VirtualenvManagerDialog">VirtualenvManagerDialog</a></td>
<td>Class implementing the virtual environments manager dialog variant.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget">VirtualenvManagerWidget</a></td>
<td>Class implementing a widget to manage the list of defined virtual environments.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWindow">VirtualenvManagerWindow</a></td>
<td>Main window class for the standalone virtual environments manager.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing the virtual environments manager dialog variant.
</p>
<h3>Derived from</h3>
QDialog
<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="#VirtualenvManagerDialog.__init__">VirtualenvManagerDialog</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>

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

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

<p>
        Constructor
</p>
<dl>

<dt><i>manager</i> (VirtualenvManager)</dt>
<dd>
reference to the virtual environment manager
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="VirtualenvManagerWidget" ID="VirtualenvManagerWidget"></a>
<h2>VirtualenvManagerWidget</h2>

<p>
    Class implementing a widget to manage the list of defined virtual
    environments.
</p>
<h3>Derived from</h3>
QWidget, Ui_VirtualenvManagerWidget
<h3>Class Attributes</h3>

<table>
<tr><td>MetadataRole</td></tr>
</table>
<h3>Class Methods</h3>

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

<table>

<tr>
<td><a href="#VirtualenvManagerWidget.__init__">VirtualenvManagerWidget</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.__populateVenvList">__populateVenvList</a></td>
<td>Private method to populate the list of virtual environments.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.__refresh">__refresh</a></td>
<td>Private slot to refresh the list of shown items.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.__resizeSections">__resizeSections</a></td>
<td>Private method to resize the sections of the environment list to their contents.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.__updateButtons">__updateButtons</a></td>
<td>Private method to update the enabled state of the various buttons.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_addButton_clicked">on_addButton_clicked</a></td>
<td>Private slot to add a new entry.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_deleteAllButton_clicked">on_deleteAllButton_clicked</a></td>
<td>Private slot to delete all entries from the list and disk.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
<td>Private slot to delete all selected entries from the list and disk.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_editButton_clicked">on_editButton_clicked</a></td>
<td>Private slot to edit the selected entry.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_newButton_clicked">on_newButton_clicked</a></td>
<td>Private slot to create a new virtual environment.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
<td>Private slot to refresh the list of virtual environments.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_removeAllButton_clicked">on_removeAllButton_clicked</a></td>
<td>Private slot to remove all entries from the list but keep their directories.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_removeButton_clicked">on_removeButton_clicked</a></td>
<td>Private slot to remove all selected entries from the list but keep their directories.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_saveButton_clicked">on_saveButton_clicked</a></td>
<td>Private slot to save the base directory name.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_searchNewButton_clicked">on_searchNewButton_clicked</a></td>
<td>Public slot to search for new (not yet registered) Python interpreters.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td>
<td>Private slot to upgrade a virtual environment.</td>
</tr>
<tr>
<td><a href="#VirtualenvManagerWidget.on_venvList_itemSelectionChanged">on_venvList_itemSelectionChanged</a></td>
<td>Private slot handling a change of the selected items.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

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

<p>
        Constructor
</p>
<dl>

<dt><i>manager</i> (VirtualenvManager)</dt>
<dd>
reference to the virtual environment manager
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="VirtualenvManagerWidget.__populateVenvList" ID="VirtualenvManagerWidget.__populateVenvList"></a>
<h4>VirtualenvManagerWidget.__populateVenvList</h4>
<b>__populateVenvList</b>(<i></i>)

<p>
        Private method to populate the list of virtual environments.
</p>
<a NAME="VirtualenvManagerWidget.__refresh" ID="VirtualenvManagerWidget.__refresh"></a>
<h4>VirtualenvManagerWidget.__refresh</h4>
<b>__refresh</b>(<i></i>)

<p>
        Private slot to refresh the list of shown items.
</p>
<a NAME="VirtualenvManagerWidget.__resizeSections" ID="VirtualenvManagerWidget.__resizeSections"></a>
<h4>VirtualenvManagerWidget.__resizeSections</h4>
<b>__resizeSections</b>(<i></i>)

<p>
        Private method to resize the sections of the environment list to their
        contents.
</p>
<a NAME="VirtualenvManagerWidget.__updateButtons" ID="VirtualenvManagerWidget.__updateButtons"></a>
<h4>VirtualenvManagerWidget.__updateButtons</h4>
<b>__updateButtons</b>(<i></i>)

<p>
        Private method to update the enabled state of the various buttons.
</p>
<a NAME="VirtualenvManagerWidget.on_addButton_clicked" ID="VirtualenvManagerWidget.on_addButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)

<p>
        Private slot to add a new entry.
</p>
<a NAME="VirtualenvManagerWidget.on_deleteAllButton_clicked" ID="VirtualenvManagerWidget.on_deleteAllButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_deleteAllButton_clicked</h4>
<b>on_deleteAllButton_clicked</b>(<i></i>)

<p>
        Private slot to delete all entries from the list and disk.
</p>
<a NAME="VirtualenvManagerWidget.on_deleteButton_clicked" ID="VirtualenvManagerWidget.on_deleteButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_deleteButton_clicked</h4>
<b>on_deleteButton_clicked</b>(<i></i>)

<p>
        Private slot to delete all selected entries from the list and disk.
</p>
<a NAME="VirtualenvManagerWidget.on_editButton_clicked" ID="VirtualenvManagerWidget.on_editButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_editButton_clicked</h4>
<b>on_editButton_clicked</b>(<i></i>)

<p>
        Private slot to edit the selected entry.
</p>
<a NAME="VirtualenvManagerWidget.on_newButton_clicked" ID="VirtualenvManagerWidget.on_newButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_newButton_clicked</h4>
<b>on_newButton_clicked</b>(<i></i>)

<p>
        Private slot to create a new virtual environment.
</p>
<a NAME="VirtualenvManagerWidget.on_refreshButton_clicked" ID="VirtualenvManagerWidget.on_refreshButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_refreshButton_clicked</h4>
<b>on_refreshButton_clicked</b>(<i></i>)

<p>
        Private slot to refresh the list of virtual environments.
</p>
<a NAME="VirtualenvManagerWidget.on_removeAllButton_clicked" ID="VirtualenvManagerWidget.on_removeAllButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_removeAllButton_clicked</h4>
<b>on_removeAllButton_clicked</b>(<i></i>)

<p>
        Private slot to remove all entries from the list but keep their
        directories.
</p>
<a NAME="VirtualenvManagerWidget.on_removeButton_clicked" ID="VirtualenvManagerWidget.on_removeButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_removeButton_clicked</h4>
<b>on_removeButton_clicked</b>(<i></i>)

<p>
        Private slot to remove all selected entries from the list but keep
        their directories.
</p>
<a NAME="VirtualenvManagerWidget.on_saveButton_clicked" ID="VirtualenvManagerWidget.on_saveButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_saveButton_clicked</h4>
<b>on_saveButton_clicked</b>(<i></i>)

<p>
        Private slot to save the base directory name.
</p>
<a NAME="VirtualenvManagerWidget.on_searchNewButton_clicked" ID="VirtualenvManagerWidget.on_searchNewButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_searchNewButton_clicked</h4>
<b>on_searchNewButton_clicked</b>(<i></i>)

<p>
        Public slot to search for new (not yet registered) Python interpreters.
</p>
<a NAME="VirtualenvManagerWidget.on_upgradeButton_clicked" ID="VirtualenvManagerWidget.on_upgradeButton_clicked"></a>
<h4>VirtualenvManagerWidget.on_upgradeButton_clicked</h4>
<b>on_upgradeButton_clicked</b>(<i></i>)

<p>
        Private slot to upgrade a virtual environment.
</p>
<a NAME="VirtualenvManagerWidget.on_venvList_itemSelectionChanged" ID="VirtualenvManagerWidget.on_venvList_itemSelectionChanged"></a>
<h4>VirtualenvManagerWidget.on_venvList_itemSelectionChanged</h4>
<b>on_venvList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot handling a change of the selected items.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="VirtualenvManagerWindow" ID="VirtualenvManagerWindow"></a>
<h2>VirtualenvManagerWindow</h2>

<p>
    Main window class for the standalone virtual environments manager.
</p>
<h3>Derived from</h3>
EricMainWindow
<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="#VirtualenvManagerWindow.__init__">VirtualenvManagerWindow</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>

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

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

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>