Documentation/Source/eric6.PipInterface.PipPackagesInputDialog.html

changeset 6807
7e5eba19d86d
diff -r d306647cb82d -r 7e5eba19d86d Documentation/Source/eric6.PipInterface.PipPackagesInputDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.PipInterface.PipPackagesInputDialog.html	Sat Feb 23 16:05:36 2019 +0100
@@ -0,0 +1,122 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.PipInterface.PipPackagesInputDialog</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.PipInterface.PipPackagesInputDialog</h1>
+<p>
+Module implementing a dialog to enter package specifications.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipPackagesInputDialog">PipPackagesInputDialog</a></td>
+<td>Class implementing a dialog to enter package specifications.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="PipPackagesInputDialog" ID="PipPackagesInputDialog"></a>
+<h2>PipPackagesInputDialog</h2>
+<p>
+    Class implementing a dialog to enter package specifications.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_PipPackagesInputDialog
+<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="#PipPackagesInputDialog.__init__">PipPackagesInputDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#PipPackagesInputDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr><tr>
+<td><a href="#PipPackagesInputDialog.on_packagesEdit_textChanged">on_packagesEdit_textChanged</a></td>
+<td>Private slot handling entering package names.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="PipPackagesInputDialog.__init__" ID="PipPackagesInputDialog.__init__"></a>
+<h4>PipPackagesInputDialog (Constructor)</h4>
+<b>PipPackagesInputDialog</b>(<i>pip, title, install=True, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>pip</i> (Pip)</dt>
+<dd>
+reference to the pip object
+</dd><dt><i>title</i> (str)</dt>
+<dd>
+dialog title
+</dd><dt><i>install</i> (bool)</dt>
+<dd>
+flag indicating an install action
+</dd><dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl><a NAME="PipPackagesInputDialog.getData" ID="PipPackagesInputDialog.getData"></a>
+<h4>PipPackagesInputDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to get the entered data.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple with the list of package specifications and a flag
+            indicating to install to the user install directory
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, bool)
+</dd>
+</dl><a NAME="PipPackagesInputDialog.on_packagesEdit_textChanged" ID="PipPackagesInputDialog.on_packagesEdit_textChanged"></a>
+<h4>PipPackagesInputDialog.on_packagesEdit_textChanged</h4>
+<b>on_packagesEdit_textChanged</b>(<i>txt</i>)
+<p>
+        Private slot handling entering package names.
+</p><dl>
+<dt><i>txt</i> (str)</dt>
+<dd>
+name of the requirements file
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial