Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.History.HistoryMenu.html

eric7/Documentation/Source/eric7.WebBrowser.History.HistoryMenu.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.History.HistoryMenu</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.History.HistoryMenu</h1>
24
25 <p>
26 Module implementing the history menu.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#HistoryMenu">HistoryMenu</a></td>
39 <td>Class implementing the history menu.</td>
40 </tr>
41 <tr>
42 <td><a href="#HistoryMenuModel">HistoryMenuModel</a></td>
43 <td>Class implementing a model for the history menu.</td>
44 </tr>
45 <tr>
46 <td><a href="#HistoryMostVisitedMenu">HistoryMostVisitedMenu</a></td>
47 <td>Class implementing the most visited history menu.</td>
48 </tr>
49 <tr>
50 <td><a href="#HistoryMostVisitedMenuModel">HistoryMostVisitedMenuModel</a></td>
51 <td>Class implementing a model to show the most visited history entries.</td>
52 </tr>
53 </table>
54 <h3>Functions</h3>
55
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <hr />
60 <hr />
61 <a NAME="HistoryMenu" ID="HistoryMenu"></a>
62 <h2>HistoryMenu</h2>
63
64 <p>
65 Class implementing the history menu.
66 </p>
67 <h3>Signals</h3>
68 <dl>
69
70 <dt>newBackgroundTab(QUrl, str)</dt>
71 <dd>
72 emitted to open a URL in a new
73 background tab
74 </dd>
75 <dt>newPrivateWindow(QUrl, str)</dt>
76 <dd>
77 emitted to open a URL in a new
78 private window
79 </dd>
80 <dt>newTab(QUrl, str)</dt>
81 <dd>
82 emitted to open a URL in a new tab
83 </dd>
84 <dt>newWindow(QUrl, str)</dt>
85 <dd>
86 emitted to open a URL in a new window
87 </dd>
88 <dt>openUrl(QUrl, str)</dt>
89 <dd>
90 emitted to open a URL in the current tab
91 </dd>
92 </dl>
93 <h3>Derived from</h3>
94 EricModelMenu
95 <h3>Class Attributes</h3>
96
97 <table>
98 <tr><td>None</td></tr>
99 </table>
100 <h3>Class Methods</h3>
101
102 <table>
103 <tr><td>None</td></tr>
104 </table>
105 <h3>Methods</h3>
106
107 <table>
108
109 <tr>
110 <td><a href="#HistoryMenu.__init__">HistoryMenu</a></td>
111 <td>Constructor</td>
112 </tr>
113 <tr>
114 <td><a href="#HistoryMenu.__aboutToShowClosedTabsMenu">__aboutToShowClosedTabsMenu</a></td>
115 <td>Private slot to populate the closed tabs menu.</td>
116 </tr>
117 <tr>
118 <td><a href="#HistoryMenu.__activated">__activated</a></td>
119 <td>Private slot handling the activated signal.</td>
120 </tr>
121 <tr>
122 <td><a href="#HistoryMenu.__clearHistoryDialog">__clearHistoryDialog</a></td>
123 <td>Private slot to clear the history.</td>
124 </tr>
125 <tr>
126 <td><a href="#HistoryMenu.__closedTabAvailable">__closedTabAvailable</a></td>
127 <td>Private slot to handle changes of the availability of closed tabs.</td>
128 </tr>
129 <tr>
130 <td><a href="#HistoryMenu.postPopulated">postPopulated</a></td>
131 <td>Public method to add any actions after the tree.</td>
132 </tr>
133 <tr>
134 <td><a href="#HistoryMenu.prePopulated">prePopulated</a></td>
135 <td>Public method to add any actions before the tree.</td>
136 </tr>
137 <tr>
138 <td><a href="#HistoryMenu.setInitialActions">setInitialActions</a></td>
139 <td>Public method to set the list of actions that should appear first in the menu.</td>
140 </tr>
141 <tr>
142 <td><a href="#HistoryMenu.showHistoryDialog">showHistoryDialog</a></td>
143 <td>Public slot to show the history dialog.</td>
144 </tr>
145 </table>
146 <h3>Static Methods</h3>
147
148 <table>
149 <tr><td>None</td></tr>
150 </table>
151
152 <a NAME="HistoryMenu.__init__" ID="HistoryMenu.__init__"></a>
153 <h4>HistoryMenu (Constructor)</h4>
154 <b>HistoryMenu</b>(<i>parent=None, tabWidget=None</i>)
155
156 <p>
157 Constructor
158 </p>
159 <dl>
160
161 <dt><i>parent</i></dt>
162 <dd>
163 reference to the parent widget (QWidget)
164 </dd>
165 <dt><i>tabWidget</i></dt>
166 <dd>
167 reference to the tab widget managing the browser
168 tabs (HelpTabWidget
169 </dd>
170 </dl>
171 <a NAME="HistoryMenu.__aboutToShowClosedTabsMenu" ID="HistoryMenu.__aboutToShowClosedTabsMenu"></a>
172 <h4>HistoryMenu.__aboutToShowClosedTabsMenu</h4>
173 <b>__aboutToShowClosedTabsMenu</b>(<i></i>)
174
175 <p>
176 Private slot to populate the closed tabs menu.
177 </p>
178 <a NAME="HistoryMenu.__activated" ID="HistoryMenu.__activated"></a>
179 <h4>HistoryMenu.__activated</h4>
180 <b>__activated</b>(<i>idx</i>)
181
182 <p>
183 Private slot handling the activated signal.
184 </p>
185 <dl>
186
187 <dt><i>idx</i></dt>
188 <dd>
189 index of the activated item (QModelIndex)
190 </dd>
191 </dl>
192 <a NAME="HistoryMenu.__clearHistoryDialog" ID="HistoryMenu.__clearHistoryDialog"></a>
193 <h4>HistoryMenu.__clearHistoryDialog</h4>
194 <b>__clearHistoryDialog</b>(<i></i>)
195
196 <p>
197 Private slot to clear the history.
198 </p>
199 <a NAME="HistoryMenu.__closedTabAvailable" ID="HistoryMenu.__closedTabAvailable"></a>
200 <h4>HistoryMenu.__closedTabAvailable</h4>
201 <b>__closedTabAvailable</b>(<i>avail</i>)
202
203 <p>
204 Private slot to handle changes of the availability of closed tabs.
205 </p>
206 <dl>
207
208 <dt><i>avail</i></dt>
209 <dd>
210 flag indicating the availability of closed tabs (boolean)
211 </dd>
212 </dl>
213 <a NAME="HistoryMenu.postPopulated" ID="HistoryMenu.postPopulated"></a>
214 <h4>HistoryMenu.postPopulated</h4>
215 <b>postPopulated</b>(<i></i>)
216
217 <p>
218 Public method to add any actions after the tree.
219 </p>
220 <a NAME="HistoryMenu.prePopulated" ID="HistoryMenu.prePopulated"></a>
221 <h4>HistoryMenu.prePopulated</h4>
222 <b>prePopulated</b>(<i></i>)
223
224 <p>
225 Public method to add any actions before the tree.
226 </p>
227 <dl>
228 <dt>Return:</dt>
229 <dd>
230 flag indicating if any actions were added (boolean)
231 </dd>
232 </dl>
233 <a NAME="HistoryMenu.setInitialActions" ID="HistoryMenu.setInitialActions"></a>
234 <h4>HistoryMenu.setInitialActions</h4>
235 <b>setInitialActions</b>(<i>actions</i>)
236
237 <p>
238 Public method to set the list of actions that should appear first in
239 the menu.
240 </p>
241 <dl>
242
243 <dt><i>actions</i></dt>
244 <dd>
245 list of initial actions (list of QAction)
246 </dd>
247 </dl>
248 <a NAME="HistoryMenu.showHistoryDialog" ID="HistoryMenu.showHistoryDialog"></a>
249 <h4>HistoryMenu.showHistoryDialog</h4>
250 <b>showHistoryDialog</b>(<i></i>)
251
252 <p>
253 Public slot to show the history dialog.
254 </p>
255 <div align="right"><a href="#top">Up</a></div>
256 <hr />
257 <hr />
258 <a NAME="HistoryMenuModel" ID="HistoryMenuModel"></a>
259 <h2>HistoryMenuModel</h2>
260
261 <p>
262 Class implementing a model for the history menu.
263 </p>
264 <p>
265 It maps the first bunch of items of the source model to the root.
266 </p>
267 <h3>Derived from</h3>
268 QAbstractProxyModel
269 <h3>Class Attributes</h3>
270
271 <table>
272 <tr><td>MOVEDROWS</td></tr>
273 </table>
274 <h3>Class Methods</h3>
275
276 <table>
277 <tr><td>None</td></tr>
278 </table>
279 <h3>Methods</h3>
280
281 <table>
282
283 <tr>
284 <td><a href="#HistoryMenuModel.__init__">HistoryMenuModel</a></td>
285 <td>Constructor</td>
286 </tr>
287 <tr>
288 <td><a href="#HistoryMenuModel.bumpedRows">bumpedRows</a></td>
289 <td>Public method to determine the number of rows moved to the root.</td>
290 </tr>
291 <tr>
292 <td><a href="#HistoryMenuModel.columnCount">columnCount</a></td>
293 <td>Public method to get the number of columns.</td>
294 </tr>
295 <tr>
296 <td><a href="#HistoryMenuModel.index">index</a></td>
297 <td>Public method to create an index.</td>
298 </tr>
299 <tr>
300 <td><a href="#HistoryMenuModel.mapFromSource">mapFromSource</a></td>
301 <td>Public method to map an index to the proxy model index.</td>
302 </tr>
303 <tr>
304 <td><a href="#HistoryMenuModel.mapToSource">mapToSource</a></td>
305 <td>Public method to map an index to the source model index.</td>
306 </tr>
307 <tr>
308 <td><a href="#HistoryMenuModel.mimeData">mimeData</a></td>
309 <td>Public method to return the mime data.</td>
310 </tr>
311 <tr>
312 <td><a href="#HistoryMenuModel.parent">parent</a></td>
313 <td>Public method to get the parent index.</td>
314 </tr>
315 <tr>
316 <td><a href="#HistoryMenuModel.rowCount">rowCount</a></td>
317 <td>Public method to determine the number of rows.</td>
318 </tr>
319 </table>
320 <h3>Static Methods</h3>
321
322 <table>
323 <tr><td>None</td></tr>
324 </table>
325
326 <a NAME="HistoryMenuModel.__init__" ID="HistoryMenuModel.__init__"></a>
327 <h4>HistoryMenuModel (Constructor)</h4>
328 <b>HistoryMenuModel</b>(<i>sourceModel, parent=None</i>)
329
330 <p>
331 Constructor
332 </p>
333 <dl>
334
335 <dt><i>sourceModel</i></dt>
336 <dd>
337 reference to the source model (QAbstractItemModel)
338 </dd>
339 <dt><i>parent</i></dt>
340 <dd>
341 reference to the parent object (QObject)
342 </dd>
343 </dl>
344 <a NAME="HistoryMenuModel.bumpedRows" ID="HistoryMenuModel.bumpedRows"></a>
345 <h4>HistoryMenuModel.bumpedRows</h4>
346 <b>bumpedRows</b>(<i></i>)
347
348 <p>
349 Public method to determine the number of rows moved to the root.
350 </p>
351 <dl>
352 <dt>Return:</dt>
353 <dd>
354 number of rows moved to the root (integer)
355 </dd>
356 </dl>
357 <a NAME="HistoryMenuModel.columnCount" ID="HistoryMenuModel.columnCount"></a>
358 <h4>HistoryMenuModel.columnCount</h4>
359 <b>columnCount</b>(<i>parent=None</i>)
360
361 <p>
362 Public method to get the number of columns.
363 </p>
364 <dl>
365
366 <dt><i>parent</i></dt>
367 <dd>
368 index of parent (QModelIndex)
369 </dd>
370 </dl>
371 <dl>
372 <dt>Return:</dt>
373 <dd>
374 number of columns (integer)
375 </dd>
376 </dl>
377 <a NAME="HistoryMenuModel.index" ID="HistoryMenuModel.index"></a>
378 <h4>HistoryMenuModel.index</h4>
379 <b>index</b>(<i>row, column, parent=None</i>)
380
381 <p>
382 Public method to create an index.
383 </p>
384 <dl>
385
386 <dt><i>row</i></dt>
387 <dd>
388 row number for the index (integer)
389 </dd>
390 <dt><i>column</i></dt>
391 <dd>
392 column number for the index (integer)
393 </dd>
394 <dt><i>parent</i></dt>
395 <dd>
396 index of the parent item (QModelIndex)
397 </dd>
398 </dl>
399 <dl>
400 <dt>Return:</dt>
401 <dd>
402 requested index (QModelIndex)
403 </dd>
404 </dl>
405 <a NAME="HistoryMenuModel.mapFromSource" ID="HistoryMenuModel.mapFromSource"></a>
406 <h4>HistoryMenuModel.mapFromSource</h4>
407 <b>mapFromSource</b>(<i>sourceIndex</i>)
408
409 <p>
410 Public method to map an index to the proxy model index.
411 </p>
412 <dl>
413
414 <dt><i>sourceIndex</i></dt>
415 <dd>
416 reference to a source model index (QModelIndex)
417 </dd>
418 </dl>
419 <dl>
420 <dt>Return:</dt>
421 <dd>
422 proxy model index (QModelIndex)
423 </dd>
424 </dl>
425 <a NAME="HistoryMenuModel.mapToSource" ID="HistoryMenuModel.mapToSource"></a>
426 <h4>HistoryMenuModel.mapToSource</h4>
427 <b>mapToSource</b>(<i>proxyIndex</i>)
428
429 <p>
430 Public method to map an index to the source model index.
431 </p>
432 <dl>
433
434 <dt><i>proxyIndex</i></dt>
435 <dd>
436 reference to a proxy model index (QModelIndex)
437 </dd>
438 </dl>
439 <dl>
440 <dt>Return:</dt>
441 <dd>
442 source model index (QModelIndex)
443 </dd>
444 </dl>
445 <a NAME="HistoryMenuModel.mimeData" ID="HistoryMenuModel.mimeData"></a>
446 <h4>HistoryMenuModel.mimeData</h4>
447 <b>mimeData</b>(<i>indexes</i>)
448
449 <p>
450 Public method to return the mime data.
451 </p>
452 <dl>
453
454 <dt><i>indexes</i></dt>
455 <dd>
456 list of indexes (QModelIndexList)
457 </dd>
458 </dl>
459 <dl>
460 <dt>Return:</dt>
461 <dd>
462 mime data (QMimeData)
463 </dd>
464 </dl>
465 <a NAME="HistoryMenuModel.parent" ID="HistoryMenuModel.parent"></a>
466 <h4>HistoryMenuModel.parent</h4>
467 <b>parent</b>(<i>index</i>)
468
469 <p>
470 Public method to get the parent index.
471 </p>
472 <dl>
473
474 <dt><i>index</i></dt>
475 <dd>
476 index of item to get parent (QModelIndex)
477 </dd>
478 </dl>
479 <dl>
480 <dt>Return:</dt>
481 <dd>
482 index of parent (QModelIndex)
483 </dd>
484 </dl>
485 <a NAME="HistoryMenuModel.rowCount" ID="HistoryMenuModel.rowCount"></a>
486 <h4>HistoryMenuModel.rowCount</h4>
487 <b>rowCount</b>(<i>parent=None</i>)
488
489 <p>
490 Public method to determine the number of rows.
491 </p>
492 <dl>
493
494 <dt><i>parent</i></dt>
495 <dd>
496 index of parent (QModelIndex)
497 </dd>
498 </dl>
499 <dl>
500 <dt>Return:</dt>
501 <dd>
502 number of rows (integer)
503 </dd>
504 </dl>
505 <div align="right"><a href="#top">Up</a></div>
506 <hr />
507 <hr />
508 <a NAME="HistoryMostVisitedMenu" ID="HistoryMostVisitedMenu"></a>
509 <h2>HistoryMostVisitedMenu</h2>
510
511 <p>
512 Class implementing the most visited history menu.
513 </p>
514 <h3>Signals</h3>
515 <dl>
516
517 <dt>newBackgroundTab(QUrl, str)</dt>
518 <dd>
519 emitted to open a URL in a new
520 background tab
521 </dd>
522 <dt>newPrivateWindow(QUrl, str)</dt>
523 <dd>
524 emitted to open a URL in a new
525 private window
526 </dd>
527 <dt>newTab(QUrl, str)</dt>
528 <dd>
529 emitted to open a URL in a new tab
530 </dd>
531 <dt>newWindow(QUrl, str)</dt>
532 <dd>
533 emitted to open a URL in a new window
534 </dd>
535 <dt>openUrl(QUrl, str)</dt>
536 <dd>
537 emitted to open a URL in the current tab
538 </dd>
539 </dl>
540 <h3>Derived from</h3>
541 EricModelMenu
542 <h3>Class Attributes</h3>
543
544 <table>
545 <tr><td>None</td></tr>
546 </table>
547 <h3>Class Methods</h3>
548
549 <table>
550 <tr><td>None</td></tr>
551 </table>
552 <h3>Methods</h3>
553
554 <table>
555
556 <tr>
557 <td><a href="#HistoryMostVisitedMenu.__init__">HistoryMostVisitedMenu</a></td>
558 <td>Constructor</td>
559 </tr>
560 <tr>
561 <td><a href="#HistoryMostVisitedMenu.__activated">__activated</a></td>
562 <td>Private slot handling the activated signal.</td>
563 </tr>
564 <tr>
565 <td><a href="#HistoryMostVisitedMenu.prePopulated">prePopulated</a></td>
566 <td>Public method to add any actions before the tree.</td>
567 </tr>
568 </table>
569 <h3>Static Methods</h3>
570
571 <table>
572 <tr><td>None</td></tr>
573 </table>
574
575 <a NAME="HistoryMostVisitedMenu.__init__" ID="HistoryMostVisitedMenu.__init__"></a>
576 <h4>HistoryMostVisitedMenu (Constructor)</h4>
577 <b>HistoryMostVisitedMenu</b>(<i>count, parent=None</i>)
578
579 <p>
580 Constructor
581 </p>
582 <dl>
583
584 <dt><i>count</i></dt>
585 <dd>
586 maximum number of entries to be shown (integer)
587 </dd>
588 <dt><i>parent</i></dt>
589 <dd>
590 reference to the parent widget (QWidget)
591 </dd>
592 </dl>
593 <a NAME="HistoryMostVisitedMenu.__activated" ID="HistoryMostVisitedMenu.__activated"></a>
594 <h4>HistoryMostVisitedMenu.__activated</h4>
595 <b>__activated</b>(<i>idx</i>)
596
597 <p>
598 Private slot handling the activated signal.
599 </p>
600 <dl>
601
602 <dt><i>idx</i></dt>
603 <dd>
604 index of the activated item (QModelIndex)
605 </dd>
606 </dl>
607 <a NAME="HistoryMostVisitedMenu.prePopulated" ID="HistoryMostVisitedMenu.prePopulated"></a>
608 <h4>HistoryMostVisitedMenu.prePopulated</h4>
609 <b>prePopulated</b>(<i></i>)
610
611 <p>
612 Public method to add any actions before the tree.
613 </p>
614 <dl>
615 <dt>Return:</dt>
616 <dd>
617 flag indicating if any actions were added (boolean)
618 </dd>
619 </dl>
620 <div align="right"><a href="#top">Up</a></div>
621 <hr />
622 <hr />
623 <a NAME="HistoryMostVisitedMenuModel" ID="HistoryMostVisitedMenuModel"></a>
624 <h2>HistoryMostVisitedMenuModel</h2>
625
626 <p>
627 Class implementing a model to show the most visited history entries.
628 </p>
629 <h3>Derived from</h3>
630 QSortFilterProxyModel
631 <h3>Class Attributes</h3>
632
633 <table>
634 <tr><td>None</td></tr>
635 </table>
636 <h3>Class Methods</h3>
637
638 <table>
639 <tr><td>None</td></tr>
640 </table>
641 <h3>Methods</h3>
642
643 <table>
644
645 <tr>
646 <td><a href="#HistoryMostVisitedMenuModel.__init__">HistoryMostVisitedMenuModel</a></td>
647 <td>Constructor</td>
648 </tr>
649 <tr>
650 <td><a href="#HistoryMostVisitedMenuModel.lessThan">lessThan</a></td>
651 <td>Public method used to sort the displayed items.</td>
652 </tr>
653 </table>
654 <h3>Static Methods</h3>
655
656 <table>
657 <tr><td>None</td></tr>
658 </table>
659
660 <a NAME="HistoryMostVisitedMenuModel.__init__" ID="HistoryMostVisitedMenuModel.__init__"></a>
661 <h4>HistoryMostVisitedMenuModel (Constructor)</h4>
662 <b>HistoryMostVisitedMenuModel</b>(<i>sourceModel, parent=None</i>)
663
664 <p>
665 Constructor
666 </p>
667 <dl>
668
669 <dt><i>sourceModel</i></dt>
670 <dd>
671 reference to the source model (QAbstractItemModel)
672 </dd>
673 <dt><i>parent</i></dt>
674 <dd>
675 reference to the parent object (QObject)
676 </dd>
677 </dl>
678 <a NAME="HistoryMostVisitedMenuModel.lessThan" ID="HistoryMostVisitedMenuModel.lessThan"></a>
679 <h4>HistoryMostVisitedMenuModel.lessThan</h4>
680 <b>lessThan</b>(<i>left, right</i>)
681
682 <p>
683 Public method used to sort the displayed items.
684 </p>
685 <dl>
686
687 <dt><i>left</i></dt>
688 <dd>
689 index of left item (QModelIndex)
690 </dd>
691 <dt><i>right</i></dt>
692 <dd>
693 index of right item (QModelIndex)
694 </dd>
695 </dl>
696 <dl>
697 <dt>Return:</dt>
698 <dd>
699 true, if left is less than right (boolean)
700 </dd>
701 </dl>
702 <div align="right"><a href="#top">Up</a></div>
703 <hr />
704 </body></html>

Mercurial Repository: eric

eric ide

mercurial