--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.UI.NotificationWidget.html Sun Nov 04 16:55:20 2012 +0100
@@ -0,0 +1,185 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.UI.NotificationWidget</title>
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.UI.NotificationWidget</h1>
+<p>
+Module implementing a Notification widget.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#NotificationWidget">NotificationWidget</a></td>
+<td>Class implementing a Notification widget.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="NotificationWidget" ID="NotificationWidget"></a>
+<h2>NotificationWidget</h2>
+<p>
+ Class implementing a Notification widget.
+</p>
+<h3>Derived from</h3>
+QWidget, Ui_NotificationWidget
+<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="#NotificationWidget.__init__">NotificationWidget</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#NotificationWidget.mouseMoveEvent">mouseMoveEvent</a></td>
+<td>Protected method to handle dragging the window.</td>
+</tr><tr>
+<td><a href="#NotificationWidget.mousePressEvent">mousePressEvent</a></td>
+<td>Protected method to handle presses of a mouse button.</td>
+</tr><tr>
+<td><a href="#NotificationWidget.mouseReleaseEvent">mouseReleaseEvent</a></td>
+<td>Protected method to handle releases of a mouse button.</td>
+</tr><tr>
+<td><a href="#NotificationWidget.setHeading">setHeading</a></td>
+<td>Public method to set the heading for the notification.</td>
+</tr><tr>
+<td><a href="#NotificationWidget.setPixmap">setPixmap</a></td>
+<td>Public method to set the icon for the notification.</td>
+</tr><tr>
+<td><a href="#NotificationWidget.setText">setText</a></td>
+<td>Public method to set the text for the notification.</td>
+</tr><tr>
+<td><a href="#NotificationWidget.setTimeout">setTimeout</a></td>
+<td>Public method to set the timeout for the notification.</td>
+</tr><tr>
+<td><a href="#NotificationWidget.show">show</a></td>
+<td>Public method to show the notification.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="NotificationWidget.__init__" ID="NotificationWidget.__init__"></a>
+<h4>NotificationWidget (Constructor)</h4>
+<b>NotificationWidget</b>(<i>parent=None, setPosition=False</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd><dt><i>setPosition</i></dt>
+<dd>
+flag indicating to set the display
+ position interactively (boolean)
+</dd>
+</dl><a NAME="NotificationWidget.mouseMoveEvent" ID="NotificationWidget.mouseMoveEvent"></a>
+<h4>NotificationWidget.mouseMoveEvent</h4>
+<b>mouseMoveEvent</b>(<i>evt</i>)
+<p>
+ Protected method to handle dragging the window.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+reference to the mouse event (QMouseEvent)
+</dd>
+</dl><a NAME="NotificationWidget.mousePressEvent" ID="NotificationWidget.mousePressEvent"></a>
+<h4>NotificationWidget.mousePressEvent</h4>
+<b>mousePressEvent</b>(<i>evt</i>)
+<p>
+ Protected method to handle presses of a mouse button.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+reference to the mouse event (QMouseEvent)
+</dd>
+</dl><a NAME="NotificationWidget.mouseReleaseEvent" ID="NotificationWidget.mouseReleaseEvent"></a>
+<h4>NotificationWidget.mouseReleaseEvent</h4>
+<b>mouseReleaseEvent</b>(<i>evt</i>)
+<p>
+ Protected method to handle releases of a mouse button.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+reference to the mouse event (QMouseEvent)
+</dd>
+</dl><a NAME="NotificationWidget.setHeading" ID="NotificationWidget.setHeading"></a>
+<h4>NotificationWidget.setHeading</h4>
+<b>setHeading</b>(<i>heading</i>)
+<p>
+ Public method to set the heading for the notification.
+</p><dl>
+<dt><i>heading</i></dt>
+<dd>
+heading to be used (string)
+</dd>
+</dl><a NAME="NotificationWidget.setPixmap" ID="NotificationWidget.setPixmap"></a>
+<h4>NotificationWidget.setPixmap</h4>
+<b>setPixmap</b>(<i>icon</i>)
+<p>
+ Public method to set the icon for the notification.
+</p><dl>
+<dt><i>icon</i></dt>
+<dd>
+icon to be used (QPixmap)
+</dd>
+</dl><a NAME="NotificationWidget.setText" ID="NotificationWidget.setText"></a>
+<h4>NotificationWidget.setText</h4>
+<b>setText</b>(<i>text</i>)
+<p>
+ Public method to set the text for the notification.
+</p><dl>
+<dt><i>text</i></dt>
+<dd>
+text to be used (string)
+</dd>
+</dl><a NAME="NotificationWidget.setTimeout" ID="NotificationWidget.setTimeout"></a>
+<h4>NotificationWidget.setTimeout</h4>
+<b>setTimeout</b>(<i>timeout</i>)
+<p>
+ Public method to set the timeout for the notification.
+</p><dl>
+<dt><i>timeout</i></dt>
+<dd>
+timeout to be used in seconds (integer)
+</dd>
+</dl><a NAME="NotificationWidget.show" ID="NotificationWidget.show"></a>
+<h4>NotificationWidget.show</h4>
+<b>show</b>(<i></i>)
+<p>
+ Public method to show the notification.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
