QNotifications/api.html at gh-pages · pythoningLearning/QNotifications

History

595 lines (475 loc) · 28.4 KB

Raw

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>

<html class="no-js" lang="en" >

<head>

<title>API Reference — QNotifications 1.1.0 documentation</title>

</head>

<a href="index.html" class="icon icon-home"> QNotifications

</a>

1.1.0

</div>

</form>

</div>

<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>

</nav>

<a href="index.html">QNotifications</a>

</nav>

<li>API Reference</li>

<a href="_sources/api.txt" rel="nofollow"> View page source</a>

</li>

</ul>

<hr/>

</div>

<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>

<span id="qnotificationarea"></span><h2>QNotificationArea<a class="headerlink" href="#module-QNotifications.QNotificationArea" title="Permalink to this headline">¶</a></h2>

<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>

</colgroup>

<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>

<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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>targetWidget</strong> : QtWidgets.QWidget</p>

<div><p>The widget to project the notifications on</p>

</div></blockquote>

<p><strong>useGlobalCSS</strong> : bool (default: False)</p>

<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>

<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>

<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>

<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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>message</strong> : str</p>

<div><p>The message to display</p>

</div></blockquote>

<p><strong>category</strong> : {‘primary’, ‘success’, ‘info’, ‘warning’, ‘danger’}</p>

<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>

<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>

<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>

<div><p>if the category is other than one of the expected values.</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<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>

<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>

<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>

<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>

<div><p>If notification is not None or a QNotification</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<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>

<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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>effect</strong> : {‘fadeIn’, None}</p>

<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>

<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>

<div><p>If the object passed for duration is not an int</p>

</div></blockquote>

<p><strong>ValueError</strong></p>

<div><p>When duration is less than 0, or effect has an invalid value</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>effect</strong> : {‘fadeOut’, None}</p>

<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>

<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>

<div><p>If the object passed for duration is not an int</p>

</div></blockquote>

<p><strong>ValueError</strong></p>

<div><p>When duration is less than 0, or effect has an invalid value</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

<span id="qnotification"></span><h2>QNotification<a class="headerlink" href="#module-QNotifications.QNotification" title="Permalink to this headline">¶</a></h2>

<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>

</colgroup>

<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>

</colgroup>

<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>

<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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>message</strong> : str</p>

<div><p>The message to show</p>

</div></blockquote>

<p><strong>category</strong> : {‘primary’, ‘success’, ‘info’, ‘warning’, ‘danger’}</p>

<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>

<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>

<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>

<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>

<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>

<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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>duration</strong> : int</p>

<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>

<div><p>if duration is not an integer</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>finishedCallback</strong> : callable</p>

<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>

<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>

<div><p>if the wrong datatype is specified for any of the parameters.</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<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>

<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>

</div>

<a href="main.html" class="btn btn-neutral" title="Manual" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

<hr/>

<p>

</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>

</section>

</div>

var DOCUMENTATION_OPTIONS = {

URL_ROOT:'./',

VERSION:'1.1.0',

COLLAPSE_INDEX:false,

FILE_SUFFIX:'.html',

HAS_SOURCE: true

};

</script>

jQuery(function () {

SphinxRtdTheme.StickyNav.enable();

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

api.html

Latest commit

History

api.html

File metadata and controls