--- a/eric6/Documentation/Source/eric6.UI.NotificationWidget.html Tue Jan 05 15:14:40 2021 +0100
+++ b/eric6/Documentation/Source/eric6.UI.NotificationWidget.html Tue Jan 05 18:28:31 2021 +0100
@@ -39,6 +39,10 @@
<td>Class implementing a Notification widget.</td>
</tr>
<tr>
+<td><a href="#NotificationTypes">NotificationTypes</a></td>
+<td>Class implementing the notification types.</td>
+</tr>
+<tr>
<td><a href="#NotificationWidget">NotificationWidget</a></td>
<td>Class implementing a Notification list widget.</td>
</tr>
@@ -61,12 +65,20 @@
<h3>Class Attributes</h3>
<table>
-<tr><td>None</td></tr>
+<tr><td>NotificationStyleSheetTemplate</td></tr>
</table>
<h3>Class Methods</h3>
<table>
-<tr><td>None</td></tr>
+
+<tr>
+<td><a href="#NotificationFrame.getIcon">getIcon</a></td>
+<td>Class method to get the icon for a specific notification kind.</td>
+</tr>
+<tr>
+<td><a href="#NotificationFrame.getStyleSheet">getStyleSheet</a></td>
+<td>Class method to get a style sheet for specific notification kind.</td>
+</tr>
</table>
<h3>Methods</h3>
@@ -83,9 +95,61 @@
<tr><td>None</td></tr>
</table>
+<a NAME="NotificationFrame.getIcon" ID="NotificationFrame.getIcon"></a>
+<h4>NotificationFrame.getIcon (class method)</h4>
+<b>getIcon</b>(<i>kind</i>)
+
+<p>
+ Class method to get the icon for a specific notification kind.
+</p>
+<dl>
+
+<dt><i>kind</i> (NotificationTypes)</dt>
+<dd>
+notification kind
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+icon for the notification kind
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QPixmap
+</dd>
+</dl>
+<a NAME="NotificationFrame.getStyleSheet" ID="NotificationFrame.getStyleSheet"></a>
+<h4>NotificationFrame.getStyleSheet (class method)</h4>
+<b>getStyleSheet</b>(<i>kind</i>)
+
+<p>
+ Class method to get a style sheet for specific notification kind.
+</p>
+<dl>
+
+<dt><i>kind</i> (NotificationTypes)</dt>
+<dd>
+notification kind
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+string containing the style sheet for the notification kind
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
<a NAME="NotificationFrame.__init__" ID="NotificationFrame.__init__"></a>
<h4>NotificationFrame (Constructor)</h4>
-<b>NotificationFrame</b>(<i>icon, heading, text, parent=None</i>)
+<b>NotificationFrame</b>(<i>icon, heading, text, kind=NotificationTypes.Information, parent=None</i>)
<p>
Constructor
@@ -104,6 +168,10 @@
<dd>
text to be used
</dd>
+<dt><i>kind</i> (NotificationTypes)</dt>
+<dd>
+kind of notification to be shown
+</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
@@ -112,6 +180,38 @@
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
+<a NAME="NotificationTypes" ID="NotificationTypes"></a>
+<h2>NotificationTypes</h2>
+
+<p>
+ Class implementing the notification types.
+</p>
+<h3>Derived from</h3>
+Enum
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>Critical</td></tr><tr><td>Information</td></tr><tr><td>Other</td></tr><tr><td>Warning</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 />
+<hr />
<a NAME="NotificationWidget" ID="NotificationWidget"></a>
<h2>NotificationWidget</h2>
@@ -253,7 +353,7 @@
</dl>
<a NAME="NotificationWidget.showNotification" ID="NotificationWidget.showNotification"></a>
<h4>NotificationWidget.showNotification</h4>
-<b>showNotification</b>(<i>icon, heading, text, timeout=0</i>)
+<b>showNotification</b>(<i>icon, heading, text, kind=NotificationTypes.Information, timeout=0</i>)
<p>
Public method to show a notification.
@@ -272,7 +372,11 @@
<dd>
text to be used
</dd>
-<dt><i>timeout</i></dt>
+<dt><i>kind</i> (NotificationTypes)</dt>
+<dd>
+kind of notification to be shown
+</dd>
+<dt><i>timeout</i> (int)</dt>
<dd>
timeout in seconds after which the notification is
to be removed (0 = do not remove until it is clicked on)
