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