Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.UI.NotificationWidget.html

eric6/Documentation/Source/eric6.UI.NotificationWidget.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7953
68c12f4cb876
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.UI.NotificationWidget</h1> 23 <h1>eric6.UI.NotificationWidget</h1>
24
23 <p> 25 <p>
24 Module implementing a Notification widget. 26 Module implementing a Notification widget.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#NotificationWidget">NotificationWidget</a></td> 38 <td><a href="#NotificationWidget">NotificationWidget</a></td>
34 <td>Class implementing a Notification widget.</td> 39 <td>Class implementing a Notification widget.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="NotificationWidget" ID="NotificationWidget"></a> 49 <a NAME="NotificationWidget" ID="NotificationWidget"></a>
43 <h2>NotificationWidget</h2> 50 <h2>NotificationWidget</h2>
51
44 <p> 52 <p>
45 Class implementing a Notification widget. 53 Class implementing a Notification widget.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QWidget, Ui_NotificationWidget 56 QWidget, Ui_NotificationWidget
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#NotificationWidget.__init__">NotificationWidget</a></td> 72 <td><a href="#NotificationWidget.__init__">NotificationWidget</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#NotificationWidget.mouseMoveEvent">mouseMoveEvent</a></td> 76 <td><a href="#NotificationWidget.mouseMoveEvent">mouseMoveEvent</a></td>
64 <td>Protected method to handle dragging the window.</td> 77 <td>Protected method to handle dragging the window.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#NotificationWidget.mousePressEvent">mousePressEvent</a></td> 80 <td><a href="#NotificationWidget.mousePressEvent">mousePressEvent</a></td>
67 <td>Protected method to handle presses of a mouse button.</td> 81 <td>Protected method to handle presses of a mouse button.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#NotificationWidget.mouseReleaseEvent">mouseReleaseEvent</a></td> 84 <td><a href="#NotificationWidget.mouseReleaseEvent">mouseReleaseEvent</a></td>
70 <td>Protected method to handle releases of a mouse button.</td> 85 <td>Protected method to handle releases of a mouse button.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#NotificationWidget.setHeading">setHeading</a></td> 88 <td><a href="#NotificationWidget.setHeading">setHeading</a></td>
73 <td>Public method to set the heading for the notification.</td> 89 <td>Public method to set the heading for the notification.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#NotificationWidget.setPixmap">setPixmap</a></td> 92 <td><a href="#NotificationWidget.setPixmap">setPixmap</a></td>
76 <td>Public method to set the icon for the notification.</td> 93 <td>Public method to set the icon for the notification.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#NotificationWidget.setText">setText</a></td> 96 <td><a href="#NotificationWidget.setText">setText</a></td>
79 <td>Public method to set the text for the notification.</td> 97 <td>Public method to set the text for the notification.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#NotificationWidget.setTimeout">setTimeout</a></td> 100 <td><a href="#NotificationWidget.setTimeout">setTimeout</a></td>
82 <td>Public method to set the timeout for the notification.</td> 101 <td>Public method to set the timeout for the notification.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#NotificationWidget.show">show</a></td> 104 <td><a href="#NotificationWidget.show">show</a></td>
85 <td>Public method to show the notification.</td> 105 <td>Public method to show the notification.</td>
86 </tr> 106 </tr>
87 </table> 107 </table>
88 <h3>Static Methods</h3> 108 <h3>Static Methods</h3>
89 <table> 109
90 <tr><td>None</td></tr> 110 <table>
91 </table> 111 <tr><td>None</td></tr>
112 </table>
113
92 <a NAME="NotificationWidget.__init__" ID="NotificationWidget.__init__"></a> 114 <a NAME="NotificationWidget.__init__" ID="NotificationWidget.__init__"></a>
93 <h4>NotificationWidget (Constructor)</h4> 115 <h4>NotificationWidget (Constructor)</h4>
94 <b>NotificationWidget</b>(<i>parent=None, setPosition=False</i>) 116 <b>NotificationWidget</b>(<i>parent=None, setPosition=False</i>)
117
95 <p> 118 <p>
96 Constructor 119 Constructor
97 </p><dl> 120 </p>
121 <dl>
122
98 <dt><i>parent</i></dt> 123 <dt><i>parent</i></dt>
99 <dd> 124 <dd>
100 reference to the parent widget (QWidget) 125 reference to the parent widget (QWidget)
101 </dd><dt><i>setPosition</i></dt> 126 </dd>
127 <dt><i>setPosition</i></dt>
102 <dd> 128 <dd>
103 flag indicating to set the display 129 flag indicating to set the display
104 position interactively (boolean) 130 position interactively (boolean)
105 </dd> 131 </dd>
106 </dl><a NAME="NotificationWidget.mouseMoveEvent" ID="NotificationWidget.mouseMoveEvent"></a> 132 </dl>
133 <a NAME="NotificationWidget.mouseMoveEvent" ID="NotificationWidget.mouseMoveEvent"></a>
107 <h4>NotificationWidget.mouseMoveEvent</h4> 134 <h4>NotificationWidget.mouseMoveEvent</h4>
108 <b>mouseMoveEvent</b>(<i>evt</i>) 135 <b>mouseMoveEvent</b>(<i>evt</i>)
136
109 <p> 137 <p>
110 Protected method to handle dragging the window. 138 Protected method to handle dragging the window.
111 </p><dl> 139 </p>
140 <dl>
141
112 <dt><i>evt</i></dt> 142 <dt><i>evt</i></dt>
113 <dd> 143 <dd>
114 reference to the mouse event (QMouseEvent) 144 reference to the mouse event (QMouseEvent)
115 </dd> 145 </dd>
116 </dl><a NAME="NotificationWidget.mousePressEvent" ID="NotificationWidget.mousePressEvent"></a> 146 </dl>
147 <a NAME="NotificationWidget.mousePressEvent" ID="NotificationWidget.mousePressEvent"></a>
117 <h4>NotificationWidget.mousePressEvent</h4> 148 <h4>NotificationWidget.mousePressEvent</h4>
118 <b>mousePressEvent</b>(<i>evt</i>) 149 <b>mousePressEvent</b>(<i>evt</i>)
150
119 <p> 151 <p>
120 Protected method to handle presses of a mouse button. 152 Protected method to handle presses of a mouse button.
121 </p><dl> 153 </p>
154 <dl>
155
122 <dt><i>evt</i></dt> 156 <dt><i>evt</i></dt>
123 <dd> 157 <dd>
124 reference to the mouse event (QMouseEvent) 158 reference to the mouse event (QMouseEvent)
125 </dd> 159 </dd>
126 </dl><a NAME="NotificationWidget.mouseReleaseEvent" ID="NotificationWidget.mouseReleaseEvent"></a> 160 </dl>
161 <a NAME="NotificationWidget.mouseReleaseEvent" ID="NotificationWidget.mouseReleaseEvent"></a>
127 <h4>NotificationWidget.mouseReleaseEvent</h4> 162 <h4>NotificationWidget.mouseReleaseEvent</h4>
128 <b>mouseReleaseEvent</b>(<i>evt</i>) 163 <b>mouseReleaseEvent</b>(<i>evt</i>)
164
129 <p> 165 <p>
130 Protected method to handle releases of a mouse button. 166 Protected method to handle releases of a mouse button.
131 </p><dl> 167 </p>
168 <dl>
169
132 <dt><i>evt</i></dt> 170 <dt><i>evt</i></dt>
133 <dd> 171 <dd>
134 reference to the mouse event (QMouseEvent) 172 reference to the mouse event (QMouseEvent)
135 </dd> 173 </dd>
136 </dl><a NAME="NotificationWidget.setHeading" ID="NotificationWidget.setHeading"></a> 174 </dl>
175 <a NAME="NotificationWidget.setHeading" ID="NotificationWidget.setHeading"></a>
137 <h4>NotificationWidget.setHeading</h4> 176 <h4>NotificationWidget.setHeading</h4>
138 <b>setHeading</b>(<i>heading</i>) 177 <b>setHeading</b>(<i>heading</i>)
178
139 <p> 179 <p>
140 Public method to set the heading for the notification. 180 Public method to set the heading for the notification.
141 </p><dl> 181 </p>
182 <dl>
183
142 <dt><i>heading</i></dt> 184 <dt><i>heading</i></dt>
143 <dd> 185 <dd>
144 heading to be used (string) 186 heading to be used (string)
145 </dd> 187 </dd>
146 </dl><a NAME="NotificationWidget.setPixmap" ID="NotificationWidget.setPixmap"></a> 188 </dl>
189 <a NAME="NotificationWidget.setPixmap" ID="NotificationWidget.setPixmap"></a>
147 <h4>NotificationWidget.setPixmap</h4> 190 <h4>NotificationWidget.setPixmap</h4>
148 <b>setPixmap</b>(<i>icon</i>) 191 <b>setPixmap</b>(<i>icon</i>)
192
149 <p> 193 <p>
150 Public method to set the icon for the notification. 194 Public method to set the icon for the notification.
151 </p><dl> 195 </p>
196 <dl>
197
152 <dt><i>icon</i></dt> 198 <dt><i>icon</i></dt>
153 <dd> 199 <dd>
154 icon to be used (QPixmap) 200 icon to be used (QPixmap)
155 </dd> 201 </dd>
156 </dl><a NAME="NotificationWidget.setText" ID="NotificationWidget.setText"></a> 202 </dl>
203 <a NAME="NotificationWidget.setText" ID="NotificationWidget.setText"></a>
157 <h4>NotificationWidget.setText</h4> 204 <h4>NotificationWidget.setText</h4>
158 <b>setText</b>(<i>text</i>) 205 <b>setText</b>(<i>text</i>)
206
159 <p> 207 <p>
160 Public method to set the text for the notification. 208 Public method to set the text for the notification.
161 </p><dl> 209 </p>
210 <dl>
211
162 <dt><i>text</i></dt> 212 <dt><i>text</i></dt>
163 <dd> 213 <dd>
164 text to be used (string) 214 text to be used (string)
165 </dd> 215 </dd>
166 </dl><a NAME="NotificationWidget.setTimeout" ID="NotificationWidget.setTimeout"></a> 216 </dl>
217 <a NAME="NotificationWidget.setTimeout" ID="NotificationWidget.setTimeout"></a>
167 <h4>NotificationWidget.setTimeout</h4> 218 <h4>NotificationWidget.setTimeout</h4>
168 <b>setTimeout</b>(<i>timeout</i>) 219 <b>setTimeout</b>(<i>timeout</i>)
220
169 <p> 221 <p>
170 Public method to set the timeout for the notification. 222 Public method to set the timeout for the notification.
171 </p><dl> 223 </p>
224 <dl>
225
172 <dt><i>timeout</i> (int)</dt> 226 <dt><i>timeout</i> (int)</dt>
173 <dd> 227 <dd>
174 timeout to be used in seconds (0 = indefinitely) 228 timeout to be used in seconds (0 = indefinitely)
175 </dd> 229 </dd>
176 </dl><a NAME="NotificationWidget.show" ID="NotificationWidget.show"></a> 230 </dl>
231 <a NAME="NotificationWidget.show" ID="NotificationWidget.show"></a>
177 <h4>NotificationWidget.show</h4> 232 <h4>NotificationWidget.show</h4>
178 <b>show</b>(<i></i>) 233 <b>show</b>(<i></i>)
234
179 <p> 235 <p>
180 Public method to show the notification. 236 Public method to show the notification.
181 </p> 237 </p>
182 <div align="right"><a href="#top">Up</a></div> 238 <div align="right"><a href="#top">Up</a></div>
183 <hr /> 239 <hr />

Mercurial Repository: eric

eric ide

mercurial