src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesInputDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.PipInterface.PipPackagesInputDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PipInterface.PipPackagesInputDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter package specifications.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#PipPackagesInputDialog">PipPackagesInputDialog</a></td>
25 <td>Class implementing a dialog to enter package specifications.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="PipPackagesInputDialog" ID="PipPackagesInputDialog"></a>
36 <h2>PipPackagesInputDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter package specifications.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_PipPackagesInputDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#PipPackagesInputDialog.__init__">PipPackagesInputDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#PipPackagesInputDialog.getData">getData</a></td>
63 <td>Public method to get the entered data.</td>
64 </tr>
65 <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
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75
76 <a NAME="PipPackagesInputDialog.__init__" ID="PipPackagesInputDialog.__init__"></a>
77 <h4>PipPackagesInputDialog (Constructor)</h4>
78 <b>PipPackagesInputDialog</b>(<i>pip, title, install=True, parent=None</i>)
79
80 <p>
81 Constructor
82 </p>
83 <dl>
84
85 <dt><i>pip</i> (Pip)</dt>
86 <dd>
87 reference to the pip object
88 </dd>
89 <dt><i>title</i> (str)</dt>
90 <dd>
91 dialog title
92 </dd>
93 <dt><i>install</i> (bool)</dt>
94 <dd>
95 flag indicating an install action
96 </dd>
97 <dt><i>parent</i> (QWidget)</dt>
98 <dd>
99 reference to the parent widget
100 </dd>
101 </dl>
102 <a NAME="PipPackagesInputDialog.getData" ID="PipPackagesInputDialog.getData"></a>
103 <h4>PipPackagesInputDialog.getData</h4>
104 <b>getData</b>(<i></i>)
105
106 <p>
107 Public method to get the entered data.
108 </p>
109 <dl>
110 <dt>Return:</dt>
111 <dd>
112 tuple with the list of package specifications and a flag
113 indicating to install to the user install directory
114 </dd>
115 </dl>
116 <dl>
117 <dt>Return Type:</dt>
118 <dd>
119 tuple of (list of str, bool)
120 </dd>
121 </dl>
122 <a NAME="PipPackagesInputDialog.on_packagesEdit_textChanged" ID="PipPackagesInputDialog.on_packagesEdit_textChanged"></a>
123 <h4>PipPackagesInputDialog.on_packagesEdit_textChanged</h4>
124 <b>on_packagesEdit_textChanged</b>(<i>txt</i>)
125
126 <p>
127 Private slot handling entering package names.
128 </p>
129 <dl>
130
131 <dt><i>txt</i> (str)</dt>
132 <dd>
133 name of the requirements file
134 </dd>
135 </dl>
136 <div align="right"><a href="#top">Up</a></div>
137 <hr />
138 </body></html>

eric ide

mercurial