--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricLed.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricLed.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,22 +7,20 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricLed</h1>
-
<p>
Module implementing a LED widget.
</p>
<p>
It was inspired by KLed.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricClickableLed">EricClickableLed</a></td>
<td>Class implementing a clickable LED widget.</td>
@@ -36,19 +34,20 @@
<td>Class defining the LED types.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="EricClickableLed" ID="EricClickableLed"></a>
<h2>EricClickableLed</h2>
-
<p>
Class implementing a clickable LED widget.
</p>
+
<h3>Signals</h3>
<dl>
@@ -66,19 +65,17 @@
<h3>Derived from</h3>
EricLed
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#EricClickableLed.__init__">EricClickableLed</a></td>
<td>Constructor</td>
@@ -88,19 +85,20 @@
<td>Protected method handling mouse release events.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricClickableLed.__init__" ID="EricClickableLed.__init__"></a>
<h4>EricClickableLed (Constructor)</h4>
<b>EricClickableLed</b>(<i>parent=None, color=None, shape=EricLedType.CIRCULAR, rectRatio=1</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -123,10 +121,10 @@
<a NAME="EricClickableLed.mouseReleaseEvent" ID="EricClickableLed.mouseReleaseEvent"></a>
<h4>EricClickableLed.mouseReleaseEvent</h4>
<b>mouseReleaseEvent</b>(<i>evt</i>)
-
<p>
Protected method handling mouse release events.
</p>
+
<dl>
<dt><i>evt</i> (QMouseEvent)</dt>
@@ -139,26 +137,24 @@
<hr />
<a NAME="EricLed" ID="EricLed"></a>
<h2>EricLed</h2>
-
<p>
Class implementing a LED widget.
</p>
+
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#EricLed.__init__">EricLed</a></td>
<td>Constructor</td>
@@ -248,19 +244,20 @@
<td>Public slot to toggle the LED state.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricLed.__init__" ID="EricLed.__init__"></a>
<h4>EricLed (Constructor)</h4>
<b>EricLed</b>(<i>parent=None, color=None, shape=EricLedType.CIRCULAR, rectRatio=1</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -283,10 +280,10 @@
<a NAME="EricLed.__getBestRoundSize" ID="EricLed.__getBestRoundSize"></a>
<h4>EricLed.__getBestRoundSize</h4>
<b>__getBestRoundSize</b>(<i></i>)
-
<p>
Private method to calculate the width of the LED.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -302,24 +299,24 @@
<a NAME="EricLed.__paintRectangular" ID="EricLed.__paintRectangular"></a>
<h4>EricLed.__paintRectangular</h4>
<b>__paintRectangular</b>(<i></i>)
-
<p>
Private method to paint a rectangular raised LED.
</p>
+
<a NAME="EricLed.__paintRound" ID="EricLed.__paintRound"></a>
<h4>EricLed.__paintRound</h4>
<b>__paintRound</b>(<i></i>)
-
<p>
Private method to paint a round raised LED.
</p>
+
<a NAME="EricLed.color" ID="EricLed.color"></a>
<h4>EricLed.color</h4>
<b>color</b>(<i></i>)
-
<p>
Public method to return the LED color.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -335,10 +332,10 @@
<a NAME="EricLed.darkFactor" ID="EricLed.darkFactor"></a>
<h4>EricLed.darkFactor</h4>
<b>darkFactor</b>(<i></i>)
-
<p>
Public method to return the dark factor.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -354,10 +351,10 @@
<a NAME="EricLed.isFramed" ID="EricLed.isFramed"></a>
<h4>EricLed.isFramed</h4>
<b>isFramed</b>(<i></i>)
-
<p>
Public method to return the framed state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -373,10 +370,10 @@
<a NAME="EricLed.isOn" ID="EricLed.isOn"></a>
<h4>EricLed.isOn</h4>
<b>isOn</b>(<i></i>)
-
<p>
Public method to return the LED state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -392,10 +389,10 @@
<a NAME="EricLed.minimumSizeHint" ID="EricLed.minimumSizeHint"></a>
<h4>EricLed.minimumSizeHint</h4>
<b>minimumSizeHint</b>(<i></i>)
-
<p>
Public method to give a hint about our minimum size.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -411,24 +408,24 @@
<a NAME="EricLed.off" ID="EricLed.off"></a>
<h4>EricLed.off</h4>
<b>off</b>(<i></i>)
-
<p>
Public slot to set the LED to off.
</p>
+
<a NAME="EricLed.on" ID="EricLed.on"></a>
<h4>EricLed.on</h4>
<b>on</b>(<i></i>)
-
<p>
Public slot to set the LED to on.
</p>
+
<a NAME="EricLed.paintEvent" ID="EricLed.paintEvent"></a>
<h4>EricLed.paintEvent</h4>
<b>paintEvent</b>(<i>evt</i>)
-
<p>
Protected slot handling the paint event.
</p>
+
<dl>
<dt><i>evt</i> (QPaintEvent)</dt>
@@ -439,10 +436,10 @@
<a NAME="EricLed.ratio" ID="EricLed.ratio"></a>
<h4>EricLed.ratio</h4>
<b>ratio</b>(<i></i>)
-
<p>
Public method to return the LED rectangular ratio [= width / height].
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -458,10 +455,10 @@
<a NAME="EricLed.setColor" ID="EricLed.setColor"></a>
<h4>EricLed.setColor</h4>
<b>setColor</b>(<i>color</i>)
-
<p>
Public method to set the LED color.
</p>
+
<dl>
<dt><i>color</i> (QColor)</dt>
@@ -472,10 +469,10 @@
<a NAME="EricLed.setDarkFactor" ID="EricLed.setDarkFactor"></a>
<h4>EricLed.setDarkFactor</h4>
<b>setDarkFactor</b>(<i>darkfactor</i>)
-
<p>
Public method to set the dark factor.
</p>
+
<dl>
<dt><i>darkfactor</i> (int)</dt>
@@ -486,10 +483,10 @@
<a NAME="EricLed.setFramed" ID="EricLed.setFramed"></a>
<h4>EricLed.setFramed</h4>
<b>setFramed</b>(<i>framed</i>)
-
<p>
Public slot to set the __framedLed attribute.
</p>
+
<dl>
<dt><i>framed</i> (bool)</dt>
@@ -500,10 +497,10 @@
<a NAME="EricLed.setOn" ID="EricLed.setOn"></a>
<h4>EricLed.setOn</h4>
<b>setOn</b>(<i>state</i>)
-
<p>
Public method to set the LED to on.
</p>
+
<dl>
<dt><i>state</i> (bool)</dt>
@@ -514,10 +511,10 @@
<a NAME="EricLed.setRatio" ID="EricLed.setRatio"></a>
<h4>EricLed.setRatio</h4>
<b>setRatio</b>(<i>ratio</i>)
-
<p>
Public method to set the LED rectangular ratio (width / height).
</p>
+
<dl>
<dt><i>ratio</i> (float)</dt>
@@ -528,10 +525,10 @@
<a NAME="EricLed.setShape" ID="EricLed.setShape"></a>
<h4>EricLed.setShape</h4>
<b>setShape</b>(<i>shape</i>)
-
<p>
Public method to set the LED shape.
</p>
+
<dl>
<dt><i>shape</i> (EricLedType)</dt>
@@ -542,10 +539,10 @@
<a NAME="EricLed.shape" ID="EricLed.shape"></a>
<h4>EricLed.shape</h4>
<b>shape</b>(<i></i>)
-
<p>
Public method to return the LED shape.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -561,10 +558,10 @@
<a NAME="EricLed.sizeHint" ID="EricLed.sizeHint"></a>
<h4>EricLed.sizeHint</h4>
<b>sizeHint</b>(<i></i>)
-
<p>
Public method to give a hint about our desired size.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -580,42 +577,43 @@
<a NAME="EricLed.toggle" ID="EricLed.toggle"></a>
<h4>EricLed.toggle</h4>
<b>toggle</b>(<i></i>)
-
<p>
Public slot to toggle the LED state.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricLedType" ID="EricLedType"></a>
<h2>EricLedType</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>
+<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>
-
+<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
+</body></html>
