--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.CondaInterface.CondaExportDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,297 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.CondaInterface.CondaExportDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.CondaInterface.CondaExportDialog</h1> + +<p> +Module implementing a dialog to generate a requirements file for conda. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#CondaExportDialog">CondaExportDialog</a></td> +<td>Class implementing a dialog to generate a requirements file for conda.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="CondaExportDialog" ID="CondaExportDialog"></a> +<h2>CondaExportDialog</h2> + +<p> + Class implementing a dialog to generate a requirements file for conda. +</p> +<h3>Derived from</h3> +QDialog, Ui_CondaExportDialog +<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="#CondaExportDialog.__init__">CondaExportDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.__refresh">__refresh</a></td> +<td>Private slot to refresh the displayed list.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.__updateButtons">__updateButtons</a></td> +<td>Private method to set the state of the various buttons.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.__writeToFile">__writeToFile</a></td> +<td>Private method to write the requirements text to a file.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.closeEvent">closeEvent</a></td> +<td>Protected slot implementing a close event handler.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> +<td>Private slot to copy the requirements text to the clipboard.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> +<td>Private slot to insert the requirements text at the cursor position of the current editor.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> +<td>Private slot to replace the text of the current editor with the requirements text.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> +<td>Private slot to replace the selected text of the current editor with the requirements text.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> +<td>Private slot handling changes of the requirements text.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> +<td>Private slot handling a change of the requirements file name.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> +<td>Private slot to save the requirements text to the requirements file.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> +<td>Private slot to write the requirements text to a new file.</td> +</tr> +<tr> +<td><a href="#CondaExportDialog.start">start</a></td> +<td>Public method to start the command.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="CondaExportDialog.__init__" ID="CondaExportDialog.__init__"></a> +<h4>CondaExportDialog (Constructor)</h4> +<b>CondaExportDialog</b>(<i>conda, envName, envPrefix, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>conda</i> (Conda)</dt> +<dd> +reference to the master object +</dd> +<dt><i>envName</i> (str)</dt> +<dd> +name of the environment to create the requirements + file from +</dd> +<dt><i>envPrefix</i> (str)</dt> +<dd> +prefix of the environment to create the requirements + file from +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="CondaExportDialog.__refresh" ID="CondaExportDialog.__refresh"></a> +<h4>CondaExportDialog.__refresh</h4> +<b>__refresh</b>(<i></i>) + +<p> + Private slot to refresh the displayed list. +</p> +<a NAME="CondaExportDialog.__updateButtons" ID="CondaExportDialog.__updateButtons"></a> +<h4>CondaExportDialog.__updateButtons</h4> +<b>__updateButtons</b>(<i></i>) + +<p> + Private method to set the state of the various buttons. +</p> +<a NAME="CondaExportDialog.__writeToFile" ID="CondaExportDialog.__writeToFile"></a> +<h4>CondaExportDialog.__writeToFile</h4> +<b>__writeToFile</b>(<i>fileName</i>) + +<p> + Private method to write the requirements text to a file. +</p> +<dl> + +<dt><i>fileName</i> (str)</dt> +<dd> +name of the file to write to +</dd> +</dl> +<a NAME="CondaExportDialog.closeEvent" ID="CondaExportDialog.closeEvent"></a> +<h4>CondaExportDialog.closeEvent</h4> +<b>closeEvent</b>(<i>e</i>) + +<p> + Protected slot implementing a close event handler. +</p> +<dl> + +<dt><i>e</i> (QCloseEvent)</dt> +<dd> +close event +</dd> +</dl> +<a NAME="CondaExportDialog.on_buttonBox_clicked" ID="CondaExportDialog.on_buttonBox_clicked"></a> +<h4>CondaExportDialog.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> +<dd> +button that was clicked +</dd> +</dl> +<a NAME="CondaExportDialog.on_copyButton_clicked" ID="CondaExportDialog.on_copyButton_clicked"></a> +<h4>CondaExportDialog.on_copyButton_clicked</h4> +<b>on_copyButton_clicked</b>(<i></i>) + +<p> + Private slot to copy the requirements text to the clipboard. +</p> +<a NAME="CondaExportDialog.on_insertButton_clicked" ID="CondaExportDialog.on_insertButton_clicked"></a> +<h4>CondaExportDialog.on_insertButton_clicked</h4> +<b>on_insertButton_clicked</b>(<i></i>) + +<p> + Private slot to insert the requirements text at the cursor position + of the current editor. +</p> +<a NAME="CondaExportDialog.on_replaceAllButton_clicked" ID="CondaExportDialog.on_replaceAllButton_clicked"></a> +<h4>CondaExportDialog.on_replaceAllButton_clicked</h4> +<b>on_replaceAllButton_clicked</b>(<i></i>) + +<p> + Private slot to replace the text of the current editor with the + requirements text. +</p> +<a NAME="CondaExportDialog.on_replaceSelectionButton_clicked" ID="CondaExportDialog.on_replaceSelectionButton_clicked"></a> +<h4>CondaExportDialog.on_replaceSelectionButton_clicked</h4> +<b>on_replaceSelectionButton_clicked</b>(<i></i>) + +<p> + Private slot to replace the selected text of the current editor + with the requirements text. +</p> +<a NAME="CondaExportDialog.on_requirementsEdit_textChanged" ID="CondaExportDialog.on_requirementsEdit_textChanged"></a> +<h4>CondaExportDialog.on_requirementsEdit_textChanged</h4> +<b>on_requirementsEdit_textChanged</b>(<i></i>) + +<p> + Private slot handling changes of the requirements text. +</p> +<a NAME="CondaExportDialog.on_requirementsFilePicker_textChanged" ID="CondaExportDialog.on_requirementsFilePicker_textChanged"></a> +<h4>CondaExportDialog.on_requirementsFilePicker_textChanged</h4> +<b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) + +<p> + Private slot handling a change of the requirements file name. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +name of the requirements file +</dd> +</dl> +<a NAME="CondaExportDialog.on_saveButton_clicked" ID="CondaExportDialog.on_saveButton_clicked"></a> +<h4>CondaExportDialog.on_saveButton_clicked</h4> +<b>on_saveButton_clicked</b>(<i></i>) + +<p> + Private slot to save the requirements text to the requirements file. +</p> +<a NAME="CondaExportDialog.on_saveToButton_clicked" ID="CondaExportDialog.on_saveToButton_clicked"></a> +<h4>CondaExportDialog.on_saveToButton_clicked</h4> +<b>on_saveToButton_clicked</b>(<i></i>) + +<p> + Private slot to write the requirements text to a new file. +</p> +<a NAME="CondaExportDialog.start" ID="CondaExportDialog.start"></a> +<h4>CondaExportDialog.start</h4> +<b>start</b>(<i></i>) + +<p> + Public method to start the command. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file