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