Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html

changeset 6333
3d4e7155d48f
parent 6047
39586a2de99d
child 6343
86cea8abd0f7
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html	Fri Jun 08 19:31:38 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html	Fri Jun 08 19:32:41 2018 +0200
@@ -73,19 +73,22 @@
 </table>
 <a NAME="PipPackagesInputDialog.__init__" ID="PipPackagesInputDialog.__init__"></a>
 <h4>PipPackagesInputDialog (Constructor)</h4>
-<b>PipPackagesInputDialog</b>(<i>plugin, title, parent=None</i>)
+<b>PipPackagesInputDialog</b>(<i>plugin, title, install=True, parent=None</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>plugin</i></dt>
+<dt><i>plugin</i> (ToolPipPlugin)</dt>
 <dd>
-reference to the plugin object (ToolPipPlugin)
-</dd><dt><i>title</i></dt>
+reference to the plugin object
+</dd><dt><i>title</i> (str)</dt>
 <dd>
-dialog title (string)
-</dd><dt><i>parent</i></dt>
+dialog title
+</dd><dt><i>install</i> (bool)</dt>
 <dd>
-reference to the parent widget (QWidget)
+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>
@@ -95,8 +98,13 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-tuple with the pip command (string) and the list of
-            package specifications (list of string)
+tuple with the pip command, 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 (str, list of str, bool)
 </dd>
 </dl><a NAME="PipPackagesInputDialog.on_packagesEdit_textChanged" ID="PipPackagesInputDialog.on_packagesEdit_textChanged"></a>
 <h4>PipPackagesInputDialog.on_packagesEdit_textChanged</h4>

eric ide

mercurial