Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksMenu.html

eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksMenu.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.Bookmarks.BookmarksMenu</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.Bookmarks.BookmarksMenu</h1>
24
25 <p>
26 Module implementing the bookmarks 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="#BookmarksMenu">BookmarksMenu</a></td>
39 <td>Class implementing the bookmarks menu base class.</td>
40 </tr>
41 <tr>
42 <td><a href="#BookmarksMenuBarMenu">BookmarksMenuBarMenu</a></td>
43 <td>Class implementing a dynamically populated menu for bookmarks.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="BookmarksMenu" ID="BookmarksMenu"></a>
54 <h2>BookmarksMenu</h2>
55
56 <p>
57 Class implementing the bookmarks menu base class.
58 </p>
59 <h3>Signals</h3>
60 <dl>
61
62 <dt>newTab(QUrl, str)</dt>
63 <dd>
64 emitted to open a URL with the given title in a
65 new tab
66 </dd>
67 <dt>newWindow(QUrl, str)</dt>
68 <dd>
69 emitted to open a URL with the given title in
70 a new window
71 </dd>
72 <dt>openUrl(QUrl, str)</dt>
73 <dd>
74 emitted to open a URL with the given title in
75 the current tab
76 </dd>
77 </dl>
78 <h3>Derived from</h3>
79 EricModelMenu
80 <h3>Class Attributes</h3>
81
82 <table>
83 <tr><td>None</td></tr>
84 </table>
85 <h3>Class Methods</h3>
86
87 <table>
88 <tr><td>None</td></tr>
89 </table>
90 <h3>Methods</h3>
91
92 <table>
93
94 <tr>
95 <td><a href="#BookmarksMenu.__init__">BookmarksMenu</a></td>
96 <td>Constructor</td>
97 </tr>
98 <tr>
99 <td><a href="#BookmarksMenu.__activated">__activated</a></td>
100 <td>Private slot handling the activated signal.</td>
101 </tr>
102 <tr>
103 <td><a href="#BookmarksMenu.__contextMenuRequested">__contextMenuRequested</a></td>
104 <td>Private slot to handle the context menu request.</td>
105 </tr>
106 <tr>
107 <td><a href="#BookmarksMenu.__edit">__edit</a></td>
108 <td>Private slot to edit a bookmarks properties.</td>
109 </tr>
110 <tr>
111 <td><a href="#BookmarksMenu.__openBookmark">__openBookmark</a></td>
112 <td>Private slot to open a bookmark in the current browser tab.</td>
113 </tr>
114 <tr>
115 <td><a href="#BookmarksMenu.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td>
116 <td>Private slot to open a bookmark in a new browser tab.</td>
117 </tr>
118 <tr>
119 <td><a href="#BookmarksMenu.__openBookmarkInNewWindow">__openBookmarkInNewWindow</a></td>
120 <td>Private slot to open a bookmark in a new window.</td>
121 </tr>
122 <tr>
123 <td><a href="#BookmarksMenu.__openBookmarkInPrivateWindow">__openBookmarkInPrivateWindow</a></td>
124 <td>Private slot to open a bookmark in a new private window.</td>
125 </tr>
126 <tr>
127 <td><a href="#BookmarksMenu.__removeBookmark">__removeBookmark</a></td>
128 <td>Private slot to remove a bookmark.</td>
129 </tr>
130 <tr>
131 <td><a href="#BookmarksMenu.__updateVisitCount">__updateVisitCount</a></td>
132 <td>Private method to update the visit count of a bookmark.</td>
133 </tr>
134 <tr>
135 <td><a href="#BookmarksMenu.createBaseMenu">createBaseMenu</a></td>
136 <td>Public method to get the menu that is used to populate sub menu's.</td>
137 </tr>
138 <tr>
139 <td><a href="#BookmarksMenu.openAll">openAll</a></td>
140 <td>Public slot to open all the menu's items.</td>
141 </tr>
142 <tr>
143 <td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td>
144 <td>Public method to add any actions after the tree.</td>
145 </tr>
146 </table>
147 <h3>Static Methods</h3>
148
149 <table>
150 <tr><td>None</td></tr>
151 </table>
152
153 <a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a>
154 <h4>BookmarksMenu (Constructor)</h4>
155 <b>BookmarksMenu</b>(<i>parent=None</i>)
156
157 <p>
158 Constructor
159 </p>
160 <dl>
161
162 <dt><i>parent</i></dt>
163 <dd>
164 reference to the parent widget (QWidget)
165 </dd>
166 </dl>
167 <a NAME="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a>
168 <h4>BookmarksMenu.__activated</h4>
169 <b>__activated</b>(<i>idx</i>)
170
171 <p>
172 Private slot handling the activated signal.
173 </p>
174 <dl>
175
176 <dt><i>idx</i></dt>
177 <dd>
178 index of the activated item (QModelIndex)
179 </dd>
180 </dl>
181 <a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a>
182 <h4>BookmarksMenu.__contextMenuRequested</h4>
183 <b>__contextMenuRequested</b>(<i>pos</i>)
184
185 <p>
186 Private slot to handle the context menu request.
187 </p>
188 <dl>
189
190 <dt><i>pos</i></dt>
191 <dd>
192 position the context menu shall be shown (QPoint)
193 </dd>
194 </dl>
195 <a NAME="BookmarksMenu.__edit" ID="BookmarksMenu.__edit"></a>
196 <h4>BookmarksMenu.__edit</h4>
197 <b>__edit</b>(<i>act</i>)
198
199 <p>
200 Private slot to edit a bookmarks properties.
201 </p>
202 <dl>
203
204 <dt><i>act</i> (QAction)</dt>
205 <dd>
206 reference to the triggering action
207 </dd>
208 </dl>
209 <a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a>
210 <h4>BookmarksMenu.__openBookmark</h4>
211 <b>__openBookmark</b>(<i>act</i>)
212
213 <p>
214 Private slot to open a bookmark in the current browser tab.
215 </p>
216 <dl>
217
218 <dt><i>act</i> (QAction)</dt>
219 <dd>
220 reference to the triggering action
221 </dd>
222 </dl>
223 <a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a>
224 <h4>BookmarksMenu.__openBookmarkInNewTab</h4>
225 <b>__openBookmarkInNewTab</b>(<i>act</i>)
226
227 <p>
228 Private slot to open a bookmark in a new browser tab.
229 </p>
230 <dl>
231
232 <dt><i>act</i> (QAction)</dt>
233 <dd>
234 reference to the triggering action
235 </dd>
236 </dl>
237 <a NAME="BookmarksMenu.__openBookmarkInNewWindow" ID="BookmarksMenu.__openBookmarkInNewWindow"></a>
238 <h4>BookmarksMenu.__openBookmarkInNewWindow</h4>
239 <b>__openBookmarkInNewWindow</b>(<i>act</i>)
240
241 <p>
242 Private slot to open a bookmark in a new window.
243 </p>
244 <dl>
245
246 <dt><i>act</i> (QAction)</dt>
247 <dd>
248 reference to the triggering action
249 </dd>
250 </dl>
251 <a NAME="BookmarksMenu.__openBookmarkInPrivateWindow" ID="BookmarksMenu.__openBookmarkInPrivateWindow"></a>
252 <h4>BookmarksMenu.__openBookmarkInPrivateWindow</h4>
253 <b>__openBookmarkInPrivateWindow</b>(<i>act</i>)
254
255 <p>
256 Private slot to open a bookmark in a new private window.
257 </p>
258 <dl>
259
260 <dt><i>act</i> (QAction)</dt>
261 <dd>
262 reference to the triggering action
263 </dd>
264 </dl>
265 <a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a>
266 <h4>BookmarksMenu.__removeBookmark</h4>
267 <b>__removeBookmark</b>(<i>act</i>)
268
269 <p>
270 Private slot to remove a bookmark.
271 </p>
272 <dl>
273
274 <dt><i>act</i> (QAction)</dt>
275 <dd>
276 reference to the triggering action
277 </dd>
278 </dl>
279 <a NAME="BookmarksMenu.__updateVisitCount" ID="BookmarksMenu.__updateVisitCount"></a>
280 <h4>BookmarksMenu.__updateVisitCount</h4>
281 <b>__updateVisitCount</b>(<i>idx</i>)
282
283 <p>
284 Private method to update the visit count of a bookmark.
285 </p>
286 <dl>
287
288 <dt><i>idx</i></dt>
289 <dd>
290 index of the bookmark item (QModelIndex)
291 </dd>
292 </dl>
293 <a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a>
294 <h4>BookmarksMenu.createBaseMenu</h4>
295 <b>createBaseMenu</b>(<i></i>)
296
297 <p>
298 Public method to get the menu that is used to populate sub menu's.
299 </p>
300 <dl>
301 <dt>Return:</dt>
302 <dd>
303 reference to the menu (BookmarksMenu)
304 </dd>
305 </dl>
306 <a NAME="BookmarksMenu.openAll" ID="BookmarksMenu.openAll"></a>
307 <h4>BookmarksMenu.openAll</h4>
308 <b>openAll</b>(<i>act</i>)
309
310 <p>
311 Public slot to open all the menu's items.
312 </p>
313 <dl>
314
315 <dt><i>act</i> (QAction)</dt>
316 <dd>
317 reference to the action object
318 </dd>
319 </dl>
320 <a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a>
321 <h4>BookmarksMenu.postPopulated</h4>
322 <b>postPopulated</b>(<i></i>)
323
324 <p>
325 Public method to add any actions after the tree.
326 </p>
327 <div align="right"><a href="#top">Up</a></div>
328 <hr />
329 <hr />
330 <a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a>
331 <h2>BookmarksMenuBarMenu</h2>
332
333 <p>
334 Class implementing a dynamically populated menu for bookmarks.
335 </p>
336 <h3>Signals</h3>
337 <dl>
338
339 <dt>openUrl(QUrl, str)</dt>
340 <dd>
341 emitted to open a URL with the given title in
342 the current tab
343 </dd>
344 </dl>
345 <h3>Derived from</h3>
346 BookmarksMenu
347 <h3>Class Attributes</h3>
348
349 <table>
350 <tr><td>None</td></tr>
351 </table>
352 <h3>Class Methods</h3>
353
354 <table>
355 <tr><td>None</td></tr>
356 </table>
357 <h3>Methods</h3>
358
359 <table>
360
361 <tr>
362 <td><a href="#BookmarksMenuBarMenu.__init__">BookmarksMenuBarMenu</a></td>
363 <td>Constructor</td>
364 </tr>
365 <tr>
366 <td><a href="#BookmarksMenuBarMenu.__defaultBookmarkTriggered">__defaultBookmarkTriggered</a></td>
367 <td>Private slot handling the default bookmark menu entries.</td>
368 </tr>
369 <tr>
370 <td><a href="#BookmarksMenuBarMenu.postPopulated">postPopulated</a></td>
371 <td>Public method to add any actions after the tree.</td>
372 </tr>
373 <tr>
374 <td><a href="#BookmarksMenuBarMenu.prePopulated">prePopulated</a></td>
375 <td>Public method to add any actions before the tree.</td>
376 </tr>
377 <tr>
378 <td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td>
379 <td>Public method to set the list of actions that should appear first in the menu.</td>
380 </tr>
381 </table>
382 <h3>Static Methods</h3>
383
384 <table>
385 <tr><td>None</td></tr>
386 </table>
387
388 <a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a>
389 <h4>BookmarksMenuBarMenu (Constructor)</h4>
390 <b>BookmarksMenuBarMenu</b>(<i>parent=None</i>)
391
392 <p>
393 Constructor
394 </p>
395 <dl>
396
397 <dt><i>parent</i></dt>
398 <dd>
399 reference to the parent widget (QWidget)
400 </dd>
401 </dl>
402 <a NAME="BookmarksMenuBarMenu.__defaultBookmarkTriggered" ID="BookmarksMenuBarMenu.__defaultBookmarkTriggered"></a>
403 <h4>BookmarksMenuBarMenu.__defaultBookmarkTriggered</h4>
404 <b>__defaultBookmarkTriggered</b>(<i>act</i>)
405
406 <p>
407 Private slot handling the default bookmark menu entries.
408 </p>
409 <dl>
410
411 <dt><i>act</i> (QAction)</dt>
412 <dd>
413 reference to the action object
414 </dd>
415 </dl>
416 <a NAME="BookmarksMenuBarMenu.postPopulated" ID="BookmarksMenuBarMenu.postPopulated"></a>
417 <h4>BookmarksMenuBarMenu.postPopulated</h4>
418 <b>postPopulated</b>(<i></i>)
419
420 <p>
421 Public method to add any actions after the tree.
422 </p>
423 <a NAME="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a>
424 <h4>BookmarksMenuBarMenu.prePopulated</h4>
425 <b>prePopulated</b>(<i></i>)
426
427 <p>
428 Public method to add any actions before the tree.
429 </p>
430 <dl>
431 <dt>Return:</dt>
432 <dd>
433 flag indicating if any actions were added (boolean)
434 </dd>
435 </dl>
436 <a NAME="BookmarksMenuBarMenu.setInitialActions" ID="BookmarksMenuBarMenu.setInitialActions"></a>
437 <h4>BookmarksMenuBarMenu.setInitialActions</h4>
438 <b>setInitialActions</b>(<i>actions</i>)
439
440 <p>
441 Public method to set the list of actions that should appear first in
442 the menu.
443 </p>
444 <dl>
445
446 <dt><i>actions</i></dt>
447 <dd>
448 list of initial actions (list of QAction)
449 </dd>
450 </dl>
451 <div align="right"><a href="#top">Up</a></div>
452 <hr />
453 </body></html>

Mercurial Repository: eric

eric ide

mercurial