eric7/Documentation/Source/eric7.UI.NumbersWidget.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.UI.NumbersWidget</h1>
24
25 <p>
26 Module implementing a widget to show numbers in different formats.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#BinaryModel">BinaryModel</a></td>
39 <td>Class implementing a model for entering binary numbers.</td>
40 </tr>
41 <tr>
42 <td><a href="#NumbersWidget">NumbersWidget</a></td>
43 <td>Class implementing a widget to show numbers in different formats.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="BinaryModel" ID="BinaryModel"></a>
54 <h2>BinaryModel</h2>
55
56 <p>
57 Class implementing a model for entering binary numbers.
58 </p>
59 <h3>Derived from</h3>
60 QAbstractTableModel
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#BinaryModel.__init__">BinaryModel</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#BinaryModel.columnCount">columnCount</a></td>
81 <td>Public method to get the number of columns of the model.</td>
82 </tr>
83 <tr>
84 <td><a href="#BinaryModel.data">data</a></td>
85 <td>Public method to get data from the model.</td>
86 </tr>
87 <tr>
88 <td><a href="#BinaryModel.flags">flags</a></td>
89 <td>Public method to get flags from the model.</td>
90 </tr>
91 <tr>
92 <td><a href="#BinaryModel.getValue">getValue</a></td>
93 <td>Public slot to get the current value.</td>
94 </tr>
95 <tr>
96 <td><a href="#BinaryModel.headerData">headerData</a></td>
97 <td>Public method to get header data from the model.</td>
98 </tr>
99 <tr>
100 <td><a href="#BinaryModel.rowCount">rowCount</a></td>
101 <td>Public method to get the number of rows of the model.</td>
102 </tr>
103 <tr>
104 <td><a href="#BinaryModel.setBits">setBits</a></td>
105 <td>Public slot to set the number of bits.</td>
106 </tr>
107 <tr>
108 <td><a href="#BinaryModel.setBitsAndValue">setBitsAndValue</a></td>
109 <td>Public slot to set the number of bits and the value to show.</td>
110 </tr>
111 <tr>
112 <td><a href="#BinaryModel.setData">setData</a></td>
113 <td>Public method to set the data of a node cell.</td>
114 </tr>
115 <tr>
116 <td><a href="#BinaryModel.setValue">setValue</a></td>
117 <td>Public slot to set the value to show.</td>
118 </tr>
119 </table>
120 <h3>Static Methods</h3>
121
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125
126 <a NAME="BinaryModel.__init__" ID="BinaryModel.__init__"></a>
127 <h4>BinaryModel (Constructor)</h4>
128 <b>BinaryModel</b>(<i>parent=None</i>)
129
130 <p>
131 Constructor
132 </p>
133 <dl>
134
135 <dt><i>parent</i></dt>
136 <dd>
137 reference to the parent widget (QWidget)
138 </dd>
139 </dl>
140 <a NAME="BinaryModel.columnCount" ID="BinaryModel.columnCount"></a>
141 <h4>BinaryModel.columnCount</h4>
142 <b>columnCount</b>(<i>parent</i>)
143
144 <p>
145 Public method to get the number of columns of the model.
146 </p>
147 <dl>
148
149 <dt><i>parent</i></dt>
150 <dd>
151 parent index (QModelIndex)
152 </dd>
153 </dl>
154 <dl>
155 <dt>Return:</dt>
156 <dd>
157 number of columns (integer)
158 </dd>
159 </dl>
160 <a NAME="BinaryModel.data" ID="BinaryModel.data"></a>
161 <h4>BinaryModel.data</h4>
162 <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>)
163
164 <p>
165 Public method to get data from the model.
166 </p>
167 <dl>
168
169 <dt><i>index</i></dt>
170 <dd>
171 index to get data for (QModelIndex)
172 </dd>
173 <dt><i>role</i></dt>
174 <dd>
175 role of the data to retrieve (integer)
176 </dd>
177 </dl>
178 <dl>
179 <dt>Return:</dt>
180 <dd>
181 requested data
182 </dd>
183 </dl>
184 <a NAME="BinaryModel.flags" ID="BinaryModel.flags"></a>
185 <h4>BinaryModel.flags</h4>
186 <b>flags</b>(<i>index</i>)
187
188 <p>
189 Public method to get flags from the model.
190 </p>
191 <dl>
192
193 <dt><i>index</i></dt>
194 <dd>
195 index to get flags for (QModelIndex)
196 </dd>
197 </dl>
198 <dl>
199 <dt>Return:</dt>
200 <dd>
201 flags (Qt.ItemFlags)
202 </dd>
203 </dl>
204 <a NAME="BinaryModel.getValue" ID="BinaryModel.getValue"></a>
205 <h4>BinaryModel.getValue</h4>
206 <b>getValue</b>(<i></i>)
207
208 <p>
209 Public slot to get the current value.
210 </p>
211 <dl>
212 <dt>Return:</dt>
213 <dd>
214 current value of the model (integer)
215 </dd>
216 </dl>
217 <a NAME="BinaryModel.headerData" ID="BinaryModel.headerData"></a>
218 <h4>BinaryModel.headerData</h4>
219 <b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>)
220
221 <p>
222 Public method to get header data from the model.
223 </p>
224 <dl>
225
226 <dt><i>section</i></dt>
227 <dd>
228 section number (integer)
229 </dd>
230 <dt><i>orientation</i></dt>
231 <dd>
232 orientation (Qt.Orientation)
233 </dd>
234 <dt><i>role</i></dt>
235 <dd>
236 role of the data to retrieve (Qt.ItemDataRole)
237 </dd>
238 </dl>
239 <dl>
240 <dt>Return:</dt>
241 <dd>
242 requested data
243 </dd>
244 </dl>
245 <a NAME="BinaryModel.rowCount" ID="BinaryModel.rowCount"></a>
246 <h4>BinaryModel.rowCount</h4>
247 <b>rowCount</b>(<i>parent</i>)
248
249 <p>
250 Public method to get the number of rows of the model.
251 </p>
252 <dl>
253
254 <dt><i>parent</i></dt>
255 <dd>
256 parent index (QModelIndex)
257 </dd>
258 </dl>
259 <dl>
260 <dt>Return:</dt>
261 <dd>
262 number of columns (integer)
263 </dd>
264 </dl>
265 <a NAME="BinaryModel.setBits" ID="BinaryModel.setBits"></a>
266 <h4>BinaryModel.setBits</h4>
267 <b>setBits</b>(<i>bits</i>)
268
269 <p>
270 Public slot to set the number of bits.
271 </p>
272 <dl>
273
274 <dt><i>bits</i></dt>
275 <dd>
276 number of bits to show (integer)
277 </dd>
278 </dl>
279 <a NAME="BinaryModel.setBitsAndValue" ID="BinaryModel.setBitsAndValue"></a>
280 <h4>BinaryModel.setBitsAndValue</h4>
281 <b>setBitsAndValue</b>(<i>bits, value</i>)
282
283 <p>
284 Public slot to set the number of bits and the value to show.
285 </p>
286 <dl>
287
288 <dt><i>bits</i></dt>
289 <dd>
290 number of bits to show (integer)
291 </dd>
292 <dt><i>value</i></dt>
293 <dd>
294 value to show (integer)
295 </dd>
296 </dl>
297 <a NAME="BinaryModel.setData" ID="BinaryModel.setData"></a>
298 <h4>BinaryModel.setData</h4>
299 <b>setData</b>(<i>index, value, role=Qt.ItemDataRole.EditRole</i>)
300
301 <p>
302 Public method to set the data of a node cell.
303 </p>
304 <dl>
305
306 <dt><i>index</i></dt>
307 <dd>
308 index of the node cell (QModelIndex)
309 </dd>
310 <dt><i>value</i></dt>
311 <dd>
312 value to be set
313 </dd>
314 <dt><i>role</i></dt>
315 <dd>
316 role of the data (integer)
317 </dd>
318 </dl>
319 <dl>
320 <dt>Return:</dt>
321 <dd>
322 flag indicating success (boolean)
323 </dd>
324 </dl>
325 <a NAME="BinaryModel.setValue" ID="BinaryModel.setValue"></a>
326 <h4>BinaryModel.setValue</h4>
327 <b>setValue</b>(<i>value</i>)
328
329 <p>
330 Public slot to set the value to show.
331 </p>
332 <dl>
333
334 <dt><i>value</i></dt>
335 <dd>
336 value to show (integer)
337 </dd>
338 </dl>
339 <div align="right"><a href="#top">Up</a></div>
340 <hr />
341 <hr />
342 <a NAME="NumbersWidget" ID="NumbersWidget"></a>
343 <h2>NumbersWidget</h2>
344
345 <p>
346 Class implementing a widget to show numbers in different formats.
347 </p>
348 <h3>Signals</h3>
349 <dl>
350
351 <dt>insertNumber(str)</dt>
352 <dd>
353 emitted after the user has entered a number
354 and selected the number format
355 </dd>
356 </dl>
357 <h3>Derived from</h3>
358 QWidget, Ui_NumbersWidget
359 <h3>Class Attributes</h3>
360
361 <table>
362 <tr><td>None</td></tr>
363 </table>
364 <h3>Class Methods</h3>
365
366 <table>
367 <tr><td>None</td></tr>
368 </table>
369 <h3>Methods</h3>
370
371 <table>
372
373 <tr>
374 <td><a href="#NumbersWidget.__init__">NumbersWidget</a></td>
375 <td>Constructor</td>
376 </tr>
377 <tr>
378 <td><a href="#NumbersWidget.__binModelDataChanged">__binModelDataChanged</a></td>
379 <td>Private slot to handle a change of the binary model value by the user.</td>
380 </tr>
381 <tr>
382 <td><a href="#NumbersWidget.__block">__block</a></td>
383 <td>Private slot to block some signals.</td>
384 </tr>
385 <tr>
386 <td><a href="#NumbersWidget.__formatNumbers">__formatNumbers</a></td>
387 <td>Private method to format the various number inputs.</td>
388 </tr>
389 <tr>
390 <td><a href="#NumbersWidget.on_binEdit_textChanged">on_binEdit_textChanged</a></td>
391 <td>Private slot to handle input of a binary number.</td>
392 </tr>
393 <tr>
394 <td><a href="#NumbersWidget.on_binInButton_clicked">on_binInButton_clicked</a></td>
395 <td>Private slot to retrieve a binary number from the current editor.</td>
396 </tr>
397 <tr>
398 <td><a href="#NumbersWidget.on_binOutButton_clicked">on_binOutButton_clicked</a></td>
399 <td>Private slot to send a binary number.</td>
400 </tr>
401 <tr>
402 <td><a href="#NumbersWidget.on_byteOrderButton_clicked">on_byteOrderButton_clicked</a></td>
403 <td>Private slot to swap the byte order.</td>
404 </tr>
405 <tr>
406 <td><a href="#NumbersWidget.on_decEdit_textChanged">on_decEdit_textChanged</a></td>
407 <td>Private slot to handle input of a decimal number.</td>
408 </tr>
409 <tr>
410 <td><a href="#NumbersWidget.on_decInButton_clicked">on_decInButton_clicked</a></td>
411 <td>Private slot to retrieve a decimal number from the current editor.</td>
412 </tr>
413 <tr>
414 <td><a href="#NumbersWidget.on_decOutButton_clicked">on_decOutButton_clicked</a></td>
415 <td>Private slot to send a decimal number.</td>
416 </tr>
417 <tr>
418 <td><a href="#NumbersWidget.on_hexEdit_textChanged">on_hexEdit_textChanged</a></td>
419 <td>Private slot to handle input of a hexadecimal number.</td>
420 </tr>
421 <tr>
422 <td><a href="#NumbersWidget.on_hexInButton_clicked">on_hexInButton_clicked</a></td>
423 <td>Private slot to retrieve a hexadecimal number from the current editor.</td>
424 </tr>
425 <tr>
426 <td><a href="#NumbersWidget.on_hexOutButton_clicked">on_hexOutButton_clicked</a></td>
427 <td>Private slot to send a hexadecimal number.</td>
428 </tr>
429 <tr>
430 <td><a href="#NumbersWidget.on_octEdit_textChanged">on_octEdit_textChanged</a></td>
431 <td>Private slot to handle input of an octal number.</td>
432 </tr>
433 <tr>
434 <td><a href="#NumbersWidget.on_octInButton_clicked">on_octInButton_clicked</a></td>
435 <td>Private slot to retrieve an octal number from the current editor.</td>
436 </tr>
437 <tr>
438 <td><a href="#NumbersWidget.on_octOutButton_clicked">on_octOutButton_clicked</a></td>
439 <td>Private slot to send an octal number.</td>
440 </tr>
441 <tr>
442 <td><a href="#NumbersWidget.on_sizeBox_valueChanged">on_sizeBox_valueChanged</a></td>
443 <td>Private slot handling a change of the bit size.</td>
444 </tr>
445 </table>
446 <h3>Static Methods</h3>
447
448 <table>
449 <tr><td>None</td></tr>
450 </table>
451
452 <a NAME="NumbersWidget.__init__" ID="NumbersWidget.__init__"></a>
453 <h4>NumbersWidget (Constructor)</h4>
454 <b>NumbersWidget</b>(<i>parent=None</i>)
455
456 <p>
457 Constructor
458 </p>
459 <dl>
460
461 <dt><i>parent</i></dt>
462 <dd>
463 reference to the parent widget (QWidget)
464 </dd>
465 </dl>
466 <a NAME="NumbersWidget.__binModelDataChanged" ID="NumbersWidget.__binModelDataChanged"></a>
467 <h4>NumbersWidget.__binModelDataChanged</h4>
468 <b>__binModelDataChanged</b>(<i>start, end</i>)
469
470 <p>
471 Private slot to handle a change of the binary model value by the user.
472 </p>
473 <dl>
474
475 <dt><i>start</i></dt>
476 <dd>
477 start index (QModelIndex)
478 </dd>
479 <dt><i>end</i></dt>
480 <dd>
481 end index (QModelIndex)
482 </dd>
483 </dl>
484 <a NAME="NumbersWidget.__block" ID="NumbersWidget.__block"></a>
485 <h4>NumbersWidget.__block</h4>
486 <b>__block</b>(<i>b</i>)
487
488 <p>
489 Private slot to block some signals.
490 </p>
491 <dl>
492
493 <dt><i>b</i></dt>
494 <dd>
495 flah indicating the blocking state (boolean)
496 </dd>
497 </dl>
498 <a NAME="NumbersWidget.__formatNumbers" ID="NumbersWidget.__formatNumbers"></a>
499 <h4>NumbersWidget.__formatNumbers</h4>
500 <b>__formatNumbers</b>(<i>numberFormat</i>)
501
502 <p>
503 Private method to format the various number inputs.
504 </p>
505 <dl>
506
507 <dt><i>numberFormat</i></dt>
508 <dd>
509 number format indicator (integer)
510 </dd>
511 </dl>
512 <a NAME="NumbersWidget.on_binEdit_textChanged" ID="NumbersWidget.on_binEdit_textChanged"></a>
513 <h4>NumbersWidget.on_binEdit_textChanged</h4>
514 <b>on_binEdit_textChanged</b>(<i>txt</i>)
515
516 <p>
517 Private slot to handle input of a binary number.
518 </p>
519 <dl>
520
521 <dt><i>txt</i></dt>
522 <dd>
523 text entered (string)
524 </dd>
525 </dl>
526 <a NAME="NumbersWidget.on_binInButton_clicked" ID="NumbersWidget.on_binInButton_clicked"></a>
527 <h4>NumbersWidget.on_binInButton_clicked</h4>
528 <b>on_binInButton_clicked</b>(<i></i>)
529
530 <p>
531 Private slot to retrieve a binary number from the current editor.
532 </p>
533 <a NAME="NumbersWidget.on_binOutButton_clicked" ID="NumbersWidget.on_binOutButton_clicked"></a>
534 <h4>NumbersWidget.on_binOutButton_clicked</h4>
535 <b>on_binOutButton_clicked</b>(<i></i>)
536
537 <p>
538 Private slot to send a binary number.
539 </p>
540 <a NAME="NumbersWidget.on_byteOrderButton_clicked" ID="NumbersWidget.on_byteOrderButton_clicked"></a>
541 <h4>NumbersWidget.on_byteOrderButton_clicked</h4>
542 <b>on_byteOrderButton_clicked</b>(<i></i>)
543
544 <p>
545 Private slot to swap the byte order.
546 </p>
547 <a NAME="NumbersWidget.on_decEdit_textChanged" ID="NumbersWidget.on_decEdit_textChanged"></a>
548 <h4>NumbersWidget.on_decEdit_textChanged</h4>
549 <b>on_decEdit_textChanged</b>(<i>txt</i>)
550
551 <p>
552 Private slot to handle input of a decimal number.
553 </p>
554 <dl>
555
556 <dt><i>txt</i></dt>
557 <dd>
558 text entered (string)
559 </dd>
560 </dl>
561 <a NAME="NumbersWidget.on_decInButton_clicked" ID="NumbersWidget.on_decInButton_clicked"></a>
562 <h4>NumbersWidget.on_decInButton_clicked</h4>
563 <b>on_decInButton_clicked</b>(<i></i>)
564
565 <p>
566 Private slot to retrieve a decimal number from the current editor.
567 </p>
568 <a NAME="NumbersWidget.on_decOutButton_clicked" ID="NumbersWidget.on_decOutButton_clicked"></a>
569 <h4>NumbersWidget.on_decOutButton_clicked</h4>
570 <b>on_decOutButton_clicked</b>(<i></i>)
571
572 <p>
573 Private slot to send a decimal number.
574 </p>
575 <a NAME="NumbersWidget.on_hexEdit_textChanged" ID="NumbersWidget.on_hexEdit_textChanged"></a>
576 <h4>NumbersWidget.on_hexEdit_textChanged</h4>
577 <b>on_hexEdit_textChanged</b>(<i>txt</i>)
578
579 <p>
580 Private slot to handle input of a hexadecimal number.
581 </p>
582 <dl>
583
584 <dt><i>txt</i></dt>
585 <dd>
586 text entered (string)
587 </dd>
588 </dl>
589 <a NAME="NumbersWidget.on_hexInButton_clicked" ID="NumbersWidget.on_hexInButton_clicked"></a>
590 <h4>NumbersWidget.on_hexInButton_clicked</h4>
591 <b>on_hexInButton_clicked</b>(<i></i>)
592
593 <p>
594 Private slot to retrieve a hexadecimal number from the current editor.
595 </p>
596 <a NAME="NumbersWidget.on_hexOutButton_clicked" ID="NumbersWidget.on_hexOutButton_clicked"></a>
597 <h4>NumbersWidget.on_hexOutButton_clicked</h4>
598 <b>on_hexOutButton_clicked</b>(<i></i>)
599
600 <p>
601 Private slot to send a hexadecimal number.
602 </p>
603 <a NAME="NumbersWidget.on_octEdit_textChanged" ID="NumbersWidget.on_octEdit_textChanged"></a>
604 <h4>NumbersWidget.on_octEdit_textChanged</h4>
605 <b>on_octEdit_textChanged</b>(<i>txt</i>)
606
607 <p>
608 Private slot to handle input of an octal number.
609 </p>
610 <dl>
611
612 <dt><i>txt</i></dt>
613 <dd>
614 text entered (string)
615 </dd>
616 </dl>
617 <a NAME="NumbersWidget.on_octInButton_clicked" ID="NumbersWidget.on_octInButton_clicked"></a>
618 <h4>NumbersWidget.on_octInButton_clicked</h4>
619 <b>on_octInButton_clicked</b>(<i></i>)
620
621 <p>
622 Private slot to retrieve an octal number from the current editor.
623 </p>
624 <a NAME="NumbersWidget.on_octOutButton_clicked" ID="NumbersWidget.on_octOutButton_clicked"></a>
625 <h4>NumbersWidget.on_octOutButton_clicked</h4>
626 <b>on_octOutButton_clicked</b>(<i></i>)
627
628 <p>
629 Private slot to send an octal number.
630 </p>
631 <a NAME="NumbersWidget.on_sizeBox_valueChanged" ID="NumbersWidget.on_sizeBox_valueChanged"></a>
632 <h4>NumbersWidget.on_sizeBox_valueChanged</h4>
633 <b>on_sizeBox_valueChanged</b>(<i>value</i>)
634
635 <p>
636 Private slot handling a change of the bit size.
637 </p>
638 <dl>
639
640 <dt><i>value</i></dt>
641 <dd>
642 selected bit size (integer)
643 </dd>
644 </dl>
645 <div align="right"><a href="#top">Up</a></div>
646 <hr />
647 </body></html>

eric ide

mercurial