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

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

eric ide

mercurial