src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog.html

branch
eric7
changeset 10479
856476537696
parent 9756
9854647c8c5c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog</h1> 9 <h1>eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to generate a requirements file. 11 Module implementing a dialog to generate a requirements file.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#RequirementsDialog">RequirementsDialog</a></td> 22 <td><a href="#RequirementsDialog">RequirementsDialog</a></td>
25 <td>Class implementing a dialog to generate a requirements file.</td> 23 <td>Class implementing a dialog to generate a requirements file.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="RequirementsDialog" ID="RequirementsDialog"></a> 34 <a NAME="RequirementsDialog" ID="RequirementsDialog"></a>
36 <h2>RequirementsDialog</h2> 35 <h2>RequirementsDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to generate a requirements file. 37 Class implementing a dialog to generate a requirements file.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_RequirementsDialog 41 QDialog, Ui_RequirementsDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#RequirementsDialog.__init__">RequirementsDialog</a></td> 55 <td><a href="#RequirementsDialog.__init__">RequirementsDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
105 <tr> 102 <tr>
106 <td><a href="#RequirementsDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> 103 <td><a href="#RequirementsDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td>
107 <td>Private slot to write the requirements text to a new file.</td> 104 <td>Private slot to write the requirements text to a new file.</td>
108 </tr> 105 </tr>
109 </table> 106 </table>
107
110 <h3>Static Methods</h3> 108 <h3>Static Methods</h3>
111 109 <table>
112 <table> 110 <tr><td>None</td></tr>
113 <tr><td>None</td></tr> 111 </table>
114 </table> 112
115 113
116 <a NAME="RequirementsDialog.__init__" ID="RequirementsDialog.__init__"></a> 114 <a NAME="RequirementsDialog.__init__" ID="RequirementsDialog.__init__"></a>
117 <h4>RequirementsDialog (Constructor)</h4> 115 <h4>RequirementsDialog (Constructor)</h4>
118 <b>RequirementsDialog</b>(<i>devicePath, parent=None</i>) 116 <b>RequirementsDialog</b>(<i>devicePath, parent=None</i>)
119
120 <p> 117 <p>
121 Constructor 118 Constructor
122 </p> 119 </p>
120
123 <dl> 121 <dl>
124 122
125 <dt><i>devicePath</i> (str)</dt> 123 <dt><i>devicePath</i> (str)</dt>
126 <dd> 124 <dd>
127 path to the connected board 125 path to the connected board
132 </dd> 130 </dd>
133 </dl> 131 </dl>
134 <a NAME="RequirementsDialog.__generateRequirements" ID="RequirementsDialog.__generateRequirements"></a> 132 <a NAME="RequirementsDialog.__generateRequirements" ID="RequirementsDialog.__generateRequirements"></a>
135 <h4>RequirementsDialog.__generateRequirements</h4> 133 <h4>RequirementsDialog.__generateRequirements</h4>
136 <b>__generateRequirements</b>(<i></i>) 134 <b>__generateRequirements</b>(<i></i>)
137
138 <p> 135 <p>
139 Private slot to generate the requirements specifiers list. 136 Private slot to generate the requirements specifiers list.
140 </p> 137 </p>
138
141 <a NAME="RequirementsDialog.__updateButtons" ID="RequirementsDialog.__updateButtons"></a> 139 <a NAME="RequirementsDialog.__updateButtons" ID="RequirementsDialog.__updateButtons"></a>
142 <h4>RequirementsDialog.__updateButtons</h4> 140 <h4>RequirementsDialog.__updateButtons</h4>
143 <b>__updateButtons</b>(<i></i>) 141 <b>__updateButtons</b>(<i></i>)
144
145 <p> 142 <p>
146 Private method to set the state of the various buttons. 143 Private method to set the state of the various buttons.
147 </p> 144 </p>
145
148 <a NAME="RequirementsDialog.__writeToFile" ID="RequirementsDialog.__writeToFile"></a> 146 <a NAME="RequirementsDialog.__writeToFile" ID="RequirementsDialog.__writeToFile"></a>
149 <h4>RequirementsDialog.__writeToFile</h4> 147 <h4>RequirementsDialog.__writeToFile</h4>
150 <b>__writeToFile</b>(<i>fileName</i>) 148 <b>__writeToFile</b>(<i>fileName</i>)
151
152 <p> 149 <p>
153 Private method to write the requirements text to a file. 150 Private method to write the requirements text to a file.
154 </p> 151 </p>
152
155 <dl> 153 <dl>
156 154
157 <dt><i>fileName</i> (str)</dt> 155 <dt><i>fileName</i> (str)</dt>
158 <dd> 156 <dd>
159 name of the file to write to 157 name of the file to write to
160 </dd> 158 </dd>
161 </dl> 159 </dl>
162 <a NAME="RequirementsDialog.on_buttonBox_clicked" ID="RequirementsDialog.on_buttonBox_clicked"></a> 160 <a NAME="RequirementsDialog.on_buttonBox_clicked" ID="RequirementsDialog.on_buttonBox_clicked"></a>
163 <h4>RequirementsDialog.on_buttonBox_clicked</h4> 161 <h4>RequirementsDialog.on_buttonBox_clicked</h4>
164 <b>on_buttonBox_clicked</b>(<i>button</i>) 162 <b>on_buttonBox_clicked</b>(<i>button</i>)
165
166 <p> 163 <p>
167 Private slot called by a button of the button box clicked. 164 Private slot called by a button of the button box clicked.
168 </p> 165 </p>
166
169 <dl> 167 <dl>
170 168
171 <dt><i>button</i> (QAbstractButton)</dt> 169 <dt><i>button</i> (QAbstractButton)</dt>
172 <dd> 170 <dd>
173 button that was clicked 171 button that was clicked
174 </dd> 172 </dd>
175 </dl> 173 </dl>
176 <a NAME="RequirementsDialog.on_copyButton_clicked" ID="RequirementsDialog.on_copyButton_clicked"></a> 174 <a NAME="RequirementsDialog.on_copyButton_clicked" ID="RequirementsDialog.on_copyButton_clicked"></a>
177 <h4>RequirementsDialog.on_copyButton_clicked</h4> 175 <h4>RequirementsDialog.on_copyButton_clicked</h4>
178 <b>on_copyButton_clicked</b>(<i></i>) 176 <b>on_copyButton_clicked</b>(<i></i>)
179
180 <p> 177 <p>
181 Private slot to copy the requirements text to the clipboard. 178 Private slot to copy the requirements text to the clipboard.
182 </p> 179 </p>
180
183 <a NAME="RequirementsDialog.on_insertButton_clicked" ID="RequirementsDialog.on_insertButton_clicked"></a> 181 <a NAME="RequirementsDialog.on_insertButton_clicked" ID="RequirementsDialog.on_insertButton_clicked"></a>
184 <h4>RequirementsDialog.on_insertButton_clicked</h4> 182 <h4>RequirementsDialog.on_insertButton_clicked</h4>
185 <b>on_insertButton_clicked</b>(<i></i>) 183 <b>on_insertButton_clicked</b>(<i></i>)
186
187 <p> 184 <p>
188 Private slot to insert the requirements text at the cursor position 185 Private slot to insert the requirements text at the cursor position
189 of the current editor. 186 of the current editor.
190 </p> 187 </p>
188
191 <a NAME="RequirementsDialog.on_replaceAllButton_clicked" ID="RequirementsDialog.on_replaceAllButton_clicked"></a> 189 <a NAME="RequirementsDialog.on_replaceAllButton_clicked" ID="RequirementsDialog.on_replaceAllButton_clicked"></a>
192 <h4>RequirementsDialog.on_replaceAllButton_clicked</h4> 190 <h4>RequirementsDialog.on_replaceAllButton_clicked</h4>
193 <b>on_replaceAllButton_clicked</b>(<i></i>) 191 <b>on_replaceAllButton_clicked</b>(<i></i>)
194
195 <p> 192 <p>
196 Private slot to replace the text of the current editor with the 193 Private slot to replace the text of the current editor with the
197 requirements text. 194 requirements text.
198 </p> 195 </p>
196
199 <a NAME="RequirementsDialog.on_replaceSelectionButton_clicked" ID="RequirementsDialog.on_replaceSelectionButton_clicked"></a> 197 <a NAME="RequirementsDialog.on_replaceSelectionButton_clicked" ID="RequirementsDialog.on_replaceSelectionButton_clicked"></a>
200 <h4>RequirementsDialog.on_replaceSelectionButton_clicked</h4> 198 <h4>RequirementsDialog.on_replaceSelectionButton_clicked</h4>
201 <b>on_replaceSelectionButton_clicked</b>(<i></i>) 199 <b>on_replaceSelectionButton_clicked</b>(<i></i>)
202
203 <p> 200 <p>
204 Private slot to replace the selected text of the current editor 201 Private slot to replace the selected text of the current editor
205 with the requirements text. 202 with the requirements text.
206 </p> 203 </p>
204
207 <a NAME="RequirementsDialog.on_requirementsEdit_textChanged" ID="RequirementsDialog.on_requirementsEdit_textChanged"></a> 205 <a NAME="RequirementsDialog.on_requirementsEdit_textChanged" ID="RequirementsDialog.on_requirementsEdit_textChanged"></a>
208 <h4>RequirementsDialog.on_requirementsEdit_textChanged</h4> 206 <h4>RequirementsDialog.on_requirementsEdit_textChanged</h4>
209 <b>on_requirementsEdit_textChanged</b>(<i></i>) 207 <b>on_requirementsEdit_textChanged</b>(<i></i>)
210
211 <p> 208 <p>
212 Private slot handling changes of the requirements text. 209 Private slot handling changes of the requirements text.
213 </p> 210 </p>
211
214 <a NAME="RequirementsDialog.on_requirementsFilePicker_textChanged" ID="RequirementsDialog.on_requirementsFilePicker_textChanged"></a> 212 <a NAME="RequirementsDialog.on_requirementsFilePicker_textChanged" ID="RequirementsDialog.on_requirementsFilePicker_textChanged"></a>
215 <h4>RequirementsDialog.on_requirementsFilePicker_textChanged</h4> 213 <h4>RequirementsDialog.on_requirementsFilePicker_textChanged</h4>
216 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) 214 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>)
217
218 <p> 215 <p>
219 Private slot handling a change of the requirements file name. 216 Private slot handling a change of the requirements file name.
220 </p> 217 </p>
218
221 <dl> 219 <dl>
222 220
223 <dt><i>txt</i> (str)</dt> 221 <dt><i>txt</i> (str)</dt>
224 <dd> 222 <dd>
225 name of the requirements file 223 name of the requirements file
226 </dd> 224 </dd>
227 </dl> 225 </dl>
228 <a NAME="RequirementsDialog.on_saveButton_clicked" ID="RequirementsDialog.on_saveButton_clicked"></a> 226 <a NAME="RequirementsDialog.on_saveButton_clicked" ID="RequirementsDialog.on_saveButton_clicked"></a>
229 <h4>RequirementsDialog.on_saveButton_clicked</h4> 227 <h4>RequirementsDialog.on_saveButton_clicked</h4>
230 <b>on_saveButton_clicked</b>(<i></i>) 228 <b>on_saveButton_clicked</b>(<i></i>)
231
232 <p> 229 <p>
233 Private slot to save the requirements text to the requirements file. 230 Private slot to save the requirements text to the requirements file.
234 </p> 231 </p>
232
235 <a NAME="RequirementsDialog.on_saveToButton_clicked" ID="RequirementsDialog.on_saveToButton_clicked"></a> 233 <a NAME="RequirementsDialog.on_saveToButton_clicked" ID="RequirementsDialog.on_saveToButton_clicked"></a>
236 <h4>RequirementsDialog.on_saveToButton_clicked</h4> 234 <h4>RequirementsDialog.on_saveToButton_clicked</h4>
237 <b>on_saveToButton_clicked</b>(<i></i>) 235 <b>on_saveToButton_clicked</b>(<i></i>)
238
239 <p> 236 <p>
240 Private slot to write the requirements text to a new file. 237 Private slot to write the requirements text to a new file.
241 </p> 238 </p>
239
242 <div align="right"><a href="#top">Up</a></div> 240 <div align="right"><a href="#top">Up</a></div>
243 <hr /> 241 <hr />
244 </body></html> 242 </body></html>

eric ide

mercurial