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

changeset 6343
86cea8abd0f7
parent 6011
e6af0dcfbb35
equal deleted inserted replaced
6342:c79ecba9cde7 6343:86cea8abd0f7
29 </table> 29 </table>
30 <h3>Classes</h3> 30 <h3>Classes</h3>
31 <table> 31 <table>
32 <tr> 32 <tr>
33 <td><a href="#PipDialog">PipDialog</a></td> 33 <td><a href="#PipDialog">PipDialog</a></td>
34 <td>Class implementing a dialog showing the output of a pip command.</td> 34 <td>Class implementing a dialog showing the output of a 'python -m pip' command.</td>
35 </tr> 35 </tr>
36 </table> 36 </table>
37 <h3>Functions</h3> 37 <h3>Functions</h3>
38 <table> 38 <table>
39 <tr><td>None</td></tr> 39 <tr><td>None</td></tr>
40 </table> 40 </table>
41 <hr /><hr /> 41 <hr /><hr />
42 <a NAME="PipDialog" ID="PipDialog"></a> 42 <a NAME="PipDialog" ID="PipDialog"></a>
43 <h2>PipDialog</h2> 43 <h2>PipDialog</h2>
44 <p> 44 <p>
45 Class implementing a dialog showing the output of a pip command. 45 Class implementing a dialog showing the output of a 'python -m pip'
46 command.
46 </p> 47 </p>
47 <h3>Derived from</h3> 48 <h3>Derived from</h3>
48 QDialog, Ui_PipDialog 49 QDialog, Ui_PipDialog
49 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
50 <table> 51 <table>
96 <h4>PipDialog (Constructor)</h4> 97 <h4>PipDialog (Constructor)</h4>
97 <b>PipDialog</b>(<i>text, parent=None</i>) 98 <b>PipDialog</b>(<i>text, parent=None</i>)
98 <p> 99 <p>
99 Constructor 100 Constructor
100 </p><dl> 101 </p><dl>
101 <dt><i>text</i></dt> 102 <dt><i>text</i> (str)</dt>
102 <dd> 103 <dd>
103 text to be shown by the label (string) 104 text to be shown by the label
104 </dd><dt><i>parent</i></dt> 105 </dd><dt><i>parent</i> (QWidget)</dt>
105 <dd> 106 <dd>
106 reference to the parent widget (QWidget) 107 reference to the parent widget
107 </dd> 108 </dd>
108 </dl><a NAME="PipDialog.__addOutput" ID="PipDialog.__addOutput"></a> 109 </dl><a NAME="PipDialog.__addOutput" ID="PipDialog.__addOutput"></a>
109 <h4>PipDialog.__addOutput</h4> 110 <h4>PipDialog.__addOutput</h4>
110 <b>__addOutput</b>(<i>txt</i>) 111 <b>__addOutput</b>(<i>txt</i>)
111 <p> 112 <p>
125 <h4>PipDialog.__procFinished</h4> 126 <h4>PipDialog.__procFinished</h4>
126 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 127 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
127 <p> 128 <p>
128 Private slot connected to the finished signal. 129 Private slot connected to the finished signal.
129 </p><dl> 130 </p><dl>
130 <dt><i>exitCode</i></dt> 131 <dt><i>exitCode</i> (int)</dt>
131 <dd> 132 <dd>
132 exit code of the process (integer) 133 exit code of the process
133 </dd><dt><i>exitStatus</i></dt> 134 </dd><dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
134 <dd> 135 <dd>
135 exit status of the process (QProcess.ExitStatus) 136 exit status of the process
136 </dd> 137 </dd>
137 </dl><a NAME="PipDialog.__readStderr" ID="PipDialog.__readStderr"></a> 138 </dl><a NAME="PipDialog.__readStderr" ID="PipDialog.__readStderr"></a>
138 <h4>PipDialog.__readStderr</h4> 139 <h4>PipDialog.__readStderr</h4>
139 <b>__readStderr</b>(<i></i>) 140 <b>__readStderr</b>(<i></i>)
140 <p> 141 <p>
154 <h4>PipDialog.closeEvent</h4> 155 <h4>PipDialog.closeEvent</h4>
155 <b>closeEvent</b>(<i>e</i>) 156 <b>closeEvent</b>(<i>e</i>)
156 <p> 157 <p>
157 Protected slot implementing a close event handler. 158 Protected slot implementing a close event handler.
158 </p><dl> 159 </p><dl>
159 <dt><i>e</i></dt> 160 <dt><i>e</i> (QCloseEvent)</dt>
160 <dd> 161 <dd>
161 close event (QCloseEvent) 162 close event
162 </dd> 163 </dd>
163 </dl><a NAME="PipDialog.on_buttonBox_clicked" ID="PipDialog.on_buttonBox_clicked"></a> 164 </dl><a NAME="PipDialog.on_buttonBox_clicked" ID="PipDialog.on_buttonBox_clicked"></a>
164 <h4>PipDialog.on_buttonBox_clicked</h4> 165 <h4>PipDialog.on_buttonBox_clicked</h4>
165 <b>on_buttonBox_clicked</b>(<i>button</i>) 166 <b>on_buttonBox_clicked</b>(<i>button</i>)
166 <p> 167 <p>
167 Private slot called by a button of the button box clicked. 168 Private slot called by a button of the button box clicked.
168 </p><dl> 169 </p><dl>
169 <dt><i>button</i></dt> 170 <dt><i>button</i> (QAbstractButton)</dt>
170 <dd> 171 <dd>
171 button that was clicked (QAbstractButton) 172 button that was clicked
172 </dd> 173 </dd>
173 </dl><a NAME="PipDialog.startProcess" ID="PipDialog.startProcess"></a> 174 </dl><a NAME="PipDialog.startProcess" ID="PipDialog.startProcess"></a>
174 <h4>PipDialog.startProcess</h4> 175 <h4>PipDialog.startProcess</h4>
175 <b>startProcess</b>(<i>cmd, args, showArgs=True</i>) 176 <b>startProcess</b>(<i>cmd, args, showArgs=True</i>)
176 <p> 177 <p>
177 Public slot used to start the process. 178 Public slot used to start the process.
178 </p><dl> 179 </p><dl>
179 <dt><i>cmd</i></dt> 180 <dt><i>cmd</i> (str)</dt>
180 <dd> 181 <dd>
181 name of the pip executable to be used (string) 182 name of the pip executable to be used
182 </dd><dt><i>args</i></dt> 183 </dd><dt><i>args</i> (list of str)</dt>
183 <dd> 184 <dd>
184 list of arguments for the process (list of strings) 185 list of arguments for the process
185 </dd><dt><i>showArgs=</i></dt> 186 </dd><dt><i>showArgs=</i> (bool)</dt>
186 <dd> 187 <dd>
187 flag indicating to show the arguments (boolean) 188 flag indicating to show the arguments
188 </dd> 189 </dd>
189 </dl><dl> 190 </dl><dl>
190 <dt>Returns:</dt> 191 <dt>Returns:</dt>
191 <dd> 192 <dd>
192 flag indicating a successful start of the process 193 flag indicating a successful start of the process
194 </dd>
195 </dl><dl>
196 <dt>Return Type:</dt>
197 <dd>
198 bool
193 </dd> 199 </dd>
194 </dl><a NAME="PipDialog.startProcesses" ID="PipDialog.startProcesses"></a> 200 </dl><a NAME="PipDialog.startProcesses" ID="PipDialog.startProcesses"></a>
195 <h4>PipDialog.startProcesses</h4> 201 <h4>PipDialog.startProcesses</h4>
196 <b>startProcesses</b>(<i>processParams</i>) 202 <b>startProcesses</b>(<i>processParams</i>)
197 <p> 203 <p>
198 Public method to issue a list of commands to be executed. 204 Public method to issue a list of commands to be executed.
199 </p><dl> 205 </p><dl>
200 <dt><i>processParams</i> (list of tuples of str and list of str)</dt> 206 <dt><i>processParams</i> (list of tuples of (str, list of str))</dt>
201 <dd> 207 <dd>
202 list of tuples containing the command 208 list of tuples containing the command
203 and arguments 209 and arguments
204 </dd> 210 </dd>
205 </dl><dl> 211 </dl><dl>

eric ide

mercurial