Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.UI.NotificationWidget.html
eric6/Documentation/Source/eric6.UI.NotificationWidget.html
- changeset 7959
- 44e15eda6506
- parent 7953
- 68c12f4cb876
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7958:a70ebfad3d0e | 7959:44e15eda6506 |
|---|---|
| 37 <tr> | 37 <tr> |
| 38 <td><a href="#NotificationFrame">NotificationFrame</a></td> | 38 <td><a href="#NotificationFrame">NotificationFrame</a></td> |
| 39 <td>Class implementing a Notification widget.</td> | 39 <td>Class implementing a Notification widget.</td> |
| 40 </tr> | 40 </tr> |
| 41 <tr> | 41 <tr> |
| 42 <td><a href="#NotificationTypes">NotificationTypes</a></td> | |
| 43 <td>Class implementing the notification types.</td> | |
| 44 </tr> | |
| 45 <tr> | |
| 42 <td><a href="#NotificationWidget">NotificationWidget</a></td> | 46 <td><a href="#NotificationWidget">NotificationWidget</a></td> |
| 43 <td>Class implementing a Notification list widget.</td> | 47 <td>Class implementing a Notification list widget.</td> |
| 44 </tr> | 48 </tr> |
| 45 </table> | 49 </table> |
| 46 <h3>Functions</h3> | 50 <h3>Functions</h3> |
| 59 <h3>Derived from</h3> | 63 <h3>Derived from</h3> |
| 60 QFrame, Ui_NotificationFrame | 64 QFrame, Ui_NotificationFrame |
| 61 <h3>Class Attributes</h3> | 65 <h3>Class Attributes</h3> |
| 62 | 66 |
| 63 <table> | 67 <table> |
| 64 <tr><td>None</td></tr> | 68 <tr><td>NotificationStyleSheetTemplate</td></tr> |
| 65 </table> | 69 </table> |
| 66 <h3>Class Methods</h3> | 70 <h3>Class Methods</h3> |
| 67 | 71 |
| 68 <table> | 72 <table> |
| 69 <tr><td>None</td></tr> | 73 |
| 74 <tr> | |
| 75 <td><a href="#NotificationFrame.getIcon">getIcon</a></td> | |
| 76 <td>Class method to get the icon for a specific notification kind.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#NotificationFrame.getStyleSheet">getStyleSheet</a></td> | |
| 80 <td>Class method to get a style sheet for specific notification kind.</td> | |
| 81 </tr> | |
| 70 </table> | 82 </table> |
| 71 <h3>Methods</h3> | 83 <h3>Methods</h3> |
| 72 | 84 |
| 73 <table> | 85 <table> |
| 74 | 86 |
| 81 | 93 |
| 82 <table> | 94 <table> |
| 83 <tr><td>None</td></tr> | 95 <tr><td>None</td></tr> |
| 84 </table> | 96 </table> |
| 85 | 97 |
| 98 <a NAME="NotificationFrame.getIcon" ID="NotificationFrame.getIcon"></a> | |
| 99 <h4>NotificationFrame.getIcon (class method)</h4> | |
| 100 <b>getIcon</b>(<i>kind</i>) | |
| 101 | |
| 102 <p> | |
| 103 Class method to get the icon for a specific notification kind. | |
| 104 </p> | |
| 105 <dl> | |
| 106 | |
| 107 <dt><i>kind</i> (NotificationTypes)</dt> | |
| 108 <dd> | |
| 109 notification kind | |
| 110 </dd> | |
| 111 </dl> | |
| 112 <dl> | |
| 113 <dt>Returns:</dt> | |
| 114 <dd> | |
| 115 icon for the notification kind | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <dl> | |
| 119 <dt>Return Type:</dt> | |
| 120 <dd> | |
| 121 QPixmap | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <a NAME="NotificationFrame.getStyleSheet" ID="NotificationFrame.getStyleSheet"></a> | |
| 125 <h4>NotificationFrame.getStyleSheet (class method)</h4> | |
| 126 <b>getStyleSheet</b>(<i>kind</i>) | |
| 127 | |
| 128 <p> | |
| 129 Class method to get a style sheet for specific notification kind. | |
| 130 </p> | |
| 131 <dl> | |
| 132 | |
| 133 <dt><i>kind</i> (NotificationTypes)</dt> | |
| 134 <dd> | |
| 135 notification kind | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <dl> | |
| 139 <dt>Returns:</dt> | |
| 140 <dd> | |
| 141 string containing the style sheet for the notification kind | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <dl> | |
| 145 <dt>Return Type:</dt> | |
| 146 <dd> | |
| 147 str | |
| 148 </dd> | |
| 149 </dl> | |
| 86 <a NAME="NotificationFrame.__init__" ID="NotificationFrame.__init__"></a> | 150 <a NAME="NotificationFrame.__init__" ID="NotificationFrame.__init__"></a> |
| 87 <h4>NotificationFrame (Constructor)</h4> | 151 <h4>NotificationFrame (Constructor)</h4> |
| 88 <b>NotificationFrame</b>(<i>icon, heading, text, parent=None</i>) | 152 <b>NotificationFrame</b>(<i>icon, heading, text, kind=NotificationTypes.Information, parent=None</i>) |
| 89 | 153 |
| 90 <p> | 154 <p> |
| 91 Constructor | 155 Constructor |
| 92 </p> | 156 </p> |
| 93 <dl> | 157 <dl> |
| 102 </dd> | 166 </dd> |
| 103 <dt><i>text</i> (str)</dt> | 167 <dt><i>text</i> (str)</dt> |
| 104 <dd> | 168 <dd> |
| 105 text to be used | 169 text to be used |
| 106 </dd> | 170 </dd> |
| 171 <dt><i>kind</i> (NotificationTypes)</dt> | |
| 172 <dd> | |
| 173 kind of notification to be shown | |
| 174 </dd> | |
| 107 <dt><i>parent</i> (QWidget)</dt> | 175 <dt><i>parent</i> (QWidget)</dt> |
| 108 <dd> | 176 <dd> |
| 109 reference to the parent widget | 177 reference to the parent widget |
| 110 </dd> | 178 </dd> |
| 111 </dl> | 179 </dl> |
| 180 <div align="right"><a href="#top">Up</a></div> | |
| 181 <hr /> | |
| 182 <hr /> | |
| 183 <a NAME="NotificationTypes" ID="NotificationTypes"></a> | |
| 184 <h2>NotificationTypes</h2> | |
| 185 | |
| 186 <p> | |
| 187 Class implementing the notification types. | |
| 188 </p> | |
| 189 <h3>Derived from</h3> | |
| 190 Enum | |
| 191 <h3>Class Attributes</h3> | |
| 192 | |
| 193 <table> | |
| 194 <tr><td>Critical</td></tr><tr><td>Information</td></tr><tr><td>Other</td></tr><tr><td>Warning</td></tr> | |
| 195 </table> | |
| 196 <h3>Class Methods</h3> | |
| 197 | |
| 198 <table> | |
| 199 <tr><td>None</td></tr> | |
| 200 </table> | |
| 201 <h3>Methods</h3> | |
| 202 | |
| 203 <table> | |
| 204 <tr><td>None</td></tr> | |
| 205 </table> | |
| 206 <h3>Static Methods</h3> | |
| 207 | |
| 208 <table> | |
| 209 <tr><td>None</td></tr> | |
| 210 </table> | |
| 211 | |
| 112 <div align="right"><a href="#top">Up</a></div> | 212 <div align="right"><a href="#top">Up</a></div> |
| 113 <hr /> | 213 <hr /> |
| 114 <hr /> | 214 <hr /> |
| 115 <a NAME="NotificationWidget" ID="NotificationWidget"></a> | 215 <a NAME="NotificationWidget" ID="NotificationWidget"></a> |
| 116 <h2>NotificationWidget</h2> | 216 <h2>NotificationWidget</h2> |
| 251 reference to the mouse event (QMouseEvent) | 351 reference to the mouse event (QMouseEvent) |
| 252 </dd> | 352 </dd> |
| 253 </dl> | 353 </dl> |
| 254 <a NAME="NotificationWidget.showNotification" ID="NotificationWidget.showNotification"></a> | 354 <a NAME="NotificationWidget.showNotification" ID="NotificationWidget.showNotification"></a> |
| 255 <h4>NotificationWidget.showNotification</h4> | 355 <h4>NotificationWidget.showNotification</h4> |
| 256 <b>showNotification</b>(<i>icon, heading, text, timeout=0</i>) | 356 <b>showNotification</b>(<i>icon, heading, text, kind=NotificationTypes.Information, timeout=0</i>) |
| 257 | 357 |
| 258 <p> | 358 <p> |
| 259 Public method to show a notification. | 359 Public method to show a notification. |
| 260 </p> | 360 </p> |
| 261 <dl> | 361 <dl> |
| 270 </dd> | 370 </dd> |
| 271 <dt><i>text</i> (str)</dt> | 371 <dt><i>text</i> (str)</dt> |
| 272 <dd> | 372 <dd> |
| 273 text to be used | 373 text to be used |
| 274 </dd> | 374 </dd> |
| 275 <dt><i>timeout</i></dt> | 375 <dt><i>kind</i> (NotificationTypes)</dt> |
| 376 <dd> | |
| 377 kind of notification to be shown | |
| 378 </dd> | |
| 379 <dt><i>timeout</i> (int)</dt> | |
| 276 <dd> | 380 <dd> |
| 277 timeout in seconds after which the notification is | 381 timeout in seconds after which the notification is |
| 278 to be removed (0 = do not remove until it is clicked on) | 382 to be removed (0 = do not remove until it is clicked on) |
| 279 </dd> | 383 </dd> |
| 280 </dl> | 384 </dl> |
