forked from open-cogsci/QNotifications
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.html
More file actions
595 lines (475 loc) · 28.4 KB
/
api.html
File metadata and controls
595 lines (475 loc) · 28.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API Reference — QNotifications 1.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="QNotifications 1.1.0 documentation" href="index.html"/>
<link rel="prev" title="Manual" href="main.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> QNotifications
</a>
<div class="version">
1.1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="main.html">Manual</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-QNotifications.QNotificationArea">QNotificationArea</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-QNotifications.QNotification">QNotification</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">QNotifications</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>API Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-QNotifications.QNotificationArea">
<span id="qnotificationarea"></span><h2>QNotificationArea<a class="headerlink" href="#module-QNotifications.QNotificationArea" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="QNotifications.QNotificationArea.QNotificationArea">
<em class="property">class </em><code class="descclassname">QNotifications.QNotificationArea.</code><code class="descname">QNotificationArea</code><span class="sig-paren">(</span><em>targetWidget</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotificationArea.html#QNotificationArea"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotificationArea.QNotificationArea" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">PyQt5.QtWidgets.QWidget</span></code></p>
<p>Notification area to show notifications in. Will be projected on top of
another QWidget which should be passed as an argument to this class.</p>
<p class="rubric">Methods</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#QNotifications.QNotificationArea.QNotificationArea.display" title="QNotifications.QNotificationArea.QNotificationArea.display"><code class="xref py py-obj docutils literal"><span class="pre">display</span></code></a>(message, category[, timeout, buttontext])</td>
<td>Displays a notification.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#QNotifications.QNotificationArea.QNotificationArea.paintEvent" title="QNotifications.QNotificationArea.QNotificationArea.paintEvent"><code class="xref py py-obj docutils literal"><span class="pre">paintEvent</span></code></a>(pe)</td>
<td>Redefinition of paintEvent.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#QNotifications.QNotificationArea.QNotificationArea.remove" title="QNotifications.QNotificationArea.QNotificationArea.remove"><code class="xref py py-obj docutils literal"><span class="pre">remove</span></code></a>([notification])</td>
<td>Removes a notification.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#QNotifications.QNotificationArea.QNotificationArea.resizeEvent" title="QNotifications.QNotificationArea.QNotificationArea.resizeEvent"><code class="xref py py-obj docutils literal"><span class="pre">resizeEvent</span></code></a>(event)</td>
<td>Internal QT function (do not call directly).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#QNotifications.QNotificationArea.QNotificationArea.setEntryEffect" title="QNotifications.QNotificationArea.QNotificationArea.setEntryEffect"><code class="xref py py-obj docutils literal"><span class="pre">setEntryEffect</span></code></a>(effect[, duration])</td>
<td>Sets the effect with which the notifications are to appear.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#QNotifications.QNotificationArea.QNotificationArea.setExitEffect" title="QNotifications.QNotificationArea.QNotificationArea.setExitEffect"><code class="xref py py-obj docutils literal"><span class="pre">setExitEffect</span></code></a>(effect[, duration])</td>
<td>Sets the effect with which the notifications are to disappear.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="QNotifications.QNotificationArea.QNotificationArea.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>targetWidget</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotificationArea.html#QNotificationArea.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotificationArea.QNotificationArea.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Constructor</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>targetWidget</strong> : QtWidgets.QWidget</p>
<blockquote>
<div><p>The widget to project the notifications on</p>
</div></blockquote>
<p><strong>useGlobalCSS</strong> : bool (default: False)</p>
<blockquote>
<div><p>Flag which indicates whether global style sheets should be used
(which have been set at app-level). If False, the default style sheets
stored at self.default_notification_styles will be loaded.</p>
</div></blockquote>
<p><strong>useQueue</strong> : bool (default: True)</p>
<blockquote>
<div><p>Indicates whether a message queue should be implemented. This will only
show <em>maxMessages</em> at the same time and will put all other messages in a
queue. Once a message disappears, the next one in the queue will be shown
(up to maxMessages at the same time)</p>
</div></blockquote>
<p><strong>maxMessages</strong> : int (default: 2)</p>
<blockquote>
<div><p>The number of messages to display at the same time.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>TypeError</strong> : if targetWidget is not an object that inherits QWidget</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotificationArea.QNotificationArea.display">
<code class="descname">display</code><span class="sig-paren">(</span><em>message</em>, <em>category</em>, <em>timeout=5000</em>, <em>buttontext=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotificationArea.html#QNotificationArea.display"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotificationArea.QNotificationArea.display" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays a notification.</p>
<p>If a queue is used, then the notification will only be shown directly
if the number of notifications shown is smaller than maxMessages.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>message</strong> : str</p>
<blockquote>
<div><p>The message to display</p>
</div></blockquote>
<p><strong>category</strong> : {‘primary’, ‘success’, ‘info’, ‘warning’, ‘danger’}</p>
<blockquote>
<div><p>The type of notification that should be shown. Adheres to bootstrap
standards which are primary, success, info, warning and danger</p>
</div></blockquote>
<p><strong>timeout</strong> : int, optional</p>
<blockquote>
<div><p>The duration for which the notification should be shown. If None then
the notification will be shown indefinitely</p>
</div></blockquote>
<p><strong>buttontext</strong> : str, optional</p>
<blockquote>
<div><p>The text to display on the closing button. If not provided a cross
will be shown.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>ValueError</strong></p>
<blockquote class="last">
<div><p>if the category is other than one of the expected values.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotificationArea.QNotificationArea.paintEvent">
<code class="descname">paintEvent</code><span class="sig-paren">(</span><em>pe</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotificationArea.html#QNotificationArea.paintEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotificationArea.QNotificationArea.paintEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Redefinition of paintEvent.
Makes class QNotificationArea available in style sheets.
Internal QT function (do not call directly)</p>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotificationArea.QNotificationArea.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>notification=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotificationArea.html#QNotificationArea.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotificationArea.QNotificationArea.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a notification.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>notification</strong> : QNotification (default: None)</p>
<blockquote>
<div><p>The notification to remove. This function also serves as a PyQt slot
for signals emitted from a QNotification. In this case, the QNotification
object is retrieved by using self.sender()</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>ValueError</strong></p>
<blockquote class="last">
<div><p>If notification is not None or a QNotification</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotificationArea.QNotificationArea.resizeEvent">
<code class="descname">resizeEvent</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotificationArea.html#QNotificationArea.resizeEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotificationArea.QNotificationArea.resizeEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Internal QT function (do not call directly).</p>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotificationArea.QNotificationArea.setEntryEffect">
<code class="descname">setEntryEffect</code><span class="sig-paren">(</span><em>effect</em>, <em>duration=250</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotificationArea.html#QNotificationArea.setEntryEffect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotificationArea.QNotificationArea.setEntryEffect" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the effect with which the notifications are to appear.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>effect</strong> : {‘fadeIn’, None}</p>
<blockquote>
<div><p>The effect which should be used (for now only ‘fadeIn’ is available)
if None is passed for this argument, no effect will be used and the
notifcations will just appear directly.</p>
</div></blockquote>
<p><strong>duration</strong> : int (default: 250 ms)</p>
<blockquote>
<div><p>The duration of the effect in milliseconds</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>TypeError</strong></p>
<blockquote>
<div><p>If the object passed for duration is not an int</p>
</div></blockquote>
<p><strong>ValueError</strong></p>
<blockquote class="last">
<div><p>When duration is less than 0, or effect has an invalid value</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotificationArea.QNotificationArea.setExitEffect">
<code class="descname">setExitEffect</code><span class="sig-paren">(</span><em>effect</em>, <em>duration=500</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotificationArea.html#QNotificationArea.setExitEffect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotificationArea.QNotificationArea.setExitEffect" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the effect with which the notifications are to disappear.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>effect</strong> : {‘fadeOut’, None}</p>
<blockquote>
<div><p>the effect which should be used (for now only ‘fadeOut’ is available)
if None is passed for this argument, no effect will be used and the
notifcations will just appear directly.</p>
</div></blockquote>
<p><strong>duration</strong> : int (default: 1000 ms)</p>
<blockquote>
<div><p>The duration of the effect in milliseconds</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>TypeError</strong></p>
<blockquote>
<div><p>If the object passed for duration is not an int</p>
</div></blockquote>
<p><strong>ValueError</strong></p>
<blockquote class="last">
<div><p>When duration is less than 0, or effect has an invalid value</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-QNotifications.QNotification">
<span id="qnotification"></span><h2>QNotification<a class="headerlink" href="#module-QNotifications.QNotification" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="QNotifications.QNotification.QNotification">
<em class="property">class </em><code class="descclassname">QNotifications.QNotification.</code><code class="descname">QNotification</code><span class="sig-paren">(</span><em>message</em>, <em>category</em>, <em>timeout=None</em>, <em>buttontext=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotification.html#QNotification"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotification.QNotification" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">PyQt5.QtWidgets.QWidget</span></code></p>
<p>Class representing a single notification</p>
<p class="rubric">Attributes</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#QNotifications.QNotification.QNotification.category" title="QNotifications.QNotification.QNotification.category"><code class="xref py py-obj docutils literal"><span class="pre">category</span></code></a></td>
<td>The currently set category of this notification.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#QNotifications.QNotification.QNotification.message" title="QNotifications.QNotification.QNotification.message"><code class="xref py py-obj docutils literal"><span class="pre">message</span></code></a></td>
<td>The currently set message to display.</td>
</tr>
</tbody>
</table>
<p class="rubric">Methods</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#QNotifications.QNotification.QNotification.close" title="QNotifications.QNotification.QNotification.close"><code class="xref py py-obj docutils literal"><span class="pre">close</span></code></a>()</td>
<td>Closes the notification.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#QNotifications.QNotification.QNotification.closeClicked" title="QNotifications.QNotification.QNotification.closeClicked"><code class="xref py py-obj docutils literal"><span class="pre">closeClicked</span></code></a></td>
<td>PyQt signal for click on the notification’s close button.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#QNotifications.QNotification.QNotification.display" title="QNotifications.QNotification.QNotification.display"><code class="xref py py-obj docutils literal"><span class="pre">display</span></code></a>()</td>
<td>Displays the notification.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#QNotifications.QNotification.QNotification.fadeIn" title="QNotifications.QNotification.QNotification.fadeIn"><code class="xref py py-obj docutils literal"><span class="pre">fadeIn</span></code></a>(duration)</td>
<td>Fades in the notification.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#QNotifications.QNotification.QNotification.fadeOut" title="QNotifications.QNotification.QNotification.fadeOut"><code class="xref py py-obj docutils literal"><span class="pre">fadeOut</span></code></a>(finishedCallback, duration)</td>
<td>Fades out the notification.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#QNotifications.QNotification.QNotification.paintEvent" title="QNotifications.QNotification.QNotification.paintEvent"><code class="xref py py-obj docutils literal"><span class="pre">paintEvent</span></code></a>(pe)</td>
<td>redefinition of paintEvent, do not call directly.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="QNotifications.QNotification.QNotification.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>message</em>, <em>category</em>, <em>timeout=None</em>, <em>buttontext=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotification.html#QNotification.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotification.QNotification.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Constructor</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>message</strong> : str</p>
<blockquote>
<div><p>The message to show</p>
</div></blockquote>
<p><strong>category</strong> : {‘primary’, ‘success’, ‘info’, ‘warning’, ‘danger’}</p>
<blockquote class="last">
<div><p>The type of notification. Adheres to bootstrap standard
classes which are {primary, success, info, warning, danger}</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="QNotifications.QNotification.QNotification.category">
<code class="descname">category</code><a class="headerlink" href="#QNotifications.QNotification.QNotification.category" title="Permalink to this definition">¶</a></dt>
<dd><p>The currently set category of this notification.</p>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotification.QNotification.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotification.html#QNotification.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotification.QNotification.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Closes the notification.</p>
</dd></dl>
<dl class="attribute">
<dt id="QNotifications.QNotification.QNotification.closeClicked">
<code class="descname">closeClicked</code><a class="headerlink" href="#QNotifications.QNotification.QNotification.closeClicked" title="Permalink to this definition">¶</a></dt>
<dd><p>PyQt signal for click on the notification’s close button.</p>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotification.QNotification.display">
<code class="descname">display</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotification.html#QNotification.display"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotification.QNotification.display" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the notification.</p>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotification.QNotification.fadeIn">
<code class="descname">fadeIn</code><span class="sig-paren">(</span><em>duration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotification.html#QNotification.fadeIn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotification.QNotification.fadeIn" title="Permalink to this definition">¶</a></dt>
<dd><p>Fades in the notification.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>duration</strong> : int</p>
<blockquote>
<div><p>The desired duration of the animation</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>TypeError</strong></p>
<blockquote class="last">
<div><p>if duration is not an integer</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotification.QNotification.fadeOut">
<code class="descname">fadeOut</code><span class="sig-paren">(</span><em>finishedCallback</em>, <em>duration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotification.html#QNotification.fadeOut"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotification.QNotification.fadeOut" title="Permalink to this definition">¶</a></dt>
<dd><p>Fades out the notification.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>finishedCallback</strong> : callable</p>
<blockquote>
<div><p>The function to call after the animation has finished (to for instance
clean up the notification)</p>
</div></blockquote>
<p><strong>duration</strong> : int</p>
<blockquote>
<div><p>The desired duration of the animation</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>TypeError</strong></p>
<blockquote class="last">
<div><p>if the wrong datatype is specified for any of the parameters.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="QNotifications.QNotification.QNotification.message">
<code class="descname">message</code><a class="headerlink" href="#QNotifications.QNotification.QNotification.message" title="Permalink to this definition">¶</a></dt>
<dd><p>The currently set message to display.</p>
</dd></dl>
<dl class="method">
<dt id="QNotifications.QNotification.QNotification.paintEvent">
<code class="descname">paintEvent</code><span class="sig-paren">(</span><em>pe</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/QNotifications/QNotification.html#QNotification.paintEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#QNotifications.QNotification.QNotification.paintEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>redefinition of paintEvent, do not call directly.
Makes class QNotification available in style sheets. Interal Qt function.
Should not be called directly.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="main.html" class="btn btn-neutral" title="Manual" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016, Daniel Schreij.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.1.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>