|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.Bookmarks.BookmarksToolBar</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.BookmarksToolBar</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a tool bar showing bookmarks. |
|
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="#BookmarksToolBar">BookmarksToolBar</a></td> |
|
39 <td>Class implementing a tool bar showing bookmarks.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="BookmarksToolBar" ID="BookmarksToolBar"></a> |
|
50 <h2>BookmarksToolBar</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing a tool bar showing bookmarks. |
|
54 </p> |
|
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
|
58 <dt>newTab(QUrl, str)</dt> |
|
59 <dd> |
|
60 emitted to open a URL in a new tab |
|
61 </dd> |
|
62 <dt>newWindow(QUrl, str)</dt> |
|
63 <dd> |
|
64 emitted to open a URL in a new window |
|
65 </dd> |
|
66 <dt>openUrl(QUrl, str)</dt> |
|
67 <dd> |
|
68 emitted to open a URL in the current tab |
|
69 </dd> |
|
70 </dl> |
|
71 <h3>Derived from</h3> |
|
72 EricModelToolBar |
|
73 <h3>Class Attributes</h3> |
|
74 |
|
75 <table> |
|
76 <tr><td>None</td></tr> |
|
77 </table> |
|
78 <h3>Class Methods</h3> |
|
79 |
|
80 <table> |
|
81 <tr><td>None</td></tr> |
|
82 </table> |
|
83 <h3>Methods</h3> |
|
84 |
|
85 <table> |
|
86 |
|
87 <tr> |
|
88 <td><a href="#BookmarksToolBar.__init__">BookmarksToolBar</a></td> |
|
89 <td>Constructor</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#BookmarksToolBar.__bookmarkActivated">__bookmarkActivated</a></td> |
|
93 <td>Private slot handling the activation of a bookmark.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#BookmarksToolBar.__contextMenuRequested">__contextMenuRequested</a></td> |
|
97 <td>Private slot to handle the context menu request.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#BookmarksToolBar.__edit">__edit</a></td> |
|
101 <td>Private slot to edit a bookmarks properties.</td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td><a href="#BookmarksToolBar.__newBookmark">__newBookmark</a></td> |
|
105 <td>Private slot to add a new bookmark.</td> |
|
106 </tr> |
|
107 <tr> |
|
108 <td><a href="#BookmarksToolBar.__newFolder">__newFolder</a></td> |
|
109 <td>Private slot to add a new bookmarks folder.</td> |
|
110 </tr> |
|
111 <tr> |
|
112 <td><a href="#BookmarksToolBar.__openBookmark">__openBookmark</a></td> |
|
113 <td>Private slot to open a bookmark in the current browser tab.</td> |
|
114 </tr> |
|
115 <tr> |
|
116 <td><a href="#BookmarksToolBar.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td> |
|
117 <td>Private slot to open a bookmark in a new browser tab.</td> |
|
118 </tr> |
|
119 <tr> |
|
120 <td><a href="#BookmarksToolBar.__openBookmarkInNewWindow">__openBookmarkInNewWindow</a></td> |
|
121 <td>Private slot to open a bookmark in a new window.</td> |
|
122 </tr> |
|
123 <tr> |
|
124 <td><a href="#BookmarksToolBar.__openBookmarkInPrivateWindow">__openBookmarkInPrivateWindow</a></td> |
|
125 <td>Private slot to open a bookmark in a new private window.</td> |
|
126 </tr> |
|
127 <tr> |
|
128 <td><a href="#BookmarksToolBar.__rebuild">__rebuild</a></td> |
|
129 <td>Private slot to rebuild the toolbar.</td> |
|
130 </tr> |
|
131 <tr> |
|
132 <td><a href="#BookmarksToolBar.__removeBookmark">__removeBookmark</a></td> |
|
133 <td>Private slot to remove a bookmark.</td> |
|
134 </tr> |
|
135 <tr> |
|
136 <td><a href="#BookmarksToolBar.__updateVisitCount">__updateVisitCount</a></td> |
|
137 <td>Private method to update the visit count of a bookmark.</td> |
|
138 </tr> |
|
139 <tr> |
|
140 <td><a href="#BookmarksToolBar._createMenu">_createMenu</a></td> |
|
141 <td>Protected method to create the menu for a tool bar action.</td> |
|
142 </tr> |
|
143 </table> |
|
144 <h3>Static Methods</h3> |
|
145 |
|
146 <table> |
|
147 <tr><td>None</td></tr> |
|
148 </table> |
|
149 |
|
150 <a NAME="BookmarksToolBar.__init__" ID="BookmarksToolBar.__init__"></a> |
|
151 <h4>BookmarksToolBar (Constructor)</h4> |
|
152 <b>BookmarksToolBar</b>(<i>mainWindow, model, parent=None</i>) |
|
153 |
|
154 <p> |
|
155 Constructor |
|
156 </p> |
|
157 <dl> |
|
158 |
|
159 <dt><i>mainWindow</i></dt> |
|
160 <dd> |
|
161 reference to the main window (WebBrowserWindow) |
|
162 </dd> |
|
163 <dt><i>model</i></dt> |
|
164 <dd> |
|
165 reference to the bookmarks model (BookmarksModel) |
|
166 </dd> |
|
167 <dt><i>parent</i></dt> |
|
168 <dd> |
|
169 reference to the parent widget (QWidget) |
|
170 </dd> |
|
171 </dl> |
|
172 <a NAME="BookmarksToolBar.__bookmarkActivated" ID="BookmarksToolBar.__bookmarkActivated"></a> |
|
173 <h4>BookmarksToolBar.__bookmarkActivated</h4> |
|
174 <b>__bookmarkActivated</b>(<i>idx</i>) |
|
175 |
|
176 <p> |
|
177 Private slot handling the activation of a bookmark. |
|
178 </p> |
|
179 <dl> |
|
180 |
|
181 <dt><i>idx</i></dt> |
|
182 <dd> |
|
183 index of the activated bookmark (QModelIndex) |
|
184 </dd> |
|
185 </dl> |
|
186 <a NAME="BookmarksToolBar.__contextMenuRequested" ID="BookmarksToolBar.__contextMenuRequested"></a> |
|
187 <h4>BookmarksToolBar.__contextMenuRequested</h4> |
|
188 <b>__contextMenuRequested</b>(<i>pos</i>) |
|
189 |
|
190 <p> |
|
191 Private slot to handle the context menu request. |
|
192 </p> |
|
193 <dl> |
|
194 |
|
195 <dt><i>pos</i></dt> |
|
196 <dd> |
|
197 position the context menu shall be shown (QPoint) |
|
198 </dd> |
|
199 </dl> |
|
200 <a NAME="BookmarksToolBar.__edit" ID="BookmarksToolBar.__edit"></a> |
|
201 <h4>BookmarksToolBar.__edit</h4> |
|
202 <b>__edit</b>(<i>act</i>) |
|
203 |
|
204 <p> |
|
205 Private slot to edit a bookmarks properties. |
|
206 </p> |
|
207 <dl> |
|
208 |
|
209 <dt><i>act</i> (QAction)</dt> |
|
210 <dd> |
|
211 reference to the triggering action |
|
212 </dd> |
|
213 </dl> |
|
214 <a NAME="BookmarksToolBar.__newBookmark" ID="BookmarksToolBar.__newBookmark"></a> |
|
215 <h4>BookmarksToolBar.__newBookmark</h4> |
|
216 <b>__newBookmark</b>(<i></i>) |
|
217 |
|
218 <p> |
|
219 Private slot to add a new bookmark. |
|
220 </p> |
|
221 <a NAME="BookmarksToolBar.__newFolder" ID="BookmarksToolBar.__newFolder"></a> |
|
222 <h4>BookmarksToolBar.__newFolder</h4> |
|
223 <b>__newFolder</b>(<i></i>) |
|
224 |
|
225 <p> |
|
226 Private slot to add a new bookmarks folder. |
|
227 </p> |
|
228 <a NAME="BookmarksToolBar.__openBookmark" ID="BookmarksToolBar.__openBookmark"></a> |
|
229 <h4>BookmarksToolBar.__openBookmark</h4> |
|
230 <b>__openBookmark</b>(<i>act</i>) |
|
231 |
|
232 <p> |
|
233 Private slot to open a bookmark in the current browser tab. |
|
234 </p> |
|
235 <dl> |
|
236 |
|
237 <dt><i>act</i> (QAction)</dt> |
|
238 <dd> |
|
239 reference to the triggering action |
|
240 </dd> |
|
241 </dl> |
|
242 <a NAME="BookmarksToolBar.__openBookmarkInNewTab" ID="BookmarksToolBar.__openBookmarkInNewTab"></a> |
|
243 <h4>BookmarksToolBar.__openBookmarkInNewTab</h4> |
|
244 <b>__openBookmarkInNewTab</b>(<i>act</i>) |
|
245 |
|
246 <p> |
|
247 Private slot to open a bookmark in a new browser tab. |
|
248 </p> |
|
249 <dl> |
|
250 |
|
251 <dt><i>act</i> (QAction)</dt> |
|
252 <dd> |
|
253 reference to the triggering action |
|
254 </dd> |
|
255 </dl> |
|
256 <a NAME="BookmarksToolBar.__openBookmarkInNewWindow" ID="BookmarksToolBar.__openBookmarkInNewWindow"></a> |
|
257 <h4>BookmarksToolBar.__openBookmarkInNewWindow</h4> |
|
258 <b>__openBookmarkInNewWindow</b>(<i>act</i>) |
|
259 |
|
260 <p> |
|
261 Private slot to open a bookmark in a new window. |
|
262 </p> |
|
263 <dl> |
|
264 |
|
265 <dt><i>act</i> (QAction)</dt> |
|
266 <dd> |
|
267 reference to the triggering action |
|
268 </dd> |
|
269 </dl> |
|
270 <a NAME="BookmarksToolBar.__openBookmarkInPrivateWindow" ID="BookmarksToolBar.__openBookmarkInPrivateWindow"></a> |
|
271 <h4>BookmarksToolBar.__openBookmarkInPrivateWindow</h4> |
|
272 <b>__openBookmarkInPrivateWindow</b>(<i>act</i>) |
|
273 |
|
274 <p> |
|
275 Private slot to open a bookmark in a new private window. |
|
276 </p> |
|
277 <dl> |
|
278 |
|
279 <dt><i>act</i> (QAction)</dt> |
|
280 <dd> |
|
281 reference to the triggering action |
|
282 </dd> |
|
283 </dl> |
|
284 <a NAME="BookmarksToolBar.__rebuild" ID="BookmarksToolBar.__rebuild"></a> |
|
285 <h4>BookmarksToolBar.__rebuild</h4> |
|
286 <b>__rebuild</b>(<i></i>) |
|
287 |
|
288 <p> |
|
289 Private slot to rebuild the toolbar. |
|
290 </p> |
|
291 <a NAME="BookmarksToolBar.__removeBookmark" ID="BookmarksToolBar.__removeBookmark"></a> |
|
292 <h4>BookmarksToolBar.__removeBookmark</h4> |
|
293 <b>__removeBookmark</b>(<i>act</i>) |
|
294 |
|
295 <p> |
|
296 Private slot to remove a bookmark. |
|
297 </p> |
|
298 <dl> |
|
299 |
|
300 <dt><i>act</i> (QAction)</dt> |
|
301 <dd> |
|
302 reference to the triggering action |
|
303 </dd> |
|
304 </dl> |
|
305 <a NAME="BookmarksToolBar.__updateVisitCount" ID="BookmarksToolBar.__updateVisitCount"></a> |
|
306 <h4>BookmarksToolBar.__updateVisitCount</h4> |
|
307 <b>__updateVisitCount</b>(<i>idx</i>) |
|
308 |
|
309 <p> |
|
310 Private method to update the visit count of a bookmark. |
|
311 </p> |
|
312 <dl> |
|
313 |
|
314 <dt><i>idx</i></dt> |
|
315 <dd> |
|
316 index of the bookmark item (QModelIndex) |
|
317 </dd> |
|
318 </dl> |
|
319 <a NAME="BookmarksToolBar._createMenu" ID="BookmarksToolBar._createMenu"></a> |
|
320 <h4>BookmarksToolBar._createMenu</h4> |
|
321 <b>_createMenu</b>(<i></i>) |
|
322 |
|
323 <p> |
|
324 Protected method to create the menu for a tool bar action. |
|
325 </p> |
|
326 <dl> |
|
327 <dt>Return:</dt> |
|
328 <dd> |
|
329 menu for a tool bar action (EricModelMenu) |
|
330 </dd> |
|
331 </dl> |
|
332 <div align="right"><a href="#top">Up</a></div> |
|
333 <hr /> |
|
334 </body></html> |