Documentation/Source/eric5.E5Gui.E5Led.html

changeset 58
37f0444c3479
parent 55
b5c84934de9c
child 409
0ea528e80202
--- a/Documentation/Source/eric5.E5Gui.E5Led.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.E5Gui.E5Led.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,9 +22,9 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.E5Gui.E5Led</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#76;&#69;&#68; w&#105;&#100;&#103;&#101;&#116;.
+Module implementing a LED widget.
 </p><p>
-&#73;&#116; w&#97;&#115; &#105;&#110;&#115;&#112;&#105;&#114;&#101;&#100; &#98;y &#75;&#76;&#101;&#100;.
+It was inspired by KLed.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -34,7 +34,7 @@
 <table>
 <tr>
 <td><a href="#E5Led">E5Led</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#76;&#69;&#68; w&#105;&#100;&#103;&#101;&#116;.</td>
+<td>Class implementing a LED widget.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -45,7 +45,7 @@
 <a NAME="E5Led" ID="E5Led"></a>
 <h2>E5Led</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#76;&#69;&#68; w&#105;&#100;&#103;&#101;&#116;.
+    Class implementing a LED widget.
 </p>
 <h3>Derived from</h3>
 QWidget
@@ -57,281 +57,281 @@
 <table>
 <tr>
 <td><a href="#E5Led.__init__">E5Led</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#E5Led.__getBestRoundSize">__getBestRoundSize</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#116;&#104;&#101; w&#105;&#100;&#116;&#104; &#111;&#102; &#116;&#104;&#101; &#76;&#69;&#68;.</td>
+<td>Private method to calculate the width of the LED.</td>
 </tr><tr>
 <td><a href="#E5Led.__paintRectangular">__paintRectangular</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#97;&#105;&#110;&#116; &#97; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; &#114;&#97;&#105;&#115;&#101;&#100; &#76;&#69;&#68;.</td>
+<td>Private method to paint a rectangular raised LED.</td>
 </tr><tr>
 <td><a href="#E5Led.__paintRound">__paintRound</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#97;&#105;&#110;&#116; &#97; &#114;&#111;&#117;&#110;&#100; &#114;&#97;&#105;&#115;&#101;&#100; &#76;&#69;&#68;.</td>
+<td>Private method to paint a round raised LED.</td>
 </tr><tr>
 <td><a href="#E5Led.color">color</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#76;&#69;&#68; &#99;&#111;&#108;&#111;&#114;.</td>
+<td>Public method to return the LED color.</td>
 </tr><tr>
 <td><a href="#E5Led.darkFactor">darkFactor</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#100;&#97;&#114;&#107; &#102;&#97;&#99;&#116;&#111;&#114;.</td>
+<td>Public method to return the dark factor.</td>
 </tr><tr>
 <td><a href="#E5Led.isFramed">isFramed</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#102;&#114;&#97;&#109;&#101;&#100; &#115;&#116;&#97;&#116;&#101;.</td>
+<td>Public method to return the framed state.</td>
 </tr><tr>
 <td><a href="#E5Led.isOn">isOn</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#76;&#69;&#68; &#115;&#116;&#97;&#116;&#101;.</td>
+<td>Public method to return the LED state.</td>
 </tr><tr>
 <td><a href="#E5Led.minimumSizeHint">minimumSizeHint</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#105;v&#101; &#97; &#104;&#105;&#110;&#116; &#97;&#98;&#111;&#117;&#116; &#111;&#117;&#114; &#109;&#105;&#110;&#105;&#109;&#117;&#109; &#115;&#105;z&#101;.</td>
+<td>Public method to give a hint about our minimum size.</td>
 </tr><tr>
 <td><a href="#E5Led.off">off</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#116;&#111; &#111;&#102;&#102;.</td>
+<td>Public slot to set the LED to off.</td>
 </tr><tr>
 <td><a href="#E5Led.on">on</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#116;&#111; &#111;&#110;.</td>
+<td>Public slot to set the LED to on.</td>
 </tr><tr>
 <td><a href="#E5Led.paintEvent">paintEvent</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#116;&#104;&#101; &#112;&#97;&#105;&#110;&#116; &#101;v&#101;&#110;&#116;.</td>
+<td>Protected slot handling the paint event.</td>
 </tr><tr>
 <td><a href="#E5Led.ratio">ratio</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#76;&#69;&#68; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; &#114;&#97;&#116;&#105;&#111; (w&#105;&#100;&#116;&#104; / &#104;&#101;&#105;&#103;&#104;&#116;).</td>
+<td>Public method to return the LED rectangular ratio (width / height).</td>
 </tr><tr>
 <td><a href="#E5Led.setColor">setColor</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#99;&#111;&#108;&#111;&#114;.</td>
+<td>Public method to set the LED color.</td>
 </tr><tr>
 <td><a href="#E5Led.setDarkFactor">setDarkFactor</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#100;&#97;&#114;&#107; &#102;&#97;&#99;&#116;&#111;&#114;.</td>
+<td>Public method to set the dark factor.</td>
 </tr><tr>
 <td><a href="#E5Led.setFramed">setFramed</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#95;&#95;&#102;&#114;&#97;&#109;&#101;&#100;&#76;&#101;&#100; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;.</td>
+<td>Public slot to set the __framedLed attribute.</td>
 </tr><tr>
 <td><a href="#E5Led.setOn">setOn</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#116;&#111; &#111;&#110;.</td>
+<td>Public method to set the LED to on.</td>
 </tr><tr>
 <td><a href="#E5Led.setRatio">setRatio</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; &#114;&#97;&#116;&#105;&#111; (w&#105;&#100;&#116;&#104; / &#104;&#101;&#105;&#103;&#104;&#116;).</td>
+<td>Public method to set the LED rectangular ratio (width / height).</td>
 </tr><tr>
 <td><a href="#E5Led.setShape">setShape</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#115;&#104;&#97;&#112;&#101;.</td>
+<td>Public method to set the LED shape.</td>
 </tr><tr>
 <td><a href="#E5Led.shape">shape</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#76;&#69;&#68; &#115;&#104;&#97;&#112;&#101;.</td>
+<td>Public method to return the LED shape.</td>
 </tr><tr>
 <td><a href="#E5Led.sizeHint">sizeHint</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#105;v&#101; &#97; &#104;&#105;&#110;&#116; &#97;&#98;&#111;&#117;&#116; &#111;&#117;&#114; &#100;&#101;&#115;&#105;&#114;&#101;&#100; &#115;&#105;z&#101;.</td>
+<td>Public method to give a hint about our desired size.</td>
 </tr><tr>
 <td><a href="#E5Led.toggle">toggle</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#116;&#111;&#103;&#103;&#108;&#101; &#116;&#104;&#101; &#76;&#69;&#68; &#115;&#116;&#97;&#116;&#101;.</td>
+<td>Public slot to toggle the LED state.</td>
 </tr>
 </table>
 <a NAME="E5Led.__init__" ID="E5Led.__init__"></a>
 <h4>E5Led (Constructor)</h4>
 <b>E5Led</b>(<i>parent = None, color = None, shape = E5LedCircular, rectRatio = 1</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to parent widget (QWidget)
 </dd><dt><i>color</i></dt>
 <dd>
-&#99;&#111;&#108;&#111;&#114; &#111;&#102; &#116;&#104;&#101; &#76;&#69;&#68; (&#81;&#67;&#111;&#108;&#111;&#114;)
+color of the LED (QColor)
 </dd><dt><i>shape</i></dt>
 <dd>
-&#115;&#104;&#97;&#112;&#101; &#111;&#102; &#116;&#104;&#101; &#76;&#69;&#68; (&#69;&#53;&#76;&#101;&#100;&#67;&#105;&#114;&#99;&#117;&#108;&#97;&#114;, &#69;&#53;&#76;&#101;&#100;&#82;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114;)
+shape of the LED (E5LedCircular, E5LedRectangular)
 </dd><dt><i>rectRation</i></dt>
 <dd>
-&#114;&#97;&#116;&#105;&#111; w&#105;&#100;&#116;&#104; &#116;&#111; &#104;&#101;&#105;&#103;&#104;&#116;, &#105;&#102; &#115;&#104;&#97;&#112;&#101; &#105;&#115; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; (&#102;&#108;&#111;&#97;&#116;)
+ratio width to height, if shape is rectangular (float)
 </dd>
 </dl><a NAME="E5Led.__getBestRoundSize" ID="E5Led.__getBestRoundSize"></a>
 <h4>E5Led.__getBestRoundSize</h4>
 <b>__getBestRoundSize</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#116;&#104;&#101; w&#105;&#100;&#116;&#104; &#111;&#102; &#116;&#104;&#101; &#76;&#69;&#68;.
+        Private method to calculate the width of the LED.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#110;&#101;w w&#105;&#100;&#116;&#104; &#111;&#102; &#116;&#104;&#101; &#76;&#69;&#68; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+new width of the LED (integer)
 </dd>
 </dl><a NAME="E5Led.__paintRectangular" ID="E5Led.__paintRectangular"></a>
 <h4>E5Led.__paintRectangular</h4>
 <b>__paintRectangular</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#97;&#105;&#110;&#116; &#97; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; &#114;&#97;&#105;&#115;&#101;&#100; &#76;&#69;&#68;.
+        Private method to paint a rectangular raised LED.
 </p><a NAME="E5Led.__paintRound" ID="E5Led.__paintRound"></a>
 <h4>E5Led.__paintRound</h4>
 <b>__paintRound</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#97;&#105;&#110;&#116; &#97; &#114;&#111;&#117;&#110;&#100; &#114;&#97;&#105;&#115;&#101;&#100; &#76;&#69;&#68;.
+        Private method to paint a round raised LED.
 </p><a NAME="E5Led.color" ID="E5Led.color"></a>
 <h4>E5Led.color</h4>
 <b>color</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#76;&#69;&#68; &#99;&#111;&#108;&#111;&#114;.
+        Public method to return the LED color.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#99;&#111;&#108;&#111;&#114; &#111;&#102; &#116;&#104;&#101; &#76;&#69;&#68; (&#81;&#67;&#111;&#108;&#111;&#114;)
+color of the LED (QColor)
 </dd>
 </dl><a NAME="E5Led.darkFactor" ID="E5Led.darkFactor"></a>
 <h4>E5Led.darkFactor</h4>
 <b>darkFactor</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#100;&#97;&#114;&#107; &#102;&#97;&#99;&#116;&#111;&#114;.
+        Public method to return the dark factor.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#100;&#97;&#114;&#107; &#102;&#97;&#99;&#116;&#111;&#114; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+the current dark factor (integer)
 </dd>
 </dl><a NAME="E5Led.isFramed" ID="E5Led.isFramed"></a>
 <h4>E5Led.isFramed</h4>
 <b>isFramed</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#102;&#114;&#97;&#109;&#101;&#100; &#115;&#116;&#97;&#116;&#101;.
+        Public method to return the framed state.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#102;&#114;&#97;&#109;&#101;&#100; &#115;&#116;&#97;&#116;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the current framed state (boolean)
 </dd>
 </dl><a NAME="E5Led.isOn" ID="E5Led.isOn"></a>
 <h4>E5Led.isOn</h4>
 <b>isOn</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#76;&#69;&#68; &#115;&#116;&#97;&#116;&#101;.
+        Public method to return the LED state.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#108;&#105;&#103;&#104;&#116; &#115;&#116;&#97;&#116;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the light state (boolean)
 </dd>
 </dl><a NAME="E5Led.minimumSizeHint" ID="E5Led.minimumSizeHint"></a>
 <h4>E5Led.minimumSizeHint</h4>
 <b>minimumSizeHint</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#105;v&#101; &#97; &#104;&#105;&#110;&#116; &#97;&#98;&#111;&#117;&#116; &#111;&#117;&#114; &#109;&#105;&#110;&#105;&#109;&#117;&#109; &#115;&#105;z&#101;.
+        Public method to give a hint about our minimum size.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#105;z&#101; &#104;&#105;&#110;&#116; (&#81;&#83;&#105;z&#101;)
+size hint (QSize)
 </dd>
 </dl><a NAME="E5Led.off" ID="E5Led.off"></a>
 <h4>E5Led.off</h4>
 <b>off</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#116;&#111; &#111;&#102;&#102;.
+        Public slot to set the LED to off.
 </p><a NAME="E5Led.on" ID="E5Led.on"></a>
 <h4>E5Led.on</h4>
 <b>on</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#116;&#111; &#111;&#110;.
+        Public slot to set the LED to on.
 </p><a NAME="E5Led.paintEvent" ID="E5Led.paintEvent"></a>
 <h4>E5Led.paintEvent</h4>
 <b>paintEvent</b>(<i>evt</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#116;&#104;&#101; &#112;&#97;&#105;&#110;&#116; &#101;v&#101;&#110;&#116;.
+        Protected slot handling the paint event.
 </p><dl>
 <dt><i>evt</i></dt>
 <dd>
-&#112;&#97;&#105;&#110;&#116; &#101;v&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#80;&#97;&#105;&#110;&#116;&#69;v&#101;&#110;&#116;)
+paint event object (QPaintEvent)
 </dd>
 </dl><dl>
 <dt>Raises <b>TypeError</b>:</dt>
 <dd>
-&#84;&#104;&#101; &#69;&#53;&#76;&#101;&#100; &#104;&#97;&#115; &#97;&#110; &#117;&#110;&#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100; &#115;&#104;&#97;&#112;&#101; &#116;y&#112;&#101;.
+The E5Led has an unsupported shape type.
 </dd>
 </dl><a NAME="E5Led.ratio" ID="E5Led.ratio"></a>
 <h4>E5Led.ratio</h4>
 <b>ratio</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#76;&#69;&#68; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; &#114;&#97;&#116;&#105;&#111; (w&#105;&#100;&#116;&#104; / &#104;&#101;&#105;&#103;&#104;&#116;).
+        Public method to return the LED rectangular ratio (width / height).
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#76;&#69;&#68; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; &#114;&#97;&#116;&#105;&#111; (&#102;&#108;&#111;&#97;&#116;)
+LED rectangular ratio (float)
 </dd>
 </dl><a NAME="E5Led.setColor" ID="E5Led.setColor"></a>
 <h4>E5Led.setColor</h4>
 <b>setColor</b>(<i>color</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#99;&#111;&#108;&#111;&#114;.
+        Public method to set the LED color.
 </p><dl>
 <dt><i>color</i></dt>
 <dd>
-&#99;&#111;&#108;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#76;&#69;&#68; (&#81;&#67;&#111;&#108;&#111;&#114;)
+color for the LED (QColor)
 </dd>
 </dl><a NAME="E5Led.setDarkFactor" ID="E5Led.setDarkFactor"></a>
 <h4>E5Led.setDarkFactor</h4>
 <b>setDarkFactor</b>(<i>darkfactor</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#100;&#97;&#114;&#107; &#102;&#97;&#99;&#116;&#111;&#114;.
+        Public method to set the dark factor.
 </p><dl>
 <dt><i>darkfactor</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#115;&#101;&#116; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#97;&#114;&#107; &#102;&#97;&#99;&#116;&#111;&#114; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+value to set for the dark factor (integer)
 </dd>
 </dl><a NAME="E5Led.setFramed" ID="E5Led.setFramed"></a>
 <h4>E5Led.setFramed</h4>
 <b>setFramed</b>(<i>framed</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#95;&#95;&#102;&#114;&#97;&#109;&#101;&#100;&#76;&#101;&#100; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;.
+        Public slot to set the __framedLed attribute.
 </p><dl>
 <dt><i>framed</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#102;&#114;&#97;&#109;&#101;&#100; &#115;&#116;&#97;&#116;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the framed state (boolean)
 </dd>
 </dl><a NAME="E5Led.setOn" ID="E5Led.setOn"></a>
 <h4>E5Led.setOn</h4>
 <b>setOn</b>(<i>state</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#116;&#111; &#111;&#110;.
+        Public method to set the LED to on.
 </p><dl>
 <dt><i>state</i></dt>
 <dd>
-&#110;&#101;w &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; &#76;&#69;&#68; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+new state of the LED (boolean)
 </dd>
 </dl><a NAME="E5Led.setRatio" ID="E5Led.setRatio"></a>
 <h4>E5Led.setRatio</h4>
 <b>setRatio</b>(<i>ratio</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; &#114;&#97;&#116;&#105;&#111; (w&#105;&#100;&#116;&#104; / &#104;&#101;&#105;&#103;&#104;&#116;).
+        Public method to set the LED rectangular ratio (width / height).
 </p><dl>
 <dt><i>ratio</i></dt>
 <dd>
-&#110;&#101;w &#76;&#69;&#68; &#114;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114; &#114;&#97;&#116;&#105;&#111; (&#102;&#108;&#111;&#97;&#116;)
+new LED rectangular ratio (float)
 </dd>
 </dl><a NAME="E5Led.setShape" ID="E5Led.setShape"></a>
 <h4>E5Led.setShape</h4>
 <b>setShape</b>(<i>shape</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#76;&#69;&#68; &#115;&#104;&#97;&#112;&#101;.
+        Public method to set the LED shape.
 </p><dl>
 <dt><i>shape</i></dt>
 <dd>
-&#110;&#101;w &#76;&#69;&#68; &#115;&#104;&#97;&#112;&#101; (&#69;&#53;&#76;&#101;&#100;&#67;&#105;&#114;&#99;&#117;&#108;&#97;&#114;, &#69;&#53;&#76;&#101;&#100;&#82;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114;)
+new LED shape (E5LedCircular, E5LedRectangular)
 </dd>
 </dl><a NAME="E5Led.shape" ID="E5Led.shape"></a>
 <h4>E5Led.shape</h4>
 <b>shape</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#76;&#69;&#68; &#115;&#104;&#97;&#112;&#101;.
+        Public method to return the LED shape.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#76;&#69;&#68; &#115;&#104;&#97;&#112;&#101; (&#69;&#53;&#76;&#101;&#100;&#67;&#105;&#114;&#99;&#117;&#108;&#97;&#114;, &#69;&#53;&#76;&#101;&#100;&#82;&#101;&#99;&#116;&#97;&#110;&#103;&#117;&#108;&#97;&#114;)
+LED shape (E5LedCircular, E5LedRectangular)
 </dd>
 </dl><a NAME="E5Led.sizeHint" ID="E5Led.sizeHint"></a>
 <h4>E5Led.sizeHint</h4>
 <b>sizeHint</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#105;v&#101; &#97; &#104;&#105;&#110;&#116; &#97;&#98;&#111;&#117;&#116; &#111;&#117;&#114; &#100;&#101;&#115;&#105;&#114;&#101;&#100; &#115;&#105;z&#101;.
+        Public method to give a hint about our desired size.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#105;z&#101; &#104;&#105;&#110;&#116; (&#81;&#83;&#105;z&#101;)
+size hint (QSize)
 </dd>
 </dl><a NAME="E5Led.toggle" ID="E5Led.toggle"></a>
 <h4>E5Led.toggle</h4>
 <b>toggle</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#116;&#111;&#103;&#103;&#108;&#101; &#116;&#104;&#101; &#76;&#69;&#68; &#115;&#116;&#97;&#116;&#101;.
+        Public slot to toggle the LED state.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial