Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UI.NotificationWidget.html
Documentation/Source/eric5.UI.NotificationWidget.html
- changeset 2190
- abd65b78425e
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 2189:5149cec53130 | 2190:abd65b78425e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.UI.NotificationWidget</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.UI.NotificationWidget</h1> | |
| 24 <p> | |
| 25 Module implementing a Notification widget. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#NotificationWidget">NotificationWidget</a></td> | |
| 35 <td>Class implementing a Notification widget.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="NotificationWidget" ID="NotificationWidget"></a> | |
| 44 <h2>NotificationWidget</h2> | |
| 45 <p> | |
| 46 Class implementing a Notification widget. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QWidget, Ui_NotificationWidget | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Class Methods</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 <table> | |
| 60 <tr> | |
| 61 <td><a href="#NotificationWidget.__init__">NotificationWidget</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#NotificationWidget.mouseMoveEvent">mouseMoveEvent</a></td> | |
| 65 <td>Protected method to handle dragging the window.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#NotificationWidget.mousePressEvent">mousePressEvent</a></td> | |
| 68 <td>Protected method to handle presses of a mouse button.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#NotificationWidget.mouseReleaseEvent">mouseReleaseEvent</a></td> | |
| 71 <td>Protected method to handle releases of a mouse button.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#NotificationWidget.setHeading">setHeading</a></td> | |
| 74 <td>Public method to set the heading for the notification.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#NotificationWidget.setPixmap">setPixmap</a></td> | |
| 77 <td>Public method to set the icon for the notification.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#NotificationWidget.setText">setText</a></td> | |
| 80 <td>Public method to set the text for the notification.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#NotificationWidget.setTimeout">setTimeout</a></td> | |
| 83 <td>Public method to set the timeout for the notification.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#NotificationWidget.show">show</a></td> | |
| 86 <td>Public method to show the notification.</td> | |
| 87 </tr> | |
| 88 </table> | |
| 89 <h3>Static Methods</h3> | |
| 90 <table> | |
| 91 <tr><td>None</td></tr> | |
| 92 </table> | |
| 93 <a NAME="NotificationWidget.__init__" ID="NotificationWidget.__init__"></a> | |
| 94 <h4>NotificationWidget (Constructor)</h4> | |
| 95 <b>NotificationWidget</b>(<i>parent=None, setPosition=False</i>) | |
| 96 <p> | |
| 97 Constructor | |
| 98 </p><dl> | |
| 99 <dt><i>parent</i></dt> | |
| 100 <dd> | |
| 101 reference to the parent widget (QWidget) | |
| 102 </dd><dt><i>setPosition</i></dt> | |
| 103 <dd> | |
| 104 flag indicating to set the display | |
| 105 position interactively (boolean) | |
| 106 </dd> | |
| 107 </dl><a NAME="NotificationWidget.mouseMoveEvent" ID="NotificationWidget.mouseMoveEvent"></a> | |
| 108 <h4>NotificationWidget.mouseMoveEvent</h4> | |
| 109 <b>mouseMoveEvent</b>(<i>evt</i>) | |
| 110 <p> | |
| 111 Protected method to handle dragging the window. | |
| 112 </p><dl> | |
| 113 <dt><i>evt</i></dt> | |
| 114 <dd> | |
| 115 reference to the mouse event (QMouseEvent) | |
| 116 </dd> | |
| 117 </dl><a NAME="NotificationWidget.mousePressEvent" ID="NotificationWidget.mousePressEvent"></a> | |
| 118 <h4>NotificationWidget.mousePressEvent</h4> | |
| 119 <b>mousePressEvent</b>(<i>evt</i>) | |
| 120 <p> | |
| 121 Protected method to handle presses of a mouse button. | |
| 122 </p><dl> | |
| 123 <dt><i>evt</i></dt> | |
| 124 <dd> | |
| 125 reference to the mouse event (QMouseEvent) | |
| 126 </dd> | |
| 127 </dl><a NAME="NotificationWidget.mouseReleaseEvent" ID="NotificationWidget.mouseReleaseEvent"></a> | |
| 128 <h4>NotificationWidget.mouseReleaseEvent</h4> | |
| 129 <b>mouseReleaseEvent</b>(<i>evt</i>) | |
| 130 <p> | |
| 131 Protected method to handle releases of a mouse button. | |
| 132 </p><dl> | |
| 133 <dt><i>evt</i></dt> | |
| 134 <dd> | |
| 135 reference to the mouse event (QMouseEvent) | |
| 136 </dd> | |
| 137 </dl><a NAME="NotificationWidget.setHeading" ID="NotificationWidget.setHeading"></a> | |
| 138 <h4>NotificationWidget.setHeading</h4> | |
| 139 <b>setHeading</b>(<i>heading</i>) | |
| 140 <p> | |
| 141 Public method to set the heading for the notification. | |
| 142 </p><dl> | |
| 143 <dt><i>heading</i></dt> | |
| 144 <dd> | |
| 145 heading to be used (string) | |
| 146 </dd> | |
| 147 </dl><a NAME="NotificationWidget.setPixmap" ID="NotificationWidget.setPixmap"></a> | |
| 148 <h4>NotificationWidget.setPixmap</h4> | |
| 149 <b>setPixmap</b>(<i>icon</i>) | |
| 150 <p> | |
| 151 Public method to set the icon for the notification. | |
| 152 </p><dl> | |
| 153 <dt><i>icon</i></dt> | |
| 154 <dd> | |
| 155 icon to be used (QPixmap) | |
| 156 </dd> | |
| 157 </dl><a NAME="NotificationWidget.setText" ID="NotificationWidget.setText"></a> | |
| 158 <h4>NotificationWidget.setText</h4> | |
| 159 <b>setText</b>(<i>text</i>) | |
| 160 <p> | |
| 161 Public method to set the text for the notification. | |
| 162 </p><dl> | |
| 163 <dt><i>text</i></dt> | |
| 164 <dd> | |
| 165 text to be used (string) | |
| 166 </dd> | |
| 167 </dl><a NAME="NotificationWidget.setTimeout" ID="NotificationWidget.setTimeout"></a> | |
| 168 <h4>NotificationWidget.setTimeout</h4> | |
| 169 <b>setTimeout</b>(<i>timeout</i>) | |
| 170 <p> | |
| 171 Public method to set the timeout for the notification. | |
| 172 </p><dl> | |
| 173 <dt><i>timeout</i></dt> | |
| 174 <dd> | |
| 175 timeout to be used in seconds (integer) | |
| 176 </dd> | |
| 177 </dl><a NAME="NotificationWidget.show" ID="NotificationWidget.show"></a> | |
| 178 <h4>NotificationWidget.show</h4> | |
| 179 <b>show</b>(<i></i>) | |
| 180 <p> | |
| 181 Public method to show the notification. | |
| 182 </p> | |
| 183 <div align="right"><a href="#top">Up</a></div> | |
| 184 <hr /> | |
| 185 </body></html> |
