Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html

Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.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.PipFreezeDialog</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.PipFreezeDialog</h1>
23 <p>
24 Module implementing a dialog to generate a requirements file.
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="#PipFreezeDialog">PipFreezeDialog</a></td>
34 <td>Class implementing a dialog to generate a requirements file.</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="PipFreezeDialog" ID="PipFreezeDialog"></a>
43 <h2>PipFreezeDialog</h2>
44 <p>
45 Class implementing a dialog to generate a requirements file.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_PipFreezeDialog
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="#PipFreezeDialog.__init__">PipFreezeDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#PipFreezeDialog.__refresh">__refresh</a></td>
64 <td>Private slot to refresh the displayed list.</td>
65 </tr><tr>
66 <td><a href="#PipFreezeDialog.__updateButtons">__updateButtons</a></td>
67 <td>Private method to set the state of the various buttons.</td>
68 </tr><tr>
69 <td><a href="#PipFreezeDialog.__writeToFile">__writeToFile</a></td>
70 <td>Private method to write the requirements text to a file.</td>
71 </tr><tr>
72 <td><a href="#PipFreezeDialog.closeEvent">closeEvent</a></td>
73 <td>Protected slot implementing a close event handler.</td>
74 </tr><tr>
75 <td><a href="#PipFreezeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
76 <td>Private slot called by a button of the button box clicked.</td>
77 </tr><tr>
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>
80 </tr><tr>
81 <td><a href="#PipFreezeDialog.on_insertButton_clicked">on_insertButton_clicked</a></td>
82 <td>Private slot to insert the requirements text at the cursor position of the current editor.</td>
83 </tr><tr>
84 <td><a href="#PipFreezeDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td>
85 <td>Private slot handling the switching of the local mode.</td>
86 </tr><tr>
87 <td><a href="#PipFreezeDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td>
88 <td>Private slot to replace the text of the current editor with the requirements text.</td>
89 </tr><tr>
90 <td><a href="#PipFreezeDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td>
91 <td>Private slot to replace the selected text of the current editor with the requirements text.</td>
92 </tr><tr>
93 <td><a href="#PipFreezeDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td>
94 <td>Private slot handling changes of the requirements text.</td>
95 </tr><tr>
96 <td><a href="#PipFreezeDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td>
97 <td>Private slot handling a change of the requirements file name.</td>
98 </tr><tr>
99 <td><a href="#PipFreezeDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
100 <td>Private slot to save the requirements text to the requirements file.</td>
101 </tr><tr>
102 <td><a href="#PipFreezeDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></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>
107 </tr><tr>
108 <td><a href="#PipFreezeDialog.start">start</a></td>
109 <td>Public method to start the command.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116 <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a>
117 <h4>PipFreezeDialog (Constructor)</h4>
118 <b>PipFreezeDialog</b>(<i>pip, parent=None</i>)
119 <p>
120 Constructor
121 </p><dl>
122 <dt><i>pip</i> (Pip)</dt>
123 <dd>
124 reference to the master object
125 </dd><dt><i>parent</i> (QWidget)</dt>
126 <dd>
127 reference to the parent widget
128 </dd>
129 </dl><a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a>
130 <h4>PipFreezeDialog.__refresh</h4>
131 <b>__refresh</b>(<i></i>)
132 <p>
133 Private slot to refresh the displayed list.
134 </p><a NAME="PipFreezeDialog.__updateButtons" ID="PipFreezeDialog.__updateButtons"></a>
135 <h4>PipFreezeDialog.__updateButtons</h4>
136 <b>__updateButtons</b>(<i></i>)
137 <p>
138 Private method to set the state of the various buttons.
139 </p><a NAME="PipFreezeDialog.__writeToFile" ID="PipFreezeDialog.__writeToFile"></a>
140 <h4>PipFreezeDialog.__writeToFile</h4>
141 <b>__writeToFile</b>(<i>fileName</i>)
142 <p>
143 Private method to write the requirements text to a file.
144 </p><dl>
145 <dt><i>fileName</i> (str)</dt>
146 <dd>
147 name of the file to write to
148 </dd>
149 </dl><a NAME="PipFreezeDialog.closeEvent" ID="PipFreezeDialog.closeEvent"></a>
150 <h4>PipFreezeDialog.closeEvent</h4>
151 <b>closeEvent</b>(<i>e</i>)
152 <p>
153 Protected slot implementing a close event handler.
154 </p><dl>
155 <dt><i>e</i> (QCloseEvent)</dt>
156 <dd>
157 close event
158 </dd>
159 </dl><a NAME="PipFreezeDialog.on_buttonBox_clicked" ID="PipFreezeDialog.on_buttonBox_clicked"></a>
160 <h4>PipFreezeDialog.on_buttonBox_clicked</h4>
161 <b>on_buttonBox_clicked</b>(<i>button</i>)
162 <p>
163 Private slot called by a button of the button box clicked.
164 </p><dl>
165 <dt><i>button</i> (QAbstractButton)</dt>
166 <dd>
167 button that was clicked
168 </dd>
169 </dl><a NAME="PipFreezeDialog.on_copyButton_clicked" ID="PipFreezeDialog.on_copyButton_clicked"></a>
170 <h4>PipFreezeDialog.on_copyButton_clicked</h4>
171 <b>on_copyButton_clicked</b>(<i></i>)
172 <p>
173 Private slot to copy the requirements text to the clipboard.
174 </p><a NAME="PipFreezeDialog.on_insertButton_clicked" ID="PipFreezeDialog.on_insertButton_clicked"></a>
175 <h4>PipFreezeDialog.on_insertButton_clicked</h4>
176 <b>on_insertButton_clicked</b>(<i></i>)
177 <p>
178 Private slot to insert the requirements text at the cursor position
179 of the current editor.
180 </p><a NAME="PipFreezeDialog.on_localCheckBox_clicked" ID="PipFreezeDialog.on_localCheckBox_clicked"></a>
181 <h4>PipFreezeDialog.on_localCheckBox_clicked</h4>
182 <b>on_localCheckBox_clicked</b>(<i>checked</i>)
183 <p>
184 Private slot handling the switching of the local mode.
185 </p><dl>
186 <dt><i>checked</i> (bool)</dt>
187 <dd>
188 state of the local check box
189 </dd>
190 </dl><a NAME="PipFreezeDialog.on_replaceAllButton_clicked" ID="PipFreezeDialog.on_replaceAllButton_clicked"></a>
191 <h4>PipFreezeDialog.on_replaceAllButton_clicked</h4>
192 <b>on_replaceAllButton_clicked</b>(<i></i>)
193 <p>
194 Private slot to replace the text of the current editor with the
195 requirements text.
196 </p><a NAME="PipFreezeDialog.on_replaceSelectionButton_clicked" ID="PipFreezeDialog.on_replaceSelectionButton_clicked"></a>
197 <h4>PipFreezeDialog.on_replaceSelectionButton_clicked</h4>
198 <b>on_replaceSelectionButton_clicked</b>(<i></i>)
199 <p>
200 Private slot to replace the selected text of the current editor
201 with the requirements text.
202 </p><a NAME="PipFreezeDialog.on_requirementsEdit_textChanged" ID="PipFreezeDialog.on_requirementsEdit_textChanged"></a>
203 <h4>PipFreezeDialog.on_requirementsEdit_textChanged</h4>
204 <b>on_requirementsEdit_textChanged</b>(<i></i>)
205 <p>
206 Private slot handling changes of the requirements text.
207 </p><a NAME="PipFreezeDialog.on_requirementsFilePicker_textChanged" ID="PipFreezeDialog.on_requirementsFilePicker_textChanged"></a>
208 <h4>PipFreezeDialog.on_requirementsFilePicker_textChanged</h4>
209 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>)
210 <p>
211 Private slot handling a change of the requirements file name.
212 </p><dl>
213 <dt><i>txt</i> (str)</dt>
214 <dd>
215 name of the requirements file
216 </dd>
217 </dl><a NAME="PipFreezeDialog.on_saveButton_clicked" ID="PipFreezeDialog.on_saveButton_clicked"></a>
218 <h4>PipFreezeDialog.on_saveButton_clicked</h4>
219 <b>on_saveButton_clicked</b>(<i></i>)
220 <p>
221 Private slot to save the requirements text to the requirements file.
222 </p><a NAME="PipFreezeDialog.on_saveToButton_clicked" ID="PipFreezeDialog.on_saveToButton_clicked"></a>
223 <h4>PipFreezeDialog.on_saveToButton_clicked</h4>
224 <b>on_saveToButton_clicked</b>(<i></i>)
225 <p>
226 Private slot to write the requirements text to a new file.
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>
238 <h4>PipFreezeDialog.start</h4>
239 <b>start</b>(<i></i>)
240 <p>
241 Public method to start the command.
242 </p>
243 <div align="right"><a href="#top">Up</a></div>
244 <hr />
245 </body></html>

Mercurial Repository: eric

eric ide

mercurial