diff -r 7ef7d47a0ad5 -r e6af0dcfbb35 Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipRequirementsSelectionDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipRequirementsSelectionDialog.html Sat Dec 09 18:32:08 2017 +0100 @@ -0,0 +1,120 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipRequirementsSelectionDialog</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>eric6.Plugins.UiExtensionPlugins.PipInterface.PipRequirementsSelectionDialog</h1> +<p> +Module implementing a dialog to enter a requirements file. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PipRequirementsSelectionDialog">PipRequirementsSelectionDialog</a></td> +<td>Class implementing a dialog to enter a requirements file.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PipRequirementsSelectionDialog" ID="PipRequirementsSelectionDialog"></a> +<h2>PipRequirementsSelectionDialog</h2> +<p> + Class implementing a dialog to enter a requirements file. +</p> +<h3>Derived from</h3> +QDialog, Ui_PipRequirementsSelectionDialog +<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="#PipRequirementsSelectionDialog.__init__">PipRequirementsSelectionDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PipRequirementsSelectionDialog.getData">getData</a></td> +<td>Public method to get the entered data.</td> +</tr><tr> +<td><a href="#PipRequirementsSelectionDialog.on_fileButton_clicked">on_fileButton_clicked</a></td> +<td>Private slot to enter the requirements file via a file selection dialog.</td> +</tr><tr> +<td><a href="#PipRequirementsSelectionDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> +<td>Private slot handling entering the name of a requirements file.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PipRequirementsSelectionDialog.__init__" ID="PipRequirementsSelectionDialog.__init__"></a> +<h4>PipRequirementsSelectionDialog (Constructor)</h4> +<b>PipRequirementsSelectionDialog</b>(<i>plugin, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>plugin</i></dt> +<dd> +reference to the plugin object (ToolPipPlugin) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="PipRequirementsSelectionDialog.getData" ID="PipRequirementsSelectionDialog.getData"></a> +<h4>PipRequirementsSelectionDialog.getData</h4> +<b>getData</b>(<i></i>) +<p> + Public method to get the entered data. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple with the pip command (string) and the name of the + requirements file (string) +</dd> +</dl><a NAME="PipRequirementsSelectionDialog.on_fileButton_clicked" ID="PipRequirementsSelectionDialog.on_fileButton_clicked"></a> +<h4>PipRequirementsSelectionDialog.on_fileButton_clicked</h4> +<b>on_fileButton_clicked</b>(<i></i>) +<p> + Private slot to enter the requirements file via a file selection + dialog. +</p><a NAME="PipRequirementsSelectionDialog.on_requirementsEdit_textChanged" ID="PipRequirementsSelectionDialog.on_requirementsEdit_textChanged"></a> +<h4>PipRequirementsSelectionDialog.on_requirementsEdit_textChanged</h4> +<b>on_requirementsEdit_textChanged</b>(<i>txt</i>) +<p> + Private slot handling entering the name of a requirements file. +</p><dl> +<dt><i>txt</i></dt> +<dd> +name of the requirements file (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file