Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.UI.NumbersWidget.html

Documentation/Source/eric5.UI.NumbersWidget.html

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

Mercurial Repository: eric

eric ide

mercurial