--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog.html Mon Feb 13 17:49:52 2023 +0100 @@ -0,0 +1,244 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog</h1> + +<p> +Module implementing a dialog to generate a requirements file. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#RequirementsDialog">RequirementsDialog</a></td> +<td>Class implementing a dialog to generate a requirements file.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="RequirementsDialog" ID="RequirementsDialog"></a> +<h2>RequirementsDialog</h2> + +<p> + Class implementing a dialog to generate a requirements file. +</p> +<h3>Derived from</h3> +QDialog, Ui_RequirementsDialog +<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="#RequirementsDialog.__init__">RequirementsDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#RequirementsDialog.__generateRequirements">__generateRequirements</a></td> +<td>Private slot to generate the requirements specifiers list.</td> +</tr> +<tr> +<td><a href="#RequirementsDialog.__updateButtons">__updateButtons</a></td> +<td>Private method to set the state of the various buttons.</td> +</tr> +<tr> +<td><a href="#RequirementsDialog.__writeToFile">__writeToFile</a></td> +<td>Private method to write the requirements text to a file.</td> +</tr> +<tr> +<td><a href="#RequirementsDialog.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="#RequirementsDialog.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="#RequirementsDialog.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="#RequirementsDialog.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="#RequirementsDialog.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="#RequirementsDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> +<td>Private slot handling changes of the requirements text.</td> +</tr> +<tr> +<td><a href="#RequirementsDialog.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="#RequirementsDialog.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="#RequirementsDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> +<td>Private slot to write the requirements text to a new file.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="RequirementsDialog.__init__" ID="RequirementsDialog.__init__"></a> +<h4>RequirementsDialog (Constructor)</h4> +<b>RequirementsDialog</b>(<i>devicePath, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>devicePath</i> (str)</dt> +<dd> +path to the connected board +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="RequirementsDialog.__generateRequirements" ID="RequirementsDialog.__generateRequirements"></a> +<h4>RequirementsDialog.__generateRequirements</h4> +<b>__generateRequirements</b>(<i></i>) + +<p> + Private slot to generate the requirements specifiers list. +</p> +<a NAME="RequirementsDialog.__updateButtons" ID="RequirementsDialog.__updateButtons"></a> +<h4>RequirementsDialog.__updateButtons</h4> +<b>__updateButtons</b>(<i></i>) + +<p> + Private method to set the state of the various buttons. +</p> +<a NAME="RequirementsDialog.__writeToFile" ID="RequirementsDialog.__writeToFile"></a> +<h4>RequirementsDialog.__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="RequirementsDialog.on_buttonBox_clicked" ID="RequirementsDialog.on_buttonBox_clicked"></a> +<h4>RequirementsDialog.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="RequirementsDialog.on_copyButton_clicked" ID="RequirementsDialog.on_copyButton_clicked"></a> +<h4>RequirementsDialog.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="RequirementsDialog.on_insertButton_clicked" ID="RequirementsDialog.on_insertButton_clicked"></a> +<h4>RequirementsDialog.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="RequirementsDialog.on_replaceAllButton_clicked" ID="RequirementsDialog.on_replaceAllButton_clicked"></a> +<h4>RequirementsDialog.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="RequirementsDialog.on_replaceSelectionButton_clicked" ID="RequirementsDialog.on_replaceSelectionButton_clicked"></a> +<h4>RequirementsDialog.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="RequirementsDialog.on_requirementsEdit_textChanged" ID="RequirementsDialog.on_requirementsEdit_textChanged"></a> +<h4>RequirementsDialog.on_requirementsEdit_textChanged</h4> +<b>on_requirementsEdit_textChanged</b>(<i></i>) + +<p> + Private slot handling changes of the requirements text. +</p> +<a NAME="RequirementsDialog.on_requirementsFilePicker_textChanged" ID="RequirementsDialog.on_requirementsFilePicker_textChanged"></a> +<h4>RequirementsDialog.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="RequirementsDialog.on_saveButton_clicked" ID="RequirementsDialog.on_saveButton_clicked"></a> +<h4>RequirementsDialog.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="RequirementsDialog.on_saveToButton_clicked" ID="RequirementsDialog.on_saveToButton_clicked"></a> +<h4>RequirementsDialog.on_saveToButton_clicked</h4> +<b>on_saveToButton_clicked</b>(<i></i>) + +<p> + Private slot to write the requirements text to a new file. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file