Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Gui.E5Led.html

eric6/Documentation/Source/eric6.E5Gui.E5Led.html

changeset 8268
6b8128e0c9d1
parent 8215
fc5d68a6889e
equal deleted inserted replaced
8267:6baca884c73a 8268:6b8128e0c9d1
29 It was inspired by KLed. 29 It was inspired by KLed.
30 </p> 30 </p>
31 <h3>Global Attributes</h3> 31 <h3>Global Attributes</h3>
32 32
33 <table> 33 <table>
34 <tr><td>E5LedCircular</td></tr><tr><td>E5LedRectangular</td></tr> 34 <tr><td>None</td></tr>
35 </table> 35 </table>
36 <h3>Classes</h3> 36 <h3>Classes</h3>
37 37
38 <table> 38 <table>
39 39
42 <td>Class implementing a clickable LED widget.</td> 42 <td>Class implementing a clickable LED widget.</td>
43 </tr> 43 </tr>
44 <tr> 44 <tr>
45 <td><a href="#E5Led">E5Led</a></td> 45 <td><a href="#E5Led">E5Led</a></td>
46 <td>Class implementing a LED widget.</td> 46 <td>Class implementing a LED widget.</td>
47 </tr>
48 <tr>
49 <td><a href="#E5LedType">E5LedType</a></td>
50 <td>Class defining the LED types.</td>
47 </tr> 51 </tr>
48 </table> 52 </table>
49 <h3>Functions</h3> 53 <h3>Functions</h3>
50 54
51 <table> 55 <table>
104 <tr><td>None</td></tr> 108 <tr><td>None</td></tr>
105 </table> 109 </table>
106 110
107 <a NAME="E5ClickableLed.__init__" ID="E5ClickableLed.__init__"></a> 111 <a NAME="E5ClickableLed.__init__" ID="E5ClickableLed.__init__"></a>
108 <h4>E5ClickableLed (Constructor)</h4> 112 <h4>E5ClickableLed (Constructor)</h4>
109 <b>E5ClickableLed</b>(<i>parent=None, color=None, shape=E5LedCircular, rectRatio=1</i>) 113 <b>E5ClickableLed</b>(<i>parent=None, color=None, shape=E5LedType.CIRCULAR, rectRatio=1</i>)
110 114
111 <p> 115 <p>
112 Constructor 116 Constructor
113 </p> 117 </p>
114 <dl> 118 <dl>
115 119
116 <dt><i>parent</i></dt> 120 <dt><i>parent</i> (QWidget)</dt>
117 <dd> 121 <dd>
118 reference to parent widget (QWidget) 122 reference to parent widget
119 </dd> 123 </dd>
120 <dt><i>color</i></dt> 124 <dt><i>color</i> (QColor)</dt>
121 <dd> 125 <dd>
122 color of the LED (QColor) 126 color of the LED
123 </dd> 127 </dd>
124 <dt><i>shape</i></dt> 128 <dt><i>shape</i> (E5LedType)</dt>
125 <dd> 129 <dd>
126 shape of the LED (E5LedCircular, E5LedRectangular) 130 shape of the LED
127 </dd> 131 </dd>
128 <dt><i>rectRatio</i></dt> 132 <dt><i>rectRatio</i> (float)</dt>
129 <dd> 133 <dd>
130 ratio width to height, if shape is rectangular (float) 134 ratio width to height, if shape is rectangular
131 </dd> 135 </dd>
132 </dl> 136 </dl>
133 <a NAME="E5ClickableLed.mouseReleaseEvent" ID="E5ClickableLed.mouseReleaseEvent"></a> 137 <a NAME="E5ClickableLed.mouseReleaseEvent" ID="E5ClickableLed.mouseReleaseEvent"></a>
134 <h4>E5ClickableLed.mouseReleaseEvent</h4> 138 <h4>E5ClickableLed.mouseReleaseEvent</h4>
135 <b>mouseReleaseEvent</b>(<i>evt</i>) 139 <b>mouseReleaseEvent</b>(<i>evt</i>)
264 <tr><td>None</td></tr> 268 <tr><td>None</td></tr>
265 </table> 269 </table>
266 270
267 <a NAME="E5Led.__init__" ID="E5Led.__init__"></a> 271 <a NAME="E5Led.__init__" ID="E5Led.__init__"></a>
268 <h4>E5Led (Constructor)</h4> 272 <h4>E5Led (Constructor)</h4>
269 <b>E5Led</b>(<i>parent=None, color=None, shape=E5LedCircular, rectRatio=1</i>) 273 <b>E5Led</b>(<i>parent=None, color=None, shape=E5LedType.CIRCULAR, rectRatio=1</i>)
270 274
271 <p> 275 <p>
272 Constructor 276 Constructor
273 </p> 277 </p>
274 <dl> 278 <dl>
275 279
276 <dt><i>parent</i></dt> 280 <dt><i>parent</i> (QWidget)</dt>
277 <dd> 281 <dd>
278 reference to parent widget (QWidget) 282 reference to parent widget
279 </dd> 283 </dd>
280 <dt><i>color</i></dt> 284 <dt><i>color</i> (QColor)</dt>
281 <dd> 285 <dd>
282 color of the LED (QColor) 286 color of the LED
283 </dd> 287 </dd>
284 <dt><i>shape</i></dt> 288 <dt><i>shape</i> (E5LedType)</dt>
285 <dd> 289 <dd>
286 shape of the LED (E5LedCircular, E5LedRectangular) 290 shape of the LED
287 </dd> 291 </dd>
288 <dt><i>rectRatio</i></dt> 292 <dt><i>rectRatio</i> (float)</dt>
289 <dd> 293 <dd>
290 ratio width to height, if shape is rectangular (float) 294 ratio width to height, if shape is rectangular
291 </dd> 295 </dd>
292 </dl> 296 </dl>
293 <a NAME="E5Led.__getBestRoundSize" ID="E5Led.__getBestRoundSize"></a> 297 <a NAME="E5Led.__getBestRoundSize" ID="E5Led.__getBestRoundSize"></a>
294 <h4>E5Led.__getBestRoundSize</h4> 298 <h4>E5Led.__getBestRoundSize</h4>
295 <b>__getBestRoundSize</b>(<i></i>) 299 <b>__getBestRoundSize</b>(<i></i>)
408 <dt><i>evt</i> (QPaintEvent)</dt> 412 <dt><i>evt</i> (QPaintEvent)</dt>
409 <dd> 413 <dd>
410 paint event object 414 paint event object
411 </dd> 415 </dd>
412 </dl> 416 </dl>
413 <dl>
414
415 <dt>Raises <b>TypeError</b>:</dt>
416 <dd>
417 The E5Led has an unsupported shape type.
418 </dd>
419 </dl>
420 <a NAME="E5Led.ratio" ID="E5Led.ratio"></a> 417 <a NAME="E5Led.ratio" ID="E5Led.ratio"></a>
421 <h4>E5Led.ratio</h4> 418 <h4>E5Led.ratio</h4>
422 <b>ratio</b>(<i></i>) 419 <b>ratio</b>(<i></i>)
423 420
424 <p> 421 <p>
507 <p> 504 <p>
508 Public method to set the LED shape. 505 Public method to set the LED shape.
509 </p> 506 </p>
510 <dl> 507 <dl>
511 508
512 <dt><i>shape</i></dt> 509 <dt><i>shape</i> (E5LedType)</dt>
513 <dd> 510 <dd>
514 new LED shape (E5LedCircular, E5LedRectangular) 511 new LED shape
515 </dd> 512 </dd>
516 </dl> 513 </dl>
517 <a NAME="E5Led.shape" ID="E5Led.shape"></a> 514 <a NAME="E5Led.shape" ID="E5Led.shape"></a>
518 <h4>E5Led.shape</h4> 515 <h4>E5Led.shape</h4>
519 <b>shape</b>(<i></i>) 516 <b>shape</b>(<i></i>)
522 Public method to return the LED shape. 519 Public method to return the LED shape.
523 </p> 520 </p>
524 <dl> 521 <dl>
525 <dt>Return:</dt> 522 <dt>Return:</dt>
526 <dd> 523 <dd>
527 LED shape (E5LedCircular, E5LedRectangular) 524 LED shape
525 </dd>
526 </dl>
527 <dl>
528 <dt>Return Type:</dt>
529 <dd>
530 E5LedType
528 </dd> 531 </dd>
529 </dl> 532 </dl>
530 <a NAME="E5Led.sizeHint" ID="E5Led.sizeHint"></a> 533 <a NAME="E5Led.sizeHint" ID="E5Led.sizeHint"></a>
531 <h4>E5Led.sizeHint</h4> 534 <h4>E5Led.sizeHint</h4>
532 <b>sizeHint</b>(<i></i>) 535 <b>sizeHint</b>(<i></i>)
547 <p> 550 <p>
548 Public slot to toggle the LED state. 551 Public slot to toggle the LED state.
549 </p> 552 </p>
550 <div align="right"><a href="#top">Up</a></div> 553 <div align="right"><a href="#top">Up</a></div>
551 <hr /> 554 <hr />
555 <hr />
556 <a NAME="E5LedType" ID="E5LedType"></a>
557 <h2>E5LedType</h2>
558
559 <p>
560 Class defining the LED types.
561 </p>
562 <h3>Derived from</h3>
563 enum.Enum
564 <h3>Class Attributes</h3>
565
566 <table>
567 <tr><td>CIRCULAR</td></tr><tr><td>RECTANGULAR</td></tr>
568 </table>
569 <h3>Class Methods</h3>
570
571 <table>
572 <tr><td>None</td></tr>
573 </table>
574 <h3>Methods</h3>
575
576 <table>
577 <tr><td>None</td></tr>
578 </table>
579 <h3>Static Methods</h3>
580
581 <table>
582 <tr><td>None</td></tr>
583 </table>
584
585 <div align="right"><a href="#top">Up</a></div>
586 <hr />
552 </body></html> 587 </body></html>

Mercurial Repository: eric

eric ide

mercurial