Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.BookmarksMenu.html

changeset 6942
2602857055c5
parent 6123
39cd368143db
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Bookmarks.BookmarksMenu</h1>
23 <p>
24 Module implementing the bookmarks menu.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#BookmarksMenu">BookmarksMenu</a></td>
34 <td>Class implementing the bookmarks menu base class.</td>
35 </tr><tr>
36 <td><a href="#BookmarksMenuBarMenu">BookmarksMenuBarMenu</a></td>
37 <td>Class implementing a dynamically populated menu for bookmarks.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="BookmarksMenu" ID="BookmarksMenu"></a>
46 <h2>BookmarksMenu</h2>
47 <p>
48 Class implementing the bookmarks menu base class.
49 </p><h3>Signals</h3>
50 <dl>
51 <dt>newTab(QUrl, str)</dt>
52 <dd>
53 emitted to open a URL with the given title in a
54 new tab
55 </dd><dt>newWindow(QUrl, str)</dt>
56 <dd>
57 emitted to open a URL with the given title in
58 a new window
59 </dd><dt>openUrl(QUrl, str)</dt>
60 <dd>
61 emitted to open a URL with the given title in
62 the current tab
63 </dd>
64 </dl>
65 <h3>Derived from</h3>
66 E5ModelMenu
67 <h3>Class Attributes</h3>
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Class Methods</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76 <table>
77 <tr>
78 <td><a href="#BookmarksMenu.__init__">BookmarksMenu</a></td>
79 <td>Constructor</td>
80 </tr><tr>
81 <td><a href="#BookmarksMenu.__activated">__activated</a></td>
82 <td>Private slot handling the activated signal.</td>
83 </tr><tr>
84 <td><a href="#BookmarksMenu.__contextMenuRequested">__contextMenuRequested</a></td>
85 <td>Private slot to handle the context menu request.</td>
86 </tr><tr>
87 <td><a href="#BookmarksMenu.__edit">__edit</a></td>
88 <td>Private slot to edit a bookmarks properties.</td>
89 </tr><tr>
90 <td><a href="#BookmarksMenu.__openBookmark">__openBookmark</a></td>
91 <td>Private slot to open a bookmark in the current browser tab.</td>
92 </tr><tr>
93 <td><a href="#BookmarksMenu.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td>
94 <td>Private slot to open a bookmark in a new browser tab.</td>
95 </tr><tr>
96 <td><a href="#BookmarksMenu.__openBookmarkInNewWindow">__openBookmarkInNewWindow</a></td>
97 <td>Private slot to open a bookmark in a new window.</td>
98 </tr><tr>
99 <td><a href="#BookmarksMenu.__openBookmarkInPrivateWindow">__openBookmarkInPrivateWindow</a></td>
100 <td>Private slot to open a bookmark in a new private window.</td>
101 </tr><tr>
102 <td><a href="#BookmarksMenu.__removeBookmark">__removeBookmark</a></td>
103 <td>Private slot to remove a bookmark.</td>
104 </tr><tr>
105 <td><a href="#BookmarksMenu.__updateVisitCount">__updateVisitCount</a></td>
106 <td>Private method to update the visit count of a bookmark.</td>
107 </tr><tr>
108 <td><a href="#BookmarksMenu.createBaseMenu">createBaseMenu</a></td>
109 <td>Public method to get the menu that is used to populate sub menu's.</td>
110 </tr><tr>
111 <td><a href="#BookmarksMenu.openAll">openAll</a></td>
112 <td>Public slot to open all the menu's items.</td>
113 </tr><tr>
114 <td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td>
115 <td>Public method to add any actions after the tree.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122 <a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a>
123 <h4>BookmarksMenu (Constructor)</h4>
124 <b>BookmarksMenu</b>(<i>parent=None</i>)
125 <p>
126 Constructor
127 </p><dl>
128 <dt><i>parent</i></dt>
129 <dd>
130 reference to the parent widget (QWidget)
131 </dd>
132 </dl><a NAME="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a>
133 <h4>BookmarksMenu.__activated</h4>
134 <b>__activated</b>(<i>idx</i>)
135 <p>
136 Private slot handling the activated signal.
137 </p><dl>
138 <dt><i>idx</i></dt>
139 <dd>
140 index of the activated item (QModelIndex)
141 </dd>
142 </dl><a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a>
143 <h4>BookmarksMenu.__contextMenuRequested</h4>
144 <b>__contextMenuRequested</b>(<i>pos</i>)
145 <p>
146 Private slot to handle the context menu request.
147 </p><dl>
148 <dt><i>pos</i></dt>
149 <dd>
150 position the context menu shall be shown (QPoint)
151 </dd>
152 </dl><a NAME="BookmarksMenu.__edit" ID="BookmarksMenu.__edit"></a>
153 <h4>BookmarksMenu.__edit</h4>
154 <b>__edit</b>(<i>act</i>)
155 <p>
156 Private slot to edit a bookmarks properties.
157 </p><dl>
158 <dt><i>act</i> (QAction)</dt>
159 <dd>
160 reference to the triggering action
161 </dd>
162 </dl><a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a>
163 <h4>BookmarksMenu.__openBookmark</h4>
164 <b>__openBookmark</b>(<i>act</i>)
165 <p>
166 Private slot to open a bookmark in the current browser tab.
167 </p><dl>
168 <dt><i>act</i> (QAction)</dt>
169 <dd>
170 reference to the triggering action
171 </dd>
172 </dl><a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a>
173 <h4>BookmarksMenu.__openBookmarkInNewTab</h4>
174 <b>__openBookmarkInNewTab</b>(<i>act</i>)
175 <p>
176 Private slot to open a bookmark in a new browser tab.
177 </p><dl>
178 <dt><i>act</i> (QAction)</dt>
179 <dd>
180 reference to the triggering action
181 </dd>
182 </dl><a NAME="BookmarksMenu.__openBookmarkInNewWindow" ID="BookmarksMenu.__openBookmarkInNewWindow"></a>
183 <h4>BookmarksMenu.__openBookmarkInNewWindow</h4>
184 <b>__openBookmarkInNewWindow</b>(<i>act</i>)
185 <p>
186 Private slot to open a bookmark in a new window.
187 </p><dl>
188 <dt><i>act</i> (QAction)</dt>
189 <dd>
190 reference to the triggering action
191 </dd>
192 </dl><a NAME="BookmarksMenu.__openBookmarkInPrivateWindow" ID="BookmarksMenu.__openBookmarkInPrivateWindow"></a>
193 <h4>BookmarksMenu.__openBookmarkInPrivateWindow</h4>
194 <b>__openBookmarkInPrivateWindow</b>(<i>act</i>)
195 <p>
196 Private slot to open a bookmark in a new private window.
197 </p><dl>
198 <dt><i>act</i> (QAction)</dt>
199 <dd>
200 reference to the triggering action
201 </dd>
202 </dl><a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a>
203 <h4>BookmarksMenu.__removeBookmark</h4>
204 <b>__removeBookmark</b>(<i>act</i>)
205 <p>
206 Private slot to remove a bookmark.
207 </p><dl>
208 <dt><i>act</i> (QAction)</dt>
209 <dd>
210 reference to the triggering action
211 </dd>
212 </dl><a NAME="BookmarksMenu.__updateVisitCount" ID="BookmarksMenu.__updateVisitCount"></a>
213 <h4>BookmarksMenu.__updateVisitCount</h4>
214 <b>__updateVisitCount</b>(<i>idx</i>)
215 <p>
216 Private method to update the visit count of a bookmark.
217 </p><dl>
218 <dt><i>idx</i></dt>
219 <dd>
220 index of the bookmark item (QModelIndex)
221 </dd>
222 </dl><a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a>
223 <h4>BookmarksMenu.createBaseMenu</h4>
224 <b>createBaseMenu</b>(<i></i>)
225 <p>
226 Public method to get the menu that is used to populate sub menu's.
227 </p><dl>
228 <dt>Returns:</dt>
229 <dd>
230 reference to the menu (BookmarksMenu)
231 </dd>
232 </dl><a NAME="BookmarksMenu.openAll" ID="BookmarksMenu.openAll"></a>
233 <h4>BookmarksMenu.openAll</h4>
234 <b>openAll</b>(<i>act</i>)
235 <p>
236 Public slot to open all the menu's items.
237 </p><dl>
238 <dt><i>act</i> (QAction)</dt>
239 <dd>
240 reference to the action object
241 </dd>
242 </dl><a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a>
243 <h4>BookmarksMenu.postPopulated</h4>
244 <b>postPopulated</b>(<i></i>)
245 <p>
246 Public method to add any actions after the tree.
247 </p>
248 <div align="right"><a href="#top">Up</a></div>
249 <hr /><hr />
250 <a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a>
251 <h2>BookmarksMenuBarMenu</h2>
252 <p>
253 Class implementing a dynamically populated menu for bookmarks.
254 </p><h3>Signals</h3>
255 <dl>
256 <dt>openUrl(QUrl, str)</dt>
257 <dd>
258 emitted to open a URL with the given title in
259 the current tab
260 </dd>
261 </dl>
262 <h3>Derived from</h3>
263 BookmarksMenu
264 <h3>Class Attributes</h3>
265 <table>
266 <tr><td>None</td></tr>
267 </table>
268 <h3>Class Methods</h3>
269 <table>
270 <tr><td>None</td></tr>
271 </table>
272 <h3>Methods</h3>
273 <table>
274 <tr>
275 <td><a href="#BookmarksMenuBarMenu.__init__">BookmarksMenuBarMenu</a></td>
276 <td>Constructor</td>
277 </tr><tr>
278 <td><a href="#BookmarksMenuBarMenu.__defaultBookmarkTriggered">__defaultBookmarkTriggered</a></td>
279 <td>Private slot handling the default bookmark menu entries.</td>
280 </tr><tr>
281 <td><a href="#BookmarksMenuBarMenu.postPopulated">postPopulated</a></td>
282 <td>Public method to add any actions after the tree.</td>
283 </tr><tr>
284 <td><a href="#BookmarksMenuBarMenu.prePopulated">prePopulated</a></td>
285 <td>Public method to add any actions before the tree.</td>
286 </tr><tr>
287 <td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td>
288 <td>Public method to set the list of actions that should appear first in the menu.</td>
289 </tr>
290 </table>
291 <h3>Static Methods</h3>
292 <table>
293 <tr><td>None</td></tr>
294 </table>
295 <a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a>
296 <h4>BookmarksMenuBarMenu (Constructor)</h4>
297 <b>BookmarksMenuBarMenu</b>(<i>parent=None</i>)
298 <p>
299 Constructor
300 </p><dl>
301 <dt><i>parent</i></dt>
302 <dd>
303 reference to the parent widget (QWidget)
304 </dd>
305 </dl><a NAME="BookmarksMenuBarMenu.__defaultBookmarkTriggered" ID="BookmarksMenuBarMenu.__defaultBookmarkTriggered"></a>
306 <h4>BookmarksMenuBarMenu.__defaultBookmarkTriggered</h4>
307 <b>__defaultBookmarkTriggered</b>(<i>act</i>)
308 <p>
309 Private slot handling the default bookmark menu entries.
310 </p><dl>
311 <dt><i>act</i> (QAction)</dt>
312 <dd>
313 reference to the action object
314 </dd>
315 </dl><a NAME="BookmarksMenuBarMenu.postPopulated" ID="BookmarksMenuBarMenu.postPopulated"></a>
316 <h4>BookmarksMenuBarMenu.postPopulated</h4>
317 <b>postPopulated</b>(<i></i>)
318 <p>
319 Public method to add any actions after the tree.
320 </p><a NAME="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a>
321 <h4>BookmarksMenuBarMenu.prePopulated</h4>
322 <b>prePopulated</b>(<i></i>)
323 <p>
324 Public method to add any actions before the tree.
325 </p><dl>
326 <dt>Returns:</dt>
327 <dd>
328 flag indicating if any actions were added (boolean)
329 </dd>
330 </dl><a NAME="BookmarksMenuBarMenu.setInitialActions" ID="BookmarksMenuBarMenu.setInitialActions"></a>
331 <h4>BookmarksMenuBarMenu.setInitialActions</h4>
332 <b>setInitialActions</b>(<i>actions</i>)
333 <p>
334 Public method to set the list of actions that should appear first in
335 the menu.
336 </p><dl>
337 <dt><i>actions</i></dt>
338 <dd>
339 list of initial actions (list of QAction)
340 </dd>
341 </dl>
342 <div align="right"><a href="#top">Up</a></div>
343 <hr />
344 </body></html>

Mercurial Repository: eric

eric ide

mercurial