eric6/Documentation/Source/eric6.UI.NumbersWidget.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.UI.NumbersWidget</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.UI.NumbersWidget</h1>
23 <p>
24 Module implementing a widget to show numbers in different formats.
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="#BinaryModel">BinaryModel</a></td>
34 <td>Class implementing a model for entering binary numbers.</td>
35 </tr><tr>
36 <td><a href="#NumbersWidget">NumbersWidget</a></td>
37 <td>Class implementing a widget to show numbers in different formats.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="BinaryModel" ID="BinaryModel"></a>
46 <h2>BinaryModel</h2>
47 <p>
48 Class implementing a model for entering binary numbers.
49 </p>
50 <h3>Derived from</h3>
51 QAbstractTableModel
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#BinaryModel.__init__">BinaryModel</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#BinaryModel.columnCount">columnCount</a></td>
67 <td>Public method to get the number of columns of the model.</td>
68 </tr><tr>
69 <td><a href="#BinaryModel.data">data</a></td>
70 <td>Public method to get data from the model.</td>
71 </tr><tr>
72 <td><a href="#BinaryModel.flags">flags</a></td>
73 <td>Public method to get flags from the model.</td>
74 </tr><tr>
75 <td><a href="#BinaryModel.getValue">getValue</a></td>
76 <td>Public slot to get the current value.</td>
77 </tr><tr>
78 <td><a href="#BinaryModel.headerData">headerData</a></td>
79 <td>Public method to get header data from the model.</td>
80 </tr><tr>
81 <td><a href="#BinaryModel.rowCount">rowCount</a></td>
82 <td>Public method to get the number of rows of the model.</td>
83 </tr><tr>
84 <td><a href="#BinaryModel.setBits">setBits</a></td>
85 <td>Public slot to set the number of bits.</td>
86 </tr><tr>
87 <td><a href="#BinaryModel.setBitsAndValue">setBitsAndValue</a></td>
88 <td>Public slot to set the number of bits and the value to show.</td>
89 </tr><tr>
90 <td><a href="#BinaryModel.setData">setData</a></td>
91 <td>Public method to set the data of a node cell.</td>
92 </tr><tr>
93 <td><a href="#BinaryModel.setValue">setValue</a></td>
94 <td>Public slot to set the value to show.</td>
95 </tr>
96 </table>
97 <h3>Static Methods</h3>
98 <table>
99 <tr><td>None</td></tr>
100 </table>
101 <a NAME="BinaryModel.__init__" ID="BinaryModel.__init__"></a>
102 <h4>BinaryModel (Constructor)</h4>
103 <b>BinaryModel</b>(<i>parent=None</i>)
104 <p>
105 Constructor
106 </p><dl>
107 <dt><i>parent</i></dt>
108 <dd>
109 reference to the parent widget (QWidget)
110 </dd>
111 </dl><a NAME="BinaryModel.columnCount" ID="BinaryModel.columnCount"></a>
112 <h4>BinaryModel.columnCount</h4>
113 <b>columnCount</b>(<i>parent</i>)
114 <p>
115 Public method to get the number of columns of the model.
116 </p><dl>
117 <dt><i>parent</i></dt>
118 <dd>
119 parent index (QModelIndex)
120 </dd>
121 </dl><dl>
122 <dt>Returns:</dt>
123 <dd>
124 number of columns (integer)
125 </dd>
126 </dl><a NAME="BinaryModel.data" ID="BinaryModel.data"></a>
127 <h4>BinaryModel.data</h4>
128 <b>data</b>(<i>index, role=Qt.DisplayRole</i>)
129 <p>
130 Public method to get data from the model.
131 </p><dl>
132 <dt><i>index</i></dt>
133 <dd>
134 index to get data for (QModelIndex)
135 </dd><dt><i>role</i></dt>
136 <dd>
137 role of the data to retrieve (integer)
138 </dd>
139 </dl><dl>
140 <dt>Returns:</dt>
141 <dd>
142 requested data
143 </dd>
144 </dl><a NAME="BinaryModel.flags" ID="BinaryModel.flags"></a>
145 <h4>BinaryModel.flags</h4>
146 <b>flags</b>(<i>index</i>)
147 <p>
148 Public method to get flags from the model.
149 </p><dl>
150 <dt><i>index</i></dt>
151 <dd>
152 index to get flags for (QModelIndex)
153 </dd>
154 </dl><dl>
155 <dt>Returns:</dt>
156 <dd>
157 flags (Qt.ItemFlags)
158 </dd>
159 </dl><a NAME="BinaryModel.getValue" ID="BinaryModel.getValue"></a>
160 <h4>BinaryModel.getValue</h4>
161 <b>getValue</b>(<i></i>)
162 <p>
163 Public slot to get the current value.
164 </p><dl>
165 <dt>Returns:</dt>
166 <dd>
167 current value of the model (integer)
168 </dd>
169 </dl><a NAME="BinaryModel.headerData" ID="BinaryModel.headerData"></a>
170 <h4>BinaryModel.headerData</h4>
171 <b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>)
172 <p>
173 Public method to get header data from the model.
174 </p><dl>
175 <dt><i>section</i></dt>
176 <dd>
177 section number (integer)
178 </dd><dt><i>orientation</i></dt>
179 <dd>
180 orientation (Qt.Orientation)
181 </dd><dt><i>role</i></dt>
182 <dd>
183 role of the data to retrieve (integer)
184 </dd>
185 </dl><dl>
186 <dt>Returns:</dt>
187 <dd>
188 requested data
189 </dd>
190 </dl><a NAME="BinaryModel.rowCount" ID="BinaryModel.rowCount"></a>
191 <h4>BinaryModel.rowCount</h4>
192 <b>rowCount</b>(<i>parent</i>)
193 <p>
194 Public method to get the number of rows of the model.
195 </p><dl>
196 <dt><i>parent</i></dt>
197 <dd>
198 parent index (QModelIndex)
199 </dd>
200 </dl><dl>
201 <dt>Returns:</dt>
202 <dd>
203 number of columns (integer)
204 </dd>
205 </dl><a NAME="BinaryModel.setBits" ID="BinaryModel.setBits"></a>
206 <h4>BinaryModel.setBits</h4>
207 <b>setBits</b>(<i>bits</i>)
208 <p>
209 Public slot to set the number of bits.
210 </p><dl>
211 <dt><i>bits</i></dt>
212 <dd>
213 number of bits to show (integer)
214 </dd>
215 </dl><a NAME="BinaryModel.setBitsAndValue" ID="BinaryModel.setBitsAndValue"></a>
216 <h4>BinaryModel.setBitsAndValue</h4>
217 <b>setBitsAndValue</b>(<i>bits, value</i>)
218 <p>
219 Public slot to set the number of bits and the value to show.
220 </p><dl>
221 <dt><i>bits</i></dt>
222 <dd>
223 number of bits to show (integer)
224 </dd><dt><i>value</i></dt>
225 <dd>
226 value to show (integer)
227 </dd>
228 </dl><a NAME="BinaryModel.setData" ID="BinaryModel.setData"></a>
229 <h4>BinaryModel.setData</h4>
230 <b>setData</b>(<i>index, value, role=Qt.EditRole</i>)
231 <p>
232 Public method to set the data of a node cell.
233 </p><dl>
234 <dt><i>index</i></dt>
235 <dd>
236 index of the node cell (QModelIndex)
237 </dd><dt><i>value</i></dt>
238 <dd>
239 value to be set
240 </dd><dt><i>role</i></dt>
241 <dd>
242 role of the data (integer)
243 </dd>
244 </dl><dl>
245 <dt>Returns:</dt>
246 <dd>
247 flag indicating success (boolean)
248 </dd>
249 </dl><a NAME="BinaryModel.setValue" ID="BinaryModel.setValue"></a>
250 <h4>BinaryModel.setValue</h4>
251 <b>setValue</b>(<i>value</i>)
252 <p>
253 Public slot to set the value to show.
254 </p><dl>
255 <dt><i>value</i></dt>
256 <dd>
257 value to show (integer)
258 </dd>
259 </dl>
260 <div align="right"><a href="#top">Up</a></div>
261 <hr /><hr />
262 <a NAME="NumbersWidget" ID="NumbersWidget"></a>
263 <h2>NumbersWidget</h2>
264 <p>
265 Class implementing a widget to show numbers in different formats.
266 </p><h3>Signals</h3>
267 <dl>
268 <dt>insertNumber(str)</dt>
269 <dd>
270 emitted after the user has entered a number
271 and selected the number format
272 </dd>
273 </dl>
274 <h3>Derived from</h3>
275 QWidget, Ui_NumbersWidget
276 <h3>Class Attributes</h3>
277 <table>
278 <tr><td>None</td></tr>
279 </table>
280 <h3>Class Methods</h3>
281 <table>
282 <tr><td>None</td></tr>
283 </table>
284 <h3>Methods</h3>
285 <table>
286 <tr>
287 <td><a href="#NumbersWidget.__init__">NumbersWidget</a></td>
288 <td>Constructor</td>
289 </tr><tr>
290 <td><a href="#NumbersWidget.__binModelDataChanged">__binModelDataChanged</a></td>
291 <td>Private slot to handle a change of the binary model value by the user.</td>
292 </tr><tr>
293 <td><a href="#NumbersWidget.__block">__block</a></td>
294 <td>Private slot to block some signals.</td>
295 </tr><tr>
296 <td><a href="#NumbersWidget.__formatNumbers">__formatNumbers</a></td>
297 <td>Private method to format the various number inputs.</td>
298 </tr><tr>
299 <td><a href="#NumbersWidget.on_binEdit_textChanged">on_binEdit_textChanged</a></td>
300 <td>Private slot to handle input of a binary number.</td>
301 </tr><tr>
302 <td><a href="#NumbersWidget.on_binInButton_clicked">on_binInButton_clicked</a></td>
303 <td>Private slot to retrieve a binary number from the current editor.</td>
304 </tr><tr>
305 <td><a href="#NumbersWidget.on_binOutButton_clicked">on_binOutButton_clicked</a></td>
306 <td>Private slot to send a binary number.</td>
307 </tr><tr>
308 <td><a href="#NumbersWidget.on_byteOrderButton_clicked">on_byteOrderButton_clicked</a></td>
309 <td>Private slot to swap the byte order.</td>
310 </tr><tr>
311 <td><a href="#NumbersWidget.on_decEdit_textChanged">on_decEdit_textChanged</a></td>
312 <td>Private slot to handle input of a decimal number.</td>
313 </tr><tr>
314 <td><a href="#NumbersWidget.on_decInButton_clicked">on_decInButton_clicked</a></td>
315 <td>Private slot to retrieve a decimal number from the current editor.</td>
316 </tr><tr>
317 <td><a href="#NumbersWidget.on_decOutButton_clicked">on_decOutButton_clicked</a></td>
318 <td>Private slot to send a decimal number.</td>
319 </tr><tr>
320 <td><a href="#NumbersWidget.on_hexEdit_textChanged">on_hexEdit_textChanged</a></td>
321 <td>Private slot to handle input of a hexadecimal number.</td>
322 </tr><tr>
323 <td><a href="#NumbersWidget.on_hexInButton_clicked">on_hexInButton_clicked</a></td>
324 <td>Private slot to retrieve a hexadecimal number from the current editor.</td>
325 </tr><tr>
326 <td><a href="#NumbersWidget.on_hexOutButton_clicked">on_hexOutButton_clicked</a></td>
327 <td>Private slot to send a hexadecimal number.</td>
328 </tr><tr>
329 <td><a href="#NumbersWidget.on_octEdit_textChanged">on_octEdit_textChanged</a></td>
330 <td>Private slot to handle input of an octal number.</td>
331 </tr><tr>
332 <td><a href="#NumbersWidget.on_octInButton_clicked">on_octInButton_clicked</a></td>
333 <td>Private slot to retrieve an octal number from the current editor.</td>
334 </tr><tr>
335 <td><a href="#NumbersWidget.on_octOutButton_clicked">on_octOutButton_clicked</a></td>
336 <td>Private slot to send an octal number.</td>
337 </tr><tr>
338 <td><a href="#NumbersWidget.on_sizeBox_valueChanged">on_sizeBox_valueChanged</a></td>
339 <td>Private slot handling a change of the bit size.</td>
340 </tr>
341 </table>
342 <h3>Static Methods</h3>
343 <table>
344 <tr><td>None</td></tr>
345 </table>
346 <a NAME="NumbersWidget.__init__" ID="NumbersWidget.__init__"></a>
347 <h4>NumbersWidget (Constructor)</h4>
348 <b>NumbersWidget</b>(<i>parent=None</i>)
349 <p>
350 Constructor
351 </p><dl>
352 <dt><i>parent</i></dt>
353 <dd>
354 reference to the parent widget (QWidget)
355 </dd>
356 </dl><a NAME="NumbersWidget.__binModelDataChanged" ID="NumbersWidget.__binModelDataChanged"></a>
357 <h4>NumbersWidget.__binModelDataChanged</h4>
358 <b>__binModelDataChanged</b>(<i>start, end</i>)
359 <p>
360 Private slot to handle a change of the binary model value by the user.
361 </p><dl>
362 <dt><i>start</i></dt>
363 <dd>
364 start index (QModelIndex)
365 </dd><dt><i>end</i></dt>
366 <dd>
367 end index (QModelIndex)
368 </dd>
369 </dl><a NAME="NumbersWidget.__block" ID="NumbersWidget.__block"></a>
370 <h4>NumbersWidget.__block</h4>
371 <b>__block</b>(<i>b</i>)
372 <p>
373 Private slot to block some signals.
374 </p><dl>
375 <dt><i>b</i></dt>
376 <dd>
377 flah indicating the blocking state (boolean)
378 </dd>
379 </dl><a NAME="NumbersWidget.__formatNumbers" ID="NumbersWidget.__formatNumbers"></a>
380 <h4>NumbersWidget.__formatNumbers</h4>
381 <b>__formatNumbers</b>(<i>numberFormat</i>)
382 <p>
383 Private method to format the various number inputs.
384 </p><dl>
385 <dt><i>numberFormat</i></dt>
386 <dd>
387 number format indicator (integer)
388 </dd>
389 </dl><a NAME="NumbersWidget.on_binEdit_textChanged" ID="NumbersWidget.on_binEdit_textChanged"></a>
390 <h4>NumbersWidget.on_binEdit_textChanged</h4>
391 <b>on_binEdit_textChanged</b>(<i>txt</i>)
392 <p>
393 Private slot to handle input of a binary number.
394 </p><dl>
395 <dt><i>txt</i></dt>
396 <dd>
397 text entered (string)
398 </dd>
399 </dl><a NAME="NumbersWidget.on_binInButton_clicked" ID="NumbersWidget.on_binInButton_clicked"></a>
400 <h4>NumbersWidget.on_binInButton_clicked</h4>
401 <b>on_binInButton_clicked</b>(<i></i>)
402 <p>
403 Private slot to retrieve a binary number from the current editor.
404 </p><a NAME="NumbersWidget.on_binOutButton_clicked" ID="NumbersWidget.on_binOutButton_clicked"></a>
405 <h4>NumbersWidget.on_binOutButton_clicked</h4>
406 <b>on_binOutButton_clicked</b>(<i></i>)
407 <p>
408 Private slot to send a binary number.
409 </p><a NAME="NumbersWidget.on_byteOrderButton_clicked" ID="NumbersWidget.on_byteOrderButton_clicked"></a>
410 <h4>NumbersWidget.on_byteOrderButton_clicked</h4>
411 <b>on_byteOrderButton_clicked</b>(<i></i>)
412 <p>
413 Private slot to swap the byte order.
414 </p><a NAME="NumbersWidget.on_decEdit_textChanged" ID="NumbersWidget.on_decEdit_textChanged"></a>
415 <h4>NumbersWidget.on_decEdit_textChanged</h4>
416 <b>on_decEdit_textChanged</b>(<i>txt</i>)
417 <p>
418 Private slot to handle input of a decimal number.
419 </p><dl>
420 <dt><i>txt</i></dt>
421 <dd>
422 text entered (string)
423 </dd>
424 </dl><a NAME="NumbersWidget.on_decInButton_clicked" ID="NumbersWidget.on_decInButton_clicked"></a>
425 <h4>NumbersWidget.on_decInButton_clicked</h4>
426 <b>on_decInButton_clicked</b>(<i></i>)
427 <p>
428 Private slot to retrieve a decimal number from the current editor.
429 </p><a NAME="NumbersWidget.on_decOutButton_clicked" ID="NumbersWidget.on_decOutButton_clicked"></a>
430 <h4>NumbersWidget.on_decOutButton_clicked</h4>
431 <b>on_decOutButton_clicked</b>(<i></i>)
432 <p>
433 Private slot to send a decimal number.
434 </p><a NAME="NumbersWidget.on_hexEdit_textChanged" ID="NumbersWidget.on_hexEdit_textChanged"></a>
435 <h4>NumbersWidget.on_hexEdit_textChanged</h4>
436 <b>on_hexEdit_textChanged</b>(<i>txt</i>)
437 <p>
438 Private slot to handle input of a hexadecimal number.
439 </p><dl>
440 <dt><i>txt</i></dt>
441 <dd>
442 text entered (string)
443 </dd>
444 </dl><a NAME="NumbersWidget.on_hexInButton_clicked" ID="NumbersWidget.on_hexInButton_clicked"></a>
445 <h4>NumbersWidget.on_hexInButton_clicked</h4>
446 <b>on_hexInButton_clicked</b>(<i></i>)
447 <p>
448 Private slot to retrieve a hexadecimal number from the current editor.
449 </p><a NAME="NumbersWidget.on_hexOutButton_clicked" ID="NumbersWidget.on_hexOutButton_clicked"></a>
450 <h4>NumbersWidget.on_hexOutButton_clicked</h4>
451 <b>on_hexOutButton_clicked</b>(<i></i>)
452 <p>
453 Private slot to send a hexadecimal number.
454 </p><a NAME="NumbersWidget.on_octEdit_textChanged" ID="NumbersWidget.on_octEdit_textChanged"></a>
455 <h4>NumbersWidget.on_octEdit_textChanged</h4>
456 <b>on_octEdit_textChanged</b>(<i>txt</i>)
457 <p>
458 Private slot to handle input of an octal number.
459 </p><dl>
460 <dt><i>txt</i></dt>
461 <dd>
462 text entered (string)
463 </dd>
464 </dl><a NAME="NumbersWidget.on_octInButton_clicked" ID="NumbersWidget.on_octInButton_clicked"></a>
465 <h4>NumbersWidget.on_octInButton_clicked</h4>
466 <b>on_octInButton_clicked</b>(<i></i>)
467 <p>
468 Private slot to retrieve an octal number from the current editor.
469 </p><a NAME="NumbersWidget.on_octOutButton_clicked" ID="NumbersWidget.on_octOutButton_clicked"></a>
470 <h4>NumbersWidget.on_octOutButton_clicked</h4>
471 <b>on_octOutButton_clicked</b>(<i></i>)
472 <p>
473 Private slot to send an octal number.
474 </p><a NAME="NumbersWidget.on_sizeBox_valueChanged" ID="NumbersWidget.on_sizeBox_valueChanged"></a>
475 <h4>NumbersWidget.on_sizeBox_valueChanged</h4>
476 <b>on_sizeBox_valueChanged</b>(<i>value</i>)
477 <p>
478 Private slot handling a change of the bit size.
479 </p><dl>
480 <dt><i>value</i></dt>
481 <dd>
482 selected bit size (integer)
483 </dd>
484 </dl>
485 <div align="right"><a href="#top">Up</a></div>
486 <hr />
487 </body></html>

eric ide

mercurial