5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.WebBrowser.Bookmarks.BookmarksMenu</h1> |
9 <h1>eric7.WebBrowser.Bookmarks.BookmarksMenu</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the bookmarks menu. |
11 Module implementing the bookmarks menu. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
15 <table> |
16 <table> |
16 <tr><td>None</td></tr> |
17 <tr><td>None</td></tr> |
17 </table> |
18 </table> |
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#BookmarksMenu">BookmarksMenu</a></td> |
22 <td><a href="#BookmarksMenu">BookmarksMenu</a></td> |
25 <td>Class implementing the bookmarks menu base class.</td> |
23 <td>Class implementing the bookmarks menu base class.</td> |
26 </tr> |
24 </tr> |
27 <tr> |
25 <tr> |
28 <td><a href="#BookmarksMenuBarMenu">BookmarksMenuBarMenu</a></td> |
26 <td><a href="#BookmarksMenuBarMenu">BookmarksMenuBarMenu</a></td> |
29 <td>Class implementing a dynamically populated menu for bookmarks.</td> |
27 <td>Class implementing a dynamically populated menu for bookmarks.</td> |
30 </tr> |
28 </tr> |
31 </table> |
29 </table> |
|
30 |
32 <h3>Functions</h3> |
31 <h3>Functions</h3> |
33 |
32 <table> |
34 <table> |
33 <tr><td>None</td></tr> |
35 <tr><td>None</td></tr> |
34 </table> |
36 </table> |
35 |
37 <hr /> |
36 <hr /> |
38 <hr /> |
37 <hr /> |
39 <a NAME="BookmarksMenu" ID="BookmarksMenu"></a> |
38 <a NAME="BookmarksMenu" ID="BookmarksMenu"></a> |
40 <h2>BookmarksMenu</h2> |
39 <h2>BookmarksMenu</h2> |
41 |
|
42 <p> |
40 <p> |
43 Class implementing the bookmarks menu base class. |
41 Class implementing the bookmarks menu base class. |
44 </p> |
42 </p> |
|
43 |
45 <h3>Signals</h3> |
44 <h3>Signals</h3> |
46 <dl> |
45 <dl> |
47 |
46 |
48 <dt>newTab(QUrl, str)</dt> |
47 <dt>newTab(QUrl, str)</dt> |
49 <dd> |
48 <dd> |
128 <tr> |
125 <tr> |
129 <td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td> |
126 <td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td> |
130 <td>Public method to add any actions after the tree.</td> |
127 <td>Public method to add any actions after the tree.</td> |
131 </tr> |
128 </tr> |
132 </table> |
129 </table> |
|
130 |
133 <h3>Static Methods</h3> |
131 <h3>Static Methods</h3> |
134 |
132 <table> |
135 <table> |
133 <tr><td>None</td></tr> |
136 <tr><td>None</td></tr> |
134 </table> |
137 </table> |
135 |
138 |
136 |
139 <a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a> |
137 <a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a> |
140 <h4>BookmarksMenu (Constructor)</h4> |
138 <h4>BookmarksMenu (Constructor)</h4> |
141 <b>BookmarksMenu</b>(<i>parent=None</i>) |
139 <b>BookmarksMenu</b>(<i>parent=None</i>) |
142 |
|
143 <p> |
140 <p> |
144 Constructor |
141 Constructor |
145 </p> |
142 </p> |
|
143 |
146 <dl> |
144 <dl> |
147 |
145 |
148 <dt><i>parent</i> (QWidget)</dt> |
146 <dt><i>parent</i> (QWidget)</dt> |
149 <dd> |
147 <dd> |
150 reference to the parent widget |
148 reference to the parent widget |
151 </dd> |
149 </dd> |
152 </dl> |
150 </dl> |
153 <a NAME="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a> |
151 <a NAME="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a> |
154 <h4>BookmarksMenu.__activated</h4> |
152 <h4>BookmarksMenu.__activated</h4> |
155 <b>__activated</b>(<i>idx</i>) |
153 <b>__activated</b>(<i>idx</i>) |
156 |
|
157 <p> |
154 <p> |
158 Private slot handling the activated signal. |
155 Private slot handling the activated signal. |
159 </p> |
156 </p> |
|
157 |
160 <dl> |
158 <dl> |
161 |
159 |
162 <dt><i>idx</i> (QModelIndex)</dt> |
160 <dt><i>idx</i> (QModelIndex)</dt> |
163 <dd> |
161 <dd> |
164 index of the activated item |
162 index of the activated item |
165 </dd> |
163 </dd> |
166 </dl> |
164 </dl> |
167 <a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a> |
165 <a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a> |
168 <h4>BookmarksMenu.__contextMenuRequested</h4> |
166 <h4>BookmarksMenu.__contextMenuRequested</h4> |
169 <b>__contextMenuRequested</b>(<i>pos</i>) |
167 <b>__contextMenuRequested</b>(<i>pos</i>) |
170 |
|
171 <p> |
168 <p> |
172 Private slot to handle the context menu request. |
169 Private slot to handle the context menu request. |
173 </p> |
170 </p> |
|
171 |
174 <dl> |
172 <dl> |
175 |
173 |
176 <dt><i>pos</i> (QPoint)</dt> |
174 <dt><i>pos</i> (QPoint)</dt> |
177 <dd> |
175 <dd> |
178 position the context menu shall be shown |
176 position the context menu shall be shown |
179 </dd> |
177 </dd> |
180 </dl> |
178 </dl> |
181 <a NAME="BookmarksMenu.__edit" ID="BookmarksMenu.__edit"></a> |
179 <a NAME="BookmarksMenu.__edit" ID="BookmarksMenu.__edit"></a> |
182 <h4>BookmarksMenu.__edit</h4> |
180 <h4>BookmarksMenu.__edit</h4> |
183 <b>__edit</b>(<i>act</i>) |
181 <b>__edit</b>(<i>act</i>) |
184 |
|
185 <p> |
182 <p> |
186 Private slot to edit a bookmarks properties. |
183 Private slot to edit a bookmarks properties. |
187 </p> |
184 </p> |
|
185 |
188 <dl> |
186 <dl> |
189 |
187 |
190 <dt><i>act</i> (QAction)</dt> |
188 <dt><i>act</i> (QAction)</dt> |
191 <dd> |
189 <dd> |
192 reference to the triggering action |
190 reference to the triggering action |
193 </dd> |
191 </dd> |
194 </dl> |
192 </dl> |
195 <a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a> |
193 <a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a> |
196 <h4>BookmarksMenu.__openBookmark</h4> |
194 <h4>BookmarksMenu.__openBookmark</h4> |
197 <b>__openBookmark</b>(<i>act</i>) |
195 <b>__openBookmark</b>(<i>act</i>) |
198 |
|
199 <p> |
196 <p> |
200 Private slot to open a bookmark in the current browser tab. |
197 Private slot to open a bookmark in the current browser tab. |
201 </p> |
198 </p> |
|
199 |
202 <dl> |
200 <dl> |
203 |
201 |
204 <dt><i>act</i> (QAction)</dt> |
202 <dt><i>act</i> (QAction)</dt> |
205 <dd> |
203 <dd> |
206 reference to the triggering action |
204 reference to the triggering action |
207 </dd> |
205 </dd> |
208 </dl> |
206 </dl> |
209 <a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a> |
207 <a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a> |
210 <h4>BookmarksMenu.__openBookmarkInNewTab</h4> |
208 <h4>BookmarksMenu.__openBookmarkInNewTab</h4> |
211 <b>__openBookmarkInNewTab</b>(<i>act</i>) |
209 <b>__openBookmarkInNewTab</b>(<i>act</i>) |
212 |
|
213 <p> |
210 <p> |
214 Private slot to open a bookmark in a new browser tab. |
211 Private slot to open a bookmark in a new browser tab. |
215 </p> |
212 </p> |
|
213 |
216 <dl> |
214 <dl> |
217 |
215 |
218 <dt><i>act</i> (QAction)</dt> |
216 <dt><i>act</i> (QAction)</dt> |
219 <dd> |
217 <dd> |
220 reference to the triggering action |
218 reference to the triggering action |
221 </dd> |
219 </dd> |
222 </dl> |
220 </dl> |
223 <a NAME="BookmarksMenu.__openBookmarkInNewWindow" ID="BookmarksMenu.__openBookmarkInNewWindow"></a> |
221 <a NAME="BookmarksMenu.__openBookmarkInNewWindow" ID="BookmarksMenu.__openBookmarkInNewWindow"></a> |
224 <h4>BookmarksMenu.__openBookmarkInNewWindow</h4> |
222 <h4>BookmarksMenu.__openBookmarkInNewWindow</h4> |
225 <b>__openBookmarkInNewWindow</b>(<i>act</i>) |
223 <b>__openBookmarkInNewWindow</b>(<i>act</i>) |
226 |
|
227 <p> |
224 <p> |
228 Private slot to open a bookmark in a new window. |
225 Private slot to open a bookmark in a new window. |
229 </p> |
226 </p> |
|
227 |
230 <dl> |
228 <dl> |
231 |
229 |
232 <dt><i>act</i> (QAction)</dt> |
230 <dt><i>act</i> (QAction)</dt> |
233 <dd> |
231 <dd> |
234 reference to the triggering action |
232 reference to the triggering action |
235 </dd> |
233 </dd> |
236 </dl> |
234 </dl> |
237 <a NAME="BookmarksMenu.__openBookmarkInPrivateWindow" ID="BookmarksMenu.__openBookmarkInPrivateWindow"></a> |
235 <a NAME="BookmarksMenu.__openBookmarkInPrivateWindow" ID="BookmarksMenu.__openBookmarkInPrivateWindow"></a> |
238 <h4>BookmarksMenu.__openBookmarkInPrivateWindow</h4> |
236 <h4>BookmarksMenu.__openBookmarkInPrivateWindow</h4> |
239 <b>__openBookmarkInPrivateWindow</b>(<i>act</i>) |
237 <b>__openBookmarkInPrivateWindow</b>(<i>act</i>) |
240 |
|
241 <p> |
238 <p> |
242 Private slot to open a bookmark in a new private window. |
239 Private slot to open a bookmark in a new private window. |
243 </p> |
240 </p> |
|
241 |
244 <dl> |
242 <dl> |
245 |
243 |
246 <dt><i>act</i> (QAction)</dt> |
244 <dt><i>act</i> (QAction)</dt> |
247 <dd> |
245 <dd> |
248 reference to the triggering action |
246 reference to the triggering action |
249 </dd> |
247 </dd> |
250 </dl> |
248 </dl> |
251 <a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a> |
249 <a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a> |
252 <h4>BookmarksMenu.__removeBookmark</h4> |
250 <h4>BookmarksMenu.__removeBookmark</h4> |
253 <b>__removeBookmark</b>(<i>act</i>) |
251 <b>__removeBookmark</b>(<i>act</i>) |
254 |
|
255 <p> |
252 <p> |
256 Private slot to remove a bookmark. |
253 Private slot to remove a bookmark. |
257 </p> |
254 </p> |
|
255 |
258 <dl> |
256 <dl> |
259 |
257 |
260 <dt><i>act</i> (QAction)</dt> |
258 <dt><i>act</i> (QAction)</dt> |
261 <dd> |
259 <dd> |
262 reference to the triggering action |
260 reference to the triggering action |
263 </dd> |
261 </dd> |
264 </dl> |
262 </dl> |
265 <a NAME="BookmarksMenu.__updateVisitCount" ID="BookmarksMenu.__updateVisitCount"></a> |
263 <a NAME="BookmarksMenu.__updateVisitCount" ID="BookmarksMenu.__updateVisitCount"></a> |
266 <h4>BookmarksMenu.__updateVisitCount</h4> |
264 <h4>BookmarksMenu.__updateVisitCount</h4> |
267 <b>__updateVisitCount</b>(<i>idx</i>) |
265 <b>__updateVisitCount</b>(<i>idx</i>) |
268 |
|
269 <p> |
266 <p> |
270 Private method to update the visit count of a bookmark. |
267 Private method to update the visit count of a bookmark. |
271 </p> |
268 </p> |
|
269 |
272 <dl> |
270 <dl> |
273 |
271 |
274 <dt><i>idx</i> (QModelIndex)</dt> |
272 <dt><i>idx</i> (QModelIndex)</dt> |
275 <dd> |
273 <dd> |
276 index of the bookmark item |
274 index of the bookmark item |
277 </dd> |
275 </dd> |
278 </dl> |
276 </dl> |
279 <a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a> |
277 <a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a> |
280 <h4>BookmarksMenu.createBaseMenu</h4> |
278 <h4>BookmarksMenu.createBaseMenu</h4> |
281 <b>createBaseMenu</b>(<i></i>) |
279 <b>createBaseMenu</b>(<i></i>) |
282 |
|
283 <p> |
280 <p> |
284 Public method to get the menu that is used to populate sub menu's. |
281 Public method to get the menu that is used to populate sub menu's. |
285 </p> |
282 </p> |
|
283 |
286 <dl> |
284 <dl> |
287 <dt>Return:</dt> |
285 <dt>Return:</dt> |
288 <dd> |
286 <dd> |
289 reference to the menu |
287 reference to the menu |
290 </dd> |
288 </dd> |
296 </dd> |
294 </dd> |
297 </dl> |
295 </dl> |
298 <a NAME="BookmarksMenu.openAll" ID="BookmarksMenu.openAll"></a> |
296 <a NAME="BookmarksMenu.openAll" ID="BookmarksMenu.openAll"></a> |
299 <h4>BookmarksMenu.openAll</h4> |
297 <h4>BookmarksMenu.openAll</h4> |
300 <b>openAll</b>(<i>act</i>) |
298 <b>openAll</b>(<i>act</i>) |
301 |
|
302 <p> |
299 <p> |
303 Public slot to open all the menu's items. |
300 Public slot to open all the menu's items. |
304 </p> |
301 </p> |
|
302 |
305 <dl> |
303 <dl> |
306 |
304 |
307 <dt><i>act</i> (QAction)</dt> |
305 <dt><i>act</i> (QAction)</dt> |
308 <dd> |
306 <dd> |
309 reference to the action object |
307 reference to the action object |
310 </dd> |
308 </dd> |
311 </dl> |
309 </dl> |
312 <a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a> |
310 <a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a> |
313 <h4>BookmarksMenu.postPopulated</h4> |
311 <h4>BookmarksMenu.postPopulated</h4> |
314 <b>postPopulated</b>(<i></i>) |
312 <b>postPopulated</b>(<i></i>) |
315 |
|
316 <p> |
313 <p> |
317 Public method to add any actions after the tree. |
314 Public method to add any actions after the tree. |
318 </p> |
315 </p> |
|
316 |
319 <div align="right"><a href="#top">Up</a></div> |
317 <div align="right"><a href="#top">Up</a></div> |
320 <hr /> |
318 <hr /> |
321 <hr /> |
319 <hr /> |
322 <a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a> |
320 <a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a> |
323 <h2>BookmarksMenuBarMenu</h2> |
321 <h2>BookmarksMenuBarMenu</h2> |
324 |
|
325 <p> |
322 <p> |
326 Class implementing a dynamically populated menu for bookmarks. |
323 Class implementing a dynamically populated menu for bookmarks. |
327 </p> |
324 </p> |
|
325 |
328 <h3>Signals</h3> |
326 <h3>Signals</h3> |
329 <dl> |
327 <dl> |
330 |
328 |
331 <dt>openUrl(QUrl, str)</dt> |
329 <dt>openUrl(QUrl, str)</dt> |
332 <dd> |
330 <dd> |
369 <tr> |
365 <tr> |
370 <td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td> |
366 <td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td> |
371 <td>Public method to set the list of actions that should appear first in the menu.</td> |
367 <td>Public method to set the list of actions that should appear first in the menu.</td> |
372 </tr> |
368 </tr> |
373 </table> |
369 </table> |
|
370 |
374 <h3>Static Methods</h3> |
371 <h3>Static Methods</h3> |
375 |
372 <table> |
376 <table> |
373 <tr><td>None</td></tr> |
377 <tr><td>None</td></tr> |
374 </table> |
378 </table> |
375 |
379 |
376 |
380 <a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a> |
377 <a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a> |
381 <h4>BookmarksMenuBarMenu (Constructor)</h4> |
378 <h4>BookmarksMenuBarMenu (Constructor)</h4> |
382 <b>BookmarksMenuBarMenu</b>(<i>parent=None</i>) |
379 <b>BookmarksMenuBarMenu</b>(<i>parent=None</i>) |
383 |
|
384 <p> |
380 <p> |
385 Constructor |
381 Constructor |
386 </p> |
382 </p> |
|
383 |
387 <dl> |
384 <dl> |
388 |
385 |
389 <dt><i>parent</i> (QWidget)</dt> |
386 <dt><i>parent</i> (QWidget)</dt> |
390 <dd> |
387 <dd> |
391 reference to the parent widget |
388 reference to the parent widget |
392 </dd> |
389 </dd> |
393 </dl> |
390 </dl> |
394 <a NAME="BookmarksMenuBarMenu.__defaultBookmarkTriggered" ID="BookmarksMenuBarMenu.__defaultBookmarkTriggered"></a> |
391 <a NAME="BookmarksMenuBarMenu.__defaultBookmarkTriggered" ID="BookmarksMenuBarMenu.__defaultBookmarkTriggered"></a> |
395 <h4>BookmarksMenuBarMenu.__defaultBookmarkTriggered</h4> |
392 <h4>BookmarksMenuBarMenu.__defaultBookmarkTriggered</h4> |
396 <b>__defaultBookmarkTriggered</b>(<i>act</i>) |
393 <b>__defaultBookmarkTriggered</b>(<i>act</i>) |
397 |
|
398 <p> |
394 <p> |
399 Private slot handling the default bookmark menu entries. |
395 Private slot handling the default bookmark menu entries. |
400 </p> |
396 </p> |
|
397 |
401 <dl> |
398 <dl> |
402 |
399 |
403 <dt><i>act</i> (QAction)</dt> |
400 <dt><i>act</i> (QAction)</dt> |
404 <dd> |
401 <dd> |
405 reference to the action object |
402 reference to the action object |
406 </dd> |
403 </dd> |
407 </dl> |
404 </dl> |
408 <a NAME="BookmarksMenuBarMenu.postPopulated" ID="BookmarksMenuBarMenu.postPopulated"></a> |
405 <a NAME="BookmarksMenuBarMenu.postPopulated" ID="BookmarksMenuBarMenu.postPopulated"></a> |
409 <h4>BookmarksMenuBarMenu.postPopulated</h4> |
406 <h4>BookmarksMenuBarMenu.postPopulated</h4> |
410 <b>postPopulated</b>(<i></i>) |
407 <b>postPopulated</b>(<i></i>) |
411 |
|
412 <p> |
408 <p> |
413 Public method to add any actions after the tree. |
409 Public method to add any actions after the tree. |
414 </p> |
410 </p> |
|
411 |
415 <a NAME="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a> |
412 <a NAME="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a> |
416 <h4>BookmarksMenuBarMenu.prePopulated</h4> |
413 <h4>BookmarksMenuBarMenu.prePopulated</h4> |
417 <b>prePopulated</b>(<i></i>) |
414 <b>prePopulated</b>(<i></i>) |
418 |
|
419 <p> |
415 <p> |
420 Public method to add any actions before the tree. |
416 Public method to add any actions before the tree. |
421 </p> |
417 </p> |
|
418 |
422 <dl> |
419 <dl> |
423 <dt>Return:</dt> |
420 <dt>Return:</dt> |
424 <dd> |
421 <dd> |
425 flag indicating if any actions were added |
422 flag indicating if any actions were added |
426 </dd> |
423 </dd> |