76 <td>Private slot called by a button of the button box clicked.</td> |
76 <td>Private slot called by a button of the button box clicked.</td> |
77 </tr><tr> |
77 </tr><tr> |
78 <td><a href="#PipFreezeDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> |
78 <td><a href="#PipFreezeDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> |
79 <td>Private slot to copy the requirements text to the clipboard.</td> |
79 <td>Private slot to copy the requirements text to the clipboard.</td> |
80 </tr><tr> |
80 </tr><tr> |
81 <td><a href="#PipFreezeDialog.on_fileButton_clicked">on_fileButton_clicked</a></td> |
|
82 <td>Private slot to enter the requirements file via a file selection dialog.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#PipFreezeDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> |
81 <td><a href="#PipFreezeDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> |
85 <td>Private slot to insert the requirements text at the cursor position of the current editor.</td> |
82 <td>Private slot to insert the requirements text at the cursor position of the current editor.</td> |
86 </tr><tr> |
83 </tr><tr> |
87 <td><a href="#PipFreezeDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td> |
84 <td><a href="#PipFreezeDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td> |
88 <td>Private slot handling the switching of the local mode.</td> |
85 <td>Private slot handling the switching of the local mode.</td> |
89 </tr><tr> |
86 </tr><tr> |
90 <td><a href="#PipFreezeDialog.on_pipComboBox_activated">on_pipComboBox_activated</a></td> |
|
91 <td>Private slot handling the selection of a pip executable.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#PipFreezeDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> |
87 <td><a href="#PipFreezeDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> |
94 <td>Private slot to replace the text of the current editor with the requirements text.</td> |
88 <td>Private slot to replace the text of the current editor with the requirements text.</td> |
95 </tr><tr> |
89 </tr><tr> |
96 <td><a href="#PipFreezeDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> |
90 <td><a href="#PipFreezeDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> |
97 <td>Private slot to replace the selected text of the current editor with the requirements text.</td> |
91 <td>Private slot to replace the selected text of the current editor with the requirements text.</td> |
98 </tr><tr> |
92 </tr><tr> |
99 <td><a href="#PipFreezeDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> |
93 <td><a href="#PipFreezeDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> |
100 <td>Private slot handling changes of the requirements text.</td> |
94 <td>Private slot handling changes of the requirements text.</td> |
101 </tr><tr> |
95 </tr><tr> |
102 <td><a href="#PipFreezeDialog.on_requirementsFileEdit_textChanged">on_requirementsFileEdit_textChanged</a></td> |
96 <td><a href="#PipFreezeDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> |
103 <td>Private slot handling a change of the requirements file name.</td> |
97 <td>Private slot handling a change of the requirements file name.</td> |
104 </tr><tr> |
98 </tr><tr> |
105 <td><a href="#PipFreezeDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
99 <td><a href="#PipFreezeDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
106 <td>Private slot to save the requirements text to the requirements file.</td> |
100 <td>Private slot to save the requirements text to the requirements file.</td> |
107 </tr><tr> |
101 </tr><tr> |
108 <td><a href="#PipFreezeDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> |
102 <td><a href="#PipFreezeDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> |
109 <td>Private slot to write the requirements text to a new file.</td> |
103 <td>Private slot to write the requirements text to a new file.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#PipFreezeDialog.on_venvComboBox_activated">on_venvComboBox_activated</a></td> |
|
106 <td>Private slot handling the selection of a virtual environment.</td> |
110 </tr><tr> |
107 </tr><tr> |
111 <td><a href="#PipFreezeDialog.start">start</a></td> |
108 <td><a href="#PipFreezeDialog.start">start</a></td> |
112 <td>Public method to start the command.</td> |
109 <td>Public method to start the command.</td> |
113 </tr> |
110 </tr> |
114 </table> |
111 </table> |
116 <table> |
113 <table> |
117 <tr><td>None</td></tr> |
114 <tr><td>None</td></tr> |
118 </table> |
115 </table> |
119 <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a> |
116 <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a> |
120 <h4>PipFreezeDialog (Constructor)</h4> |
117 <h4>PipFreezeDialog (Constructor)</h4> |
121 <b>PipFreezeDialog</b>(<i>pip, plugin, parent=None</i>) |
118 <b>PipFreezeDialog</b>(<i>pip, parent=None</i>) |
122 <p> |
119 <p> |
123 Constructor |
120 Constructor |
124 </p><dl> |
121 </p><dl> |
125 <dt><i>pip</i></dt> |
122 <dt><i>pip</i> (Pip)</dt> |
126 <dd> |
123 <dd> |
127 reference to the master object (Pip) |
124 reference to the master object |
128 </dd><dt><i>plugin</i></dt> |
125 </dd><dt><i>parent</i> (QWidget)</dt> |
129 <dd> |
126 <dd> |
130 reference to the plugin object (ToolPipPlugin) |
127 reference to the parent widget |
131 </dd><dt><i>parent</i></dt> |
|
132 <dd> |
|
133 reference to the parent widget (QWidget) |
|
134 </dd> |
128 </dd> |
135 </dl><a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a> |
129 </dl><a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a> |
136 <h4>PipFreezeDialog.__refresh</h4> |
130 <h4>PipFreezeDialog.__refresh</h4> |
137 <b>__refresh</b>(<i></i>) |
131 <b>__refresh</b>(<i></i>) |
138 <p> |
132 <p> |
146 <h4>PipFreezeDialog.__writeToFile</h4> |
140 <h4>PipFreezeDialog.__writeToFile</h4> |
147 <b>__writeToFile</b>(<i>fileName</i>) |
141 <b>__writeToFile</b>(<i>fileName</i>) |
148 <p> |
142 <p> |
149 Private method to write the requirements text to a file. |
143 Private method to write the requirements text to a file. |
150 </p><dl> |
144 </p><dl> |
151 <dt><i>fileName</i></dt> |
145 <dt><i>fileName</i> (str)</dt> |
152 <dd> |
146 <dd> |
153 name of the file to write to (string) |
147 name of the file to write to |
154 </dd> |
148 </dd> |
155 </dl><a NAME="PipFreezeDialog.closeEvent" ID="PipFreezeDialog.closeEvent"></a> |
149 </dl><a NAME="PipFreezeDialog.closeEvent" ID="PipFreezeDialog.closeEvent"></a> |
156 <h4>PipFreezeDialog.closeEvent</h4> |
150 <h4>PipFreezeDialog.closeEvent</h4> |
157 <b>closeEvent</b>(<i>e</i>) |
151 <b>closeEvent</b>(<i>e</i>) |
158 <p> |
152 <p> |
159 Protected slot implementing a close event handler. |
153 Protected slot implementing a close event handler. |
160 </p><dl> |
154 </p><dl> |
161 <dt><i>e</i></dt> |
155 <dt><i>e</i> (QCloseEvent)</dt> |
162 <dd> |
156 <dd> |
163 close event (QCloseEvent) |
157 close event |
164 </dd> |
158 </dd> |
165 </dl><a NAME="PipFreezeDialog.on_buttonBox_clicked" ID="PipFreezeDialog.on_buttonBox_clicked"></a> |
159 </dl><a NAME="PipFreezeDialog.on_buttonBox_clicked" ID="PipFreezeDialog.on_buttonBox_clicked"></a> |
166 <h4>PipFreezeDialog.on_buttonBox_clicked</h4> |
160 <h4>PipFreezeDialog.on_buttonBox_clicked</h4> |
167 <b>on_buttonBox_clicked</b>(<i>button</i>) |
161 <b>on_buttonBox_clicked</b>(<i>button</i>) |
168 <p> |
162 <p> |
169 Private slot called by a button of the button box clicked. |
163 Private slot called by a button of the button box clicked. |
170 </p><dl> |
164 </p><dl> |
171 <dt><i>button</i></dt> |
165 <dt><i>button</i> (QAbstractButton)</dt> |
172 <dd> |
166 <dd> |
173 button that was clicked (QAbstractButton) |
167 button that was clicked |
174 </dd> |
168 </dd> |
175 </dl><a NAME="PipFreezeDialog.on_copyButton_clicked" ID="PipFreezeDialog.on_copyButton_clicked"></a> |
169 </dl><a NAME="PipFreezeDialog.on_copyButton_clicked" ID="PipFreezeDialog.on_copyButton_clicked"></a> |
176 <h4>PipFreezeDialog.on_copyButton_clicked</h4> |
170 <h4>PipFreezeDialog.on_copyButton_clicked</h4> |
177 <b>on_copyButton_clicked</b>(<i></i>) |
171 <b>on_copyButton_clicked</b>(<i></i>) |
178 <p> |
172 <p> |
179 Private slot to copy the requirements text to the clipboard. |
173 Private slot to copy the requirements text to the clipboard. |
180 </p><a NAME="PipFreezeDialog.on_fileButton_clicked" ID="PipFreezeDialog.on_fileButton_clicked"></a> |
|
181 <h4>PipFreezeDialog.on_fileButton_clicked</h4> |
|
182 <b>on_fileButton_clicked</b>(<i></i>) |
|
183 <p> |
|
184 Private slot to enter the requirements file via a file selection |
|
185 dialog. |
|
186 </p><a NAME="PipFreezeDialog.on_insertButton_clicked" ID="PipFreezeDialog.on_insertButton_clicked"></a> |
174 </p><a NAME="PipFreezeDialog.on_insertButton_clicked" ID="PipFreezeDialog.on_insertButton_clicked"></a> |
187 <h4>PipFreezeDialog.on_insertButton_clicked</h4> |
175 <h4>PipFreezeDialog.on_insertButton_clicked</h4> |
188 <b>on_insertButton_clicked</b>(<i></i>) |
176 <b>on_insertButton_clicked</b>(<i></i>) |
189 <p> |
177 <p> |
190 Private slot to insert the requirements text at the cursor position |
178 Private slot to insert the requirements text at the cursor position |
193 <h4>PipFreezeDialog.on_localCheckBox_clicked</h4> |
181 <h4>PipFreezeDialog.on_localCheckBox_clicked</h4> |
194 <b>on_localCheckBox_clicked</b>(<i>checked</i>) |
182 <b>on_localCheckBox_clicked</b>(<i>checked</i>) |
195 <p> |
183 <p> |
196 Private slot handling the switching of the local mode. |
184 Private slot handling the switching of the local mode. |
197 </p><dl> |
185 </p><dl> |
198 <dt><i>checked</i></dt> |
186 <dt><i>checked</i> (bool)</dt> |
199 <dd> |
187 <dd> |
200 state of the local check box (boolean) |
188 state of the local check box |
201 </dd> |
|
202 </dl><a NAME="PipFreezeDialog.on_pipComboBox_activated" ID="PipFreezeDialog.on_pipComboBox_activated"></a> |
|
203 <h4>PipFreezeDialog.on_pipComboBox_activated</h4> |
|
204 <b>on_pipComboBox_activated</b>(<i>txt</i>) |
|
205 <p> |
|
206 Private slot handling the selection of a pip executable. |
|
207 </p><dl> |
|
208 <dt><i>txt</i></dt> |
|
209 <dd> |
|
210 path of the pip executable (string) |
|
211 </dd> |
189 </dd> |
212 </dl><a NAME="PipFreezeDialog.on_replaceAllButton_clicked" ID="PipFreezeDialog.on_replaceAllButton_clicked"></a> |
190 </dl><a NAME="PipFreezeDialog.on_replaceAllButton_clicked" ID="PipFreezeDialog.on_replaceAllButton_clicked"></a> |
213 <h4>PipFreezeDialog.on_replaceAllButton_clicked</h4> |
191 <h4>PipFreezeDialog.on_replaceAllButton_clicked</h4> |
214 <b>on_replaceAllButton_clicked</b>(<i></i>) |
192 <b>on_replaceAllButton_clicked</b>(<i></i>) |
215 <p> |
193 <p> |
224 </p><a NAME="PipFreezeDialog.on_requirementsEdit_textChanged" ID="PipFreezeDialog.on_requirementsEdit_textChanged"></a> |
202 </p><a NAME="PipFreezeDialog.on_requirementsEdit_textChanged" ID="PipFreezeDialog.on_requirementsEdit_textChanged"></a> |
225 <h4>PipFreezeDialog.on_requirementsEdit_textChanged</h4> |
203 <h4>PipFreezeDialog.on_requirementsEdit_textChanged</h4> |
226 <b>on_requirementsEdit_textChanged</b>(<i></i>) |
204 <b>on_requirementsEdit_textChanged</b>(<i></i>) |
227 <p> |
205 <p> |
228 Private slot handling changes of the requirements text. |
206 Private slot handling changes of the requirements text. |
229 </p><a NAME="PipFreezeDialog.on_requirementsFileEdit_textChanged" ID="PipFreezeDialog.on_requirementsFileEdit_textChanged"></a> |
207 </p><a NAME="PipFreezeDialog.on_requirementsFilePicker_textChanged" ID="PipFreezeDialog.on_requirementsFilePicker_textChanged"></a> |
230 <h4>PipFreezeDialog.on_requirementsFileEdit_textChanged</h4> |
208 <h4>PipFreezeDialog.on_requirementsFilePicker_textChanged</h4> |
231 <b>on_requirementsFileEdit_textChanged</b>(<i>txt</i>) |
209 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) |
232 <p> |
210 <p> |
233 Private slot handling a change of the requirements file name. |
211 Private slot handling a change of the requirements file name. |
234 </p><dl> |
212 </p><dl> |
235 <dt><i>txt</i></dt> |
213 <dt><i>txt</i> (str)</dt> |
236 <dd> |
214 <dd> |
237 name of the requirements file (string) |
215 name of the requirements file |
238 </dd> |
216 </dd> |
239 </dl><a NAME="PipFreezeDialog.on_saveButton_clicked" ID="PipFreezeDialog.on_saveButton_clicked"></a> |
217 </dl><a NAME="PipFreezeDialog.on_saveButton_clicked" ID="PipFreezeDialog.on_saveButton_clicked"></a> |
240 <h4>PipFreezeDialog.on_saveButton_clicked</h4> |
218 <h4>PipFreezeDialog.on_saveButton_clicked</h4> |
241 <b>on_saveButton_clicked</b>(<i></i>) |
219 <b>on_saveButton_clicked</b>(<i></i>) |
242 <p> |
220 <p> |
244 </p><a NAME="PipFreezeDialog.on_saveToButton_clicked" ID="PipFreezeDialog.on_saveToButton_clicked"></a> |
222 </p><a NAME="PipFreezeDialog.on_saveToButton_clicked" ID="PipFreezeDialog.on_saveToButton_clicked"></a> |
245 <h4>PipFreezeDialog.on_saveToButton_clicked</h4> |
223 <h4>PipFreezeDialog.on_saveToButton_clicked</h4> |
246 <b>on_saveToButton_clicked</b>(<i></i>) |
224 <b>on_saveToButton_clicked</b>(<i></i>) |
247 <p> |
225 <p> |
248 Private slot to write the requirements text to a new file. |
226 Private slot to write the requirements text to a new file. |
249 </p><a NAME="PipFreezeDialog.start" ID="PipFreezeDialog.start"></a> |
227 </p><a NAME="PipFreezeDialog.on_venvComboBox_activated" ID="PipFreezeDialog.on_venvComboBox_activated"></a> |
|
228 <h4>PipFreezeDialog.on_venvComboBox_activated</h4> |
|
229 <b>on_venvComboBox_activated</b>(<i>txt</i>) |
|
230 <p> |
|
231 Private slot handling the selection of a virtual environment. |
|
232 </p><dl> |
|
233 <dt><i>txt</i> (str)</dt> |
|
234 <dd> |
|
235 virtual environment |
|
236 </dd> |
|
237 </dl><a NAME="PipFreezeDialog.start" ID="PipFreezeDialog.start"></a> |
250 <h4>PipFreezeDialog.start</h4> |
238 <h4>PipFreezeDialog.start</h4> |
251 <b>start</b>(<i></i>) |
239 <b>start</b>(<i></i>) |
252 <p> |
240 <p> |
253 Public method to start the command. |
241 Public method to start the command. |
254 </p> |
242 </p> |