eric6/Documentation/Source/eric6.CondaInterface.CondaExportDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.CondaInterface.CondaExportDialog</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.CondaInterface.CondaExportDialog</h1>
23 <p>
24 Module implementing a dialog to generate a requirements file for conda.
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="#CondaExportDialog">CondaExportDialog</a></td>
34 <td>Class implementing a dialog to generate a requirements file for conda.</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="CondaExportDialog" ID="CondaExportDialog"></a>
43 <h2>CondaExportDialog</h2>
44 <p>
45 Class implementing a dialog to generate a requirements file for conda.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_CondaExportDialog
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="#CondaExportDialog.__init__">CondaExportDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#CondaExportDialog.__refresh">__refresh</a></td>
64 <td>Private slot to refresh the displayed list.</td>
65 </tr><tr>
66 <td><a href="#CondaExportDialog.__updateButtons">__updateButtons</a></td>
67 <td>Private method to set the state of the various buttons.</td>
68 </tr><tr>
69 <td><a href="#CondaExportDialog.__writeToFile">__writeToFile</a></td>
70 <td>Private method to write the requirements text to a file.</td>
71 </tr><tr>
72 <td><a href="#CondaExportDialog.closeEvent">closeEvent</a></td>
73 <td>Protected slot implementing a close event handler.</td>
74 </tr><tr>
75 <td><a href="#CondaExportDialog.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="#CondaExportDialog.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="#CondaExportDialog.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="#CondaExportDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td>
85 <td>Private slot to replace the text of the current editor with the requirements text.</td>
86 </tr><tr>
87 <td><a href="#CondaExportDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td>
88 <td>Private slot to replace the selected text of the current editor with the requirements text.</td>
89 </tr><tr>
90 <td><a href="#CondaExportDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td>
91 <td>Private slot handling changes of the requirements text.</td>
92 </tr><tr>
93 <td><a href="#CondaExportDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td>
94 <td>Private slot handling a change of the requirements file name.</td>
95 </tr><tr>
96 <td><a href="#CondaExportDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
97 <td>Private slot to save the requirements text to the requirements file.</td>
98 </tr><tr>
99 <td><a href="#CondaExportDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td>
100 <td>Private slot to write the requirements text to a new file.</td>
101 </tr><tr>
102 <td><a href="#CondaExportDialog.start">start</a></td>
103 <td>Public method to start the command.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107 <table>
108 <tr><td>None</td></tr>
109 </table>
110 <a NAME="CondaExportDialog.__init__" ID="CondaExportDialog.__init__"></a>
111 <h4>CondaExportDialog (Constructor)</h4>
112 <b>CondaExportDialog</b>(<i>conda, envName, envPrefix, parent=None</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>conda</i> (Conda)</dt>
117 <dd>
118 reference to the master object
119 </dd><dt><i>envName</i> (str)</dt>
120 <dd>
121 name of the environment to create the requirements
122 file from
123 </dd><dt><i>envPrefix</i> (str)</dt>
124 <dd>
125 prefix of the environment to create the requirements
126 file from
127 </dd><dt><i>parent</i> (QWidget)</dt>
128 <dd>
129 reference to the parent widget
130 </dd>
131 </dl><a NAME="CondaExportDialog.__refresh" ID="CondaExportDialog.__refresh"></a>
132 <h4>CondaExportDialog.__refresh</h4>
133 <b>__refresh</b>(<i></i>)
134 <p>
135 Private slot to refresh the displayed list.
136 </p><a NAME="CondaExportDialog.__updateButtons" ID="CondaExportDialog.__updateButtons"></a>
137 <h4>CondaExportDialog.__updateButtons</h4>
138 <b>__updateButtons</b>(<i></i>)
139 <p>
140 Private method to set the state of the various buttons.
141 </p><a NAME="CondaExportDialog.__writeToFile" ID="CondaExportDialog.__writeToFile"></a>
142 <h4>CondaExportDialog.__writeToFile</h4>
143 <b>__writeToFile</b>(<i>fileName</i>)
144 <p>
145 Private method to write the requirements text to a file.
146 </p><dl>
147 <dt><i>fileName</i> (str)</dt>
148 <dd>
149 name of the file to write to
150 </dd>
151 </dl><a NAME="CondaExportDialog.closeEvent" ID="CondaExportDialog.closeEvent"></a>
152 <h4>CondaExportDialog.closeEvent</h4>
153 <b>closeEvent</b>(<i>e</i>)
154 <p>
155 Protected slot implementing a close event handler.
156 </p><dl>
157 <dt><i>e</i> (QCloseEvent)</dt>
158 <dd>
159 close event
160 </dd>
161 </dl><a NAME="CondaExportDialog.on_buttonBox_clicked" ID="CondaExportDialog.on_buttonBox_clicked"></a>
162 <h4>CondaExportDialog.on_buttonBox_clicked</h4>
163 <b>on_buttonBox_clicked</b>(<i>button</i>)
164 <p>
165 Private slot called by a button of the button box clicked.
166 </p><dl>
167 <dt><i>button</i> (QAbstractButton)</dt>
168 <dd>
169 button that was clicked
170 </dd>
171 </dl><a NAME="CondaExportDialog.on_copyButton_clicked" ID="CondaExportDialog.on_copyButton_clicked"></a>
172 <h4>CondaExportDialog.on_copyButton_clicked</h4>
173 <b>on_copyButton_clicked</b>(<i></i>)
174 <p>
175 Private slot to copy the requirements text to the clipboard.
176 </p><a NAME="CondaExportDialog.on_insertButton_clicked" ID="CondaExportDialog.on_insertButton_clicked"></a>
177 <h4>CondaExportDialog.on_insertButton_clicked</h4>
178 <b>on_insertButton_clicked</b>(<i></i>)
179 <p>
180 Private slot to insert the requirements text at the cursor position
181 of the current editor.
182 </p><a NAME="CondaExportDialog.on_replaceAllButton_clicked" ID="CondaExportDialog.on_replaceAllButton_clicked"></a>
183 <h4>CondaExportDialog.on_replaceAllButton_clicked</h4>
184 <b>on_replaceAllButton_clicked</b>(<i></i>)
185 <p>
186 Private slot to replace the text of the current editor with the
187 requirements text.
188 </p><a NAME="CondaExportDialog.on_replaceSelectionButton_clicked" ID="CondaExportDialog.on_replaceSelectionButton_clicked"></a>
189 <h4>CondaExportDialog.on_replaceSelectionButton_clicked</h4>
190 <b>on_replaceSelectionButton_clicked</b>(<i></i>)
191 <p>
192 Private slot to replace the selected text of the current editor
193 with the requirements text.
194 </p><a NAME="CondaExportDialog.on_requirementsEdit_textChanged" ID="CondaExportDialog.on_requirementsEdit_textChanged"></a>
195 <h4>CondaExportDialog.on_requirementsEdit_textChanged</h4>
196 <b>on_requirementsEdit_textChanged</b>(<i></i>)
197 <p>
198 Private slot handling changes of the requirements text.
199 </p><a NAME="CondaExportDialog.on_requirementsFilePicker_textChanged" ID="CondaExportDialog.on_requirementsFilePicker_textChanged"></a>
200 <h4>CondaExportDialog.on_requirementsFilePicker_textChanged</h4>
201 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>)
202 <p>
203 Private slot handling a change of the requirements file name.
204 </p><dl>
205 <dt><i>txt</i> (str)</dt>
206 <dd>
207 name of the requirements file
208 </dd>
209 </dl><a NAME="CondaExportDialog.on_saveButton_clicked" ID="CondaExportDialog.on_saveButton_clicked"></a>
210 <h4>CondaExportDialog.on_saveButton_clicked</h4>
211 <b>on_saveButton_clicked</b>(<i></i>)
212 <p>
213 Private slot to save the requirements text to the requirements file.
214 </p><a NAME="CondaExportDialog.on_saveToButton_clicked" ID="CondaExportDialog.on_saveToButton_clicked"></a>
215 <h4>CondaExportDialog.on_saveToButton_clicked</h4>
216 <b>on_saveToButton_clicked</b>(<i></i>)
217 <p>
218 Private slot to write the requirements text to a new file.
219 </p><a NAME="CondaExportDialog.start" ID="CondaExportDialog.start"></a>
220 <h4>CondaExportDialog.start</h4>
221 <b>start</b>(<i></i>)
222 <p>
223 Public method to start the command.
224 </p>
225 <div align="right"><a href="#top">Up</a></div>
226 <hr />
227 </body></html>

eric ide

mercurial