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

branch
maintenance
changeset 6826
c6dda2cbe081
parent 6764
d14ddbfbbd36
parent 6825
e659bb96cdfa
child 6827
14680839ad7a
equal deleted inserted replaced
6764:d14ddbfbbd36 6826:c6dda2cbe081
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog</h1>
23 <p>
24 Module implementing a dialog to enter package specifications.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#PipPackagesInputDialog">PipPackagesInputDialog</a></td>
34 <td>Class implementing a dialog to enter package specifications.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="PipPackagesInputDialog" ID="PipPackagesInputDialog"></a>
43 <h2>PipPackagesInputDialog</h2>
44 <p>
45 Class implementing a dialog to enter package specifications.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_PipPackagesInputDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#PipPackagesInputDialog.__init__">PipPackagesInputDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#PipPackagesInputDialog.getData">getData</a></td>
64 <td>Public method to get the entered data.</td>
65 </tr><tr>
66 <td><a href="#PipPackagesInputDialog.on_packagesEdit_textChanged">on_packagesEdit_textChanged</a></td>
67 <td>Private slot handling entering package names.</td>
68 </tr>
69 </table>
70 <h3>Static Methods</h3>
71 <table>
72 <tr><td>None</td></tr>
73 </table>
74 <a NAME="PipPackagesInputDialog.__init__" ID="PipPackagesInputDialog.__init__"></a>
75 <h4>PipPackagesInputDialog (Constructor)</h4>
76 <b>PipPackagesInputDialog</b>(<i>pip, title, install=True, parent=None</i>)
77 <p>
78 Constructor
79 </p><dl>
80 <dt><i>pip</i> (Pip)</dt>
81 <dd>
82 reference to the pip object
83 </dd><dt><i>title</i> (str)</dt>
84 <dd>
85 dialog title
86 </dd><dt><i>install</i> (bool)</dt>
87 <dd>
88 flag indicating an install action
89 </dd><dt><i>parent</i> (QWidget)</dt>
90 <dd>
91 reference to the parent widget
92 </dd>
93 </dl><a NAME="PipPackagesInputDialog.getData" ID="PipPackagesInputDialog.getData"></a>
94 <h4>PipPackagesInputDialog.getData</h4>
95 <b>getData</b>(<i></i>)
96 <p>
97 Public method to get the entered data.
98 </p><dl>
99 <dt>Returns:</dt>
100 <dd>
101 tuple with the environment name, the list of package
102 specifications and a flag indicating to install to the user
103 install directory
104 </dd>
105 </dl><dl>
106 <dt>Return Type:</dt>
107 <dd>
108 tuple of (str, list of str, bool)
109 </dd>
110 </dl><a NAME="PipPackagesInputDialog.on_packagesEdit_textChanged" ID="PipPackagesInputDialog.on_packagesEdit_textChanged"></a>
111 <h4>PipPackagesInputDialog.on_packagesEdit_textChanged</h4>
112 <b>on_packagesEdit_textChanged</b>(<i>txt</i>)
113 <p>
114 Private slot handling entering package names.
115 </p><dl>
116 <dt><i>txt</i> (str)</dt>
117 <dd>
118 name of the requirements file
119 </dd>
120 </dl>
121 <div align="right"><a href="#top">Up</a></div>
122 <hr />
123 </body></html>

eric ide

mercurial