eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksDialog.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.BookmarksDialog</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.BookmarksDialog</h1>
24
25 <p>
26 Module implementing a dialog to manage 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="#BookmarksDialog">BookmarksDialog</a></td>
39 <td>Class implementing a dialog to manage 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="BookmarksDialog" ID="BookmarksDialog"></a>
50 <h2>BookmarksDialog</h2>
51
52 <p>
53 Class implementing a dialog to manage bookmarks.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>newBackgroundTab(QUrl, str)</dt>
59 <dd>
60 emitted to open a URL in a new
61 background tab
62 </dd>
63 <dt>newTab(QUrl, str)</dt>
64 <dd>
65 emitted to open a URL in a new tab
66 </dd>
67 <dt>newWindow(QUrl, str)</dt>
68 <dd>
69 emitted to open a URL in a new window
70 </dd>
71 <dt>openUrl(QUrl, str)</dt>
72 <dd>
73 emitted to open a URL in the current tab
74 </dd>
75 </dl>
76 <h3>Derived from</h3>
77 QDialog, Ui_BookmarksDialog
78 <h3>Class Attributes</h3>
79
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83 <h3>Class Methods</h3>
84
85 <table>
86 <tr><td>None</td></tr>
87 </table>
88 <h3>Methods</h3>
89
90 <table>
91
92 <tr>
93 <td><a href="#BookmarksDialog.__init__">BookmarksDialog</a></td>
94 <td>Constructor</td>
95 </tr>
96 <tr>
97 <td><a href="#BookmarksDialog.__activated">__activated</a></td>
98 <td>Private slot to handle the activation of an entry.</td>
99 </tr>
100 <tr>
101 <td><a href="#BookmarksDialog.__customContextMenuRequested">__customContextMenuRequested</a></td>
102 <td>Private slot to handle the context menu request for the bookmarks tree.</td>
103 </tr>
104 <tr>
105 <td><a href="#BookmarksDialog.__edit">__edit</a></td>
106 <td>Private slot to edit a bookmarks properties.</td>
107 </tr>
108 <tr>
109 <td><a href="#BookmarksDialog.__editAddress">__editAddress</a></td>
110 <td>Private slot to edit the address part of a bookmark.</td>
111 </tr>
112 <tr>
113 <td><a href="#BookmarksDialog.__editName">__editName</a></td>
114 <td>Private slot to edit the name part of a bookmark.</td>
115 </tr>
116 <tr>
117 <td><a href="#BookmarksDialog.__expandNodes">__expandNodes</a></td>
118 <td>Private method to expand all child nodes of a node.</td>
119 </tr>
120 <tr>
121 <td><a href="#BookmarksDialog.__newFolder">__newFolder</a></td>
122 <td>Private slot to add a new bookmarks folder.</td>
123 </tr>
124 <tr>
125 <td><a href="#BookmarksDialog.__openBookmark">__openBookmark</a></td>
126 <td>Private method to open a bookmark.</td>
127 </tr>
128 <tr>
129 <td><a href="#BookmarksDialog.__openBookmarkInCurrentTab">__openBookmarkInCurrentTab</a></td>
130 <td>Private slot to open a bookmark in the current browser tab.</td>
131 </tr>
132 <tr>
133 <td><a href="#BookmarksDialog.__openBookmarkInNewBackgroundTab">__openBookmarkInNewBackgroundTab</a></td>
134 <td>Private slot to open a bookmark in a new browser tab.</td>
135 </tr>
136 <tr>
137 <td><a href="#BookmarksDialog.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td>
138 <td>Private slot to open a bookmark in a new browser tab.</td>
139 </tr>
140 <tr>
141 <td><a href="#BookmarksDialog.__openBookmarkInNewWindow">__openBookmarkInNewWindow</a></td>
142 <td>Private slot to open a bookmark in a new browser window.</td>
143 </tr>
144 <tr>
145 <td><a href="#BookmarksDialog.__openBookmarkInPrivateWindow">__openBookmarkInPrivateWindow</a></td>
146 <td>Private slot to open a bookmark in a new private browser window.</td>
147 </tr>
148 <tr>
149 <td><a href="#BookmarksDialog.__saveExpandedNodes">__saveExpandedNodes</a></td>
150 <td>Private method to save the child nodes of an expanded node.</td>
151 </tr>
152 <tr>
153 <td><a href="#BookmarksDialog.__shutdown">__shutdown</a></td>
154 <td>Private method to perform shutdown actions for the dialog.</td>
155 </tr>
156 <tr>
157 <td><a href="#BookmarksDialog.closeEvent">closeEvent</a></td>
158 <td>Protected method to handle the closing of the dialog.</td>
159 </tr>
160 <tr>
161 <td><a href="#BookmarksDialog.reject">reject</a></td>
162 <td>Public method called when the dialog is rejected.</td>
163 </tr>
164 </table>
165 <h3>Static Methods</h3>
166
167 <table>
168 <tr><td>None</td></tr>
169 </table>
170
171 <a NAME="BookmarksDialog.__init__" ID="BookmarksDialog.__init__"></a>
172 <h4>BookmarksDialog (Constructor)</h4>
173 <b>BookmarksDialog</b>(<i>parent=None, manager=None</i>)
174
175 <p>
176 Constructor
177 </p>
178 <dl>
179
180 <dt><i>parent</i></dt>
181 <dd>
182 reference to the parent widget (QWidget
183 </dd>
184 <dt><i>manager</i></dt>
185 <dd>
186 reference to the bookmarks manager object
187 (BookmarksManager)
188 </dd>
189 </dl>
190 <a NAME="BookmarksDialog.__activated" ID="BookmarksDialog.__activated"></a>
191 <h4>BookmarksDialog.__activated</h4>
192 <b>__activated</b>(<i>idx</i>)
193
194 <p>
195 Private slot to handle the activation of an entry.
196 </p>
197 <dl>
198
199 <dt><i>idx</i></dt>
200 <dd>
201 reference to the entry index (QModelIndex)
202 </dd>
203 </dl>
204 <a NAME="BookmarksDialog.__customContextMenuRequested" ID="BookmarksDialog.__customContextMenuRequested"></a>
205 <h4>BookmarksDialog.__customContextMenuRequested</h4>
206 <b>__customContextMenuRequested</b>(<i>pos</i>)
207
208 <p>
209 Private slot to handle the context menu request for the bookmarks tree.
210 </p>
211 <dl>
212
213 <dt><i>pos</i></dt>
214 <dd>
215 position the context menu was requested (QPoint)
216 </dd>
217 </dl>
218 <a NAME="BookmarksDialog.__edit" ID="BookmarksDialog.__edit"></a>
219 <h4>BookmarksDialog.__edit</h4>
220 <b>__edit</b>(<i></i>)
221
222 <p>
223 Private slot to edit a bookmarks properties.
224 </p>
225 <a NAME="BookmarksDialog.__editAddress" ID="BookmarksDialog.__editAddress"></a>
226 <h4>BookmarksDialog.__editAddress</h4>
227 <b>__editAddress</b>(<i></i>)
228
229 <p>
230 Private slot to edit the address part of a bookmark.
231 </p>
232 <a NAME="BookmarksDialog.__editName" ID="BookmarksDialog.__editName"></a>
233 <h4>BookmarksDialog.__editName</h4>
234 <b>__editName</b>(<i></i>)
235
236 <p>
237 Private slot to edit the name part of a bookmark.
238 </p>
239 <a NAME="BookmarksDialog.__expandNodes" ID="BookmarksDialog.__expandNodes"></a>
240 <h4>BookmarksDialog.__expandNodes</h4>
241 <b>__expandNodes</b>(<i>node</i>)
242
243 <p>
244 Private method to expand all child nodes of a node.
245 </p>
246 <dl>
247
248 <dt><i>node</i></dt>
249 <dd>
250 reference to the bookmark node to expand (BookmarkNode)
251 </dd>
252 </dl>
253 <a NAME="BookmarksDialog.__newFolder" ID="BookmarksDialog.__newFolder"></a>
254 <h4>BookmarksDialog.__newFolder</h4>
255 <b>__newFolder</b>(<i></i>)
256
257 <p>
258 Private slot to add a new bookmarks folder.
259 </p>
260 <a NAME="BookmarksDialog.__openBookmark" ID="BookmarksDialog.__openBookmark"></a>
261 <h4>BookmarksDialog.__openBookmark</h4>
262 <b>__openBookmark</b>(<i>newTab=False, newWindow=False, privateWindow=False, background=False</i>)
263
264 <p>
265 Private method to open a bookmark.
266 </p>
267 <dl>
268
269 <dt><i>newTab</i> (bool)</dt>
270 <dd>
271 flag indicating to open the bookmark in a new tab
272 </dd>
273 <dt><i>newWindow</i> (bool)</dt>
274 <dd>
275 flag indicating to open the bookmark in a new window
276 </dd>
277 <dt><i>privateWindow</i> (bool)</dt>
278 <dd>
279 flag indicating to open the bookmark in a new
280 private window
281 </dd>
282 <dt><i>background</i> (bool)</dt>
283 <dd>
284 flag indicating to open the bookmark in a new
285 background tab
286 </dd>
287 </dl>
288 <a NAME="BookmarksDialog.__openBookmarkInCurrentTab" ID="BookmarksDialog.__openBookmarkInCurrentTab"></a>
289 <h4>BookmarksDialog.__openBookmarkInCurrentTab</h4>
290 <b>__openBookmarkInCurrentTab</b>(<i></i>)
291
292 <p>
293 Private slot to open a bookmark in the current browser tab.
294 </p>
295 <a NAME="BookmarksDialog.__openBookmarkInNewBackgroundTab" ID="BookmarksDialog.__openBookmarkInNewBackgroundTab"></a>
296 <h4>BookmarksDialog.__openBookmarkInNewBackgroundTab</h4>
297 <b>__openBookmarkInNewBackgroundTab</b>(<i></i>)
298
299 <p>
300 Private slot to open a bookmark in a new browser tab.
301 </p>
302 <a NAME="BookmarksDialog.__openBookmarkInNewTab" ID="BookmarksDialog.__openBookmarkInNewTab"></a>
303 <h4>BookmarksDialog.__openBookmarkInNewTab</h4>
304 <b>__openBookmarkInNewTab</b>(<i></i>)
305
306 <p>
307 Private slot to open a bookmark in a new browser tab.
308 </p>
309 <a NAME="BookmarksDialog.__openBookmarkInNewWindow" ID="BookmarksDialog.__openBookmarkInNewWindow"></a>
310 <h4>BookmarksDialog.__openBookmarkInNewWindow</h4>
311 <b>__openBookmarkInNewWindow</b>(<i></i>)
312
313 <p>
314 Private slot to open a bookmark in a new browser window.
315 </p>
316 <a NAME="BookmarksDialog.__openBookmarkInPrivateWindow" ID="BookmarksDialog.__openBookmarkInPrivateWindow"></a>
317 <h4>BookmarksDialog.__openBookmarkInPrivateWindow</h4>
318 <b>__openBookmarkInPrivateWindow</b>(<i></i>)
319
320 <p>
321 Private slot to open a bookmark in a new private browser window.
322 </p>
323 <a NAME="BookmarksDialog.__saveExpandedNodes" ID="BookmarksDialog.__saveExpandedNodes"></a>
324 <h4>BookmarksDialog.__saveExpandedNodes</h4>
325 <b>__saveExpandedNodes</b>(<i>parent</i>)
326
327 <p>
328 Private method to save the child nodes of an expanded node.
329 </p>
330 <dl>
331
332 <dt><i>parent</i></dt>
333 <dd>
334 index of the parent node (QModelIndex)
335 </dd>
336 </dl>
337 <dl>
338 <dt>Return:</dt>
339 <dd>
340 flag indicating a change (boolean)
341 </dd>
342 </dl>
343 <a NAME="BookmarksDialog.__shutdown" ID="BookmarksDialog.__shutdown"></a>
344 <h4>BookmarksDialog.__shutdown</h4>
345 <b>__shutdown</b>(<i></i>)
346
347 <p>
348 Private method to perform shutdown actions for the dialog.
349 </p>
350 <a NAME="BookmarksDialog.closeEvent" ID="BookmarksDialog.closeEvent"></a>
351 <h4>BookmarksDialog.closeEvent</h4>
352 <b>closeEvent</b>(<i>evt</i>)
353
354 <p>
355 Protected method to handle the closing of the dialog.
356 </p>
357 <dl>
358
359 <dt><i>evt</i></dt>
360 <dd>
361 reference to the event object (QCloseEvent) (ignored)
362 </dd>
363 </dl>
364 <a NAME="BookmarksDialog.reject" ID="BookmarksDialog.reject"></a>
365 <h4>BookmarksDialog.reject</h4>
366 <b>reject</b>(<i></i>)
367
368 <p>
369 Public method called when the dialog is rejected.
370 </p>
371 <div align="right"><a href="#top">Up</a></div>
372 <hr />
373 </body></html>

eric ide

mercurial