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

changeset 8268
6b8128e0c9d1
parent 8215
fc5d68a6889e
--- a/eric6/Documentation/Source/eric6.E5Gui.E5Led.html	Tue Apr 27 17:42:00 2021 +0200
+++ b/eric6/Documentation/Source/eric6.E5Gui.E5Led.html	Wed Apr 28 19:42:28 2021 +0200
@@ -31,7 +31,7 @@
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>E5LedCircular</td></tr><tr><td>E5LedRectangular</td></tr>
+<tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
 
@@ -45,6 +45,10 @@
 <td><a href="#E5Led">E5Led</a></td>
 <td>Class implementing a LED widget.</td>
 </tr>
+<tr>
+<td><a href="#E5LedType">E5LedType</a></td>
+<td>Class defining the LED types.</td>
+</tr>
 </table>
 <h3>Functions</h3>
 
@@ -106,28 +110,28 @@
 
 <a NAME="E5ClickableLed.__init__" ID="E5ClickableLed.__init__"></a>
 <h4>E5ClickableLed (Constructor)</h4>
-<b>E5ClickableLed</b>(<i>parent=None, color=None, shape=E5LedCircular, rectRatio=1</i>)
+<b>E5ClickableLed</b>(<i>parent=None, color=None, shape=E5LedType.CIRCULAR, rectRatio=1</i>)
 
 <p>
         Constructor
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to parent widget (QWidget)
+reference to parent widget
 </dd>
-<dt><i>color</i></dt>
+<dt><i>color</i> (QColor)</dt>
 <dd>
-color of the LED (QColor)
+color of the LED
 </dd>
-<dt><i>shape</i></dt>
+<dt><i>shape</i> (E5LedType)</dt>
 <dd>
-shape of the LED (E5LedCircular, E5LedRectangular)
+shape of the LED
 </dd>
-<dt><i>rectRatio</i></dt>
+<dt><i>rectRatio</i> (float)</dt>
 <dd>
-ratio width to height, if shape is rectangular (float)
+ratio width to height, if shape is rectangular
 </dd>
 </dl>
 <a NAME="E5ClickableLed.mouseReleaseEvent" ID="E5ClickableLed.mouseReleaseEvent"></a>
@@ -266,28 +270,28 @@
 
 <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>)
+<b>E5Led</b>(<i>parent=None, color=None, shape=E5LedType.CIRCULAR, rectRatio=1</i>)
 
 <p>
         Constructor
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to parent widget (QWidget)
+reference to parent widget
 </dd>
-<dt><i>color</i></dt>
+<dt><i>color</i> (QColor)</dt>
 <dd>
-color of the LED (QColor)
+color of the LED
 </dd>
-<dt><i>shape</i></dt>
+<dt><i>shape</i> (E5LedType)</dt>
 <dd>
-shape of the LED (E5LedCircular, E5LedRectangular)
+shape of the LED
 </dd>
-<dt><i>rectRatio</i></dt>
+<dt><i>rectRatio</i> (float)</dt>
 <dd>
-ratio width to height, if shape is rectangular (float)
+ratio width to height, if shape is rectangular
 </dd>
 </dl>
 <a NAME="E5Led.__getBestRoundSize" ID="E5Led.__getBestRoundSize"></a>
@@ -410,13 +414,6 @@
 paint event object
 </dd>
 </dl>
-<dl>
-
-<dt>Raises <b>TypeError</b>:</dt>
-<dd>
-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>)
@@ -509,9 +506,9 @@
 </p>
 <dl>
 
-<dt><i>shape</i></dt>
+<dt><i>shape</i> (E5LedType)</dt>
 <dd>
-new LED shape (E5LedCircular, E5LedRectangular)
+new LED shape
 </dd>
 </dl>
 <a NAME="E5Led.shape" ID="E5Led.shape"></a>
@@ -524,7 +521,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-LED shape (E5LedCircular, E5LedRectangular)
+LED shape
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+E5LedType
 </dd>
 </dl>
 <a NAME="E5Led.sizeHint" ID="E5Led.sizeHint"></a>
@@ -549,4 +552,36 @@
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
+<hr />
+<a NAME="E5LedType" ID="E5LedType"></a>
+<h2>E5LedType</h2>
+
+<p>
+    Class defining the LED types.
+</p>
+<h3>Derived from</h3>
+enum.Enum
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>CIRCULAR</td></tr><tr><td>RECTANGULAR</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial