Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.WebBrowser.TabManager.TabManagerWidget.html

src/eric7/Documentation/Source/eric7.WebBrowser.TabManager.TabManagerWidget.html

branch
eric7
changeset 10479
856476537696
parent 10070
9f5758c0fec1
child 10493
f795d68d8e09
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
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.TabManager.TabManagerWidget</h1> 9 <h1>eric7.WebBrowser.TabManager.TabManagerWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a window for managing the web browser tabs. 11 Module implementing a window for managing the web browser tabs.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#TabManagerWidget">TabManagerWidget</a></td> 22 <td><a href="#TabManagerWidget">TabManagerWidget</a></td>
25 <td>Class implementing a window for managing the web browser tabs.</td> 23 <td>Class implementing a window for managing the web browser tabs.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="TabManagerWidget" ID="TabManagerWidget"></a> 34 <a NAME="TabManagerWidget" ID="TabManagerWidget"></a>
36 <h2>TabManagerWidget</h2> 35 <h2>TabManagerWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a window for managing the web browser tabs. 37 Class implementing a window for managing the web browser tabs.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>groupTypeChanged(int)</dt> 43 <dt>groupTypeChanged(int)</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QWidget 49 QWidget
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>GroupByDomain</td></tr>
54 <tr><td>GroupByDomain</td></tr><tr><td>GroupByHost</td></tr><tr><td>GroupByWindow</td></tr><tr><td>WebBrowserRole</td></tr><tr><td>WebWindowRole</td></tr><tr><td>_tldExtractor</td></tr> 53 <tr><td>GroupByHost</td></tr>
55 </table> 54 <tr><td>GroupByWindow</td></tr>
55 <tr><td>WebBrowserRole</td></tr>
56 <tr><td>WebWindowRole</td></tr>
57 <tr><td>_tldExtractor</td></tr>
58 </table>
59
56 <h3>Class Methods</h3> 60 <h3>Class Methods</h3>
57
58 <table> 61 <table>
59 <tr><td>None</td></tr> 62 <tr><td>None</td></tr>
60 </table> 63 </table>
64
61 <h3>Methods</h3> 65 <h3>Methods</h3>
62 66 <table>
63 <table>
64
65 <tr> 67 <tr>
66 <td><a href="#TabManagerWidget.__init__">TabManagerWidget</a></td> 68 <td><a href="#TabManagerWidget.__init__">TabManagerWidget</a></td>
67 <td>Constructor</td> 69 <td>Constructor</td>
68 </tr> 70 </tr>
69 <tr> 71 <tr>
137 <tr> 139 <tr>
138 <td><a href="#TabManagerWidget.raiseTabManager">raiseTabManager</a></td> 140 <td><a href="#TabManagerWidget.raiseTabManager">raiseTabManager</a></td>
139 <td>Public slot to show the tab manager.</td> 141 <td>Public slot to show the tab manager.</td>
140 </tr> 142 </tr>
141 </table> 143 </table>
144
142 <h3>Static Methods</h3> 145 <h3>Static Methods</h3>
143
144 <table> 146 <table>
145 <tr><td>None</td></tr> 147 <tr><td>None</td></tr>
146 </table> 148 </table>
149
147 150
148 <a NAME="TabManagerWidget.__init__" ID="TabManagerWidget.__init__"></a> 151 <a NAME="TabManagerWidget.__init__" ID="TabManagerWidget.__init__"></a>
149 <h4>TabManagerWidget (Constructor)</h4> 152 <h4>TabManagerWidget (Constructor)</h4>
150 <b>TabManagerWidget</b>(<i>mainWindow, parent=None, defaultWidget=False</i>) 153 <b>TabManagerWidget</b>(<i>mainWindow, parent=None, defaultWidget=False</i>)
151
152 <p> 154 <p>
153 Constructor 155 Constructor
154 </p> 156 </p>
157
155 <dl> 158 <dl>
156 159
157 <dt><i>mainWindow</i> (WebBrowserWindow)</dt> 160 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
158 <dd> 161 <dd>
159 reference to the main window 162 reference to the main window
168 </dd> 171 </dd>
169 </dl> 172 </dl>
170 <a NAME="TabManagerWidget.__createEmptyItem" ID="TabManagerWidget.__createEmptyItem"></a> 173 <a NAME="TabManagerWidget.__createEmptyItem" ID="TabManagerWidget.__createEmptyItem"></a>
171 <h4>TabManagerWidget.__createEmptyItem</h4> 174 <h4>TabManagerWidget.__createEmptyItem</h4>
172 <b>__createEmptyItem</b>(<i>parent=None, addToTree=True</i>) 175 <b>__createEmptyItem</b>(<i>parent=None, addToTree=True</i>)
173
174 <p> 176 <p>
175 Private method to create an empty tree item. 177 Private method to create an empty tree item.
176 </p> 178 </p>
179
177 <dl> 180 <dl>
178 181
179 <dt><i>parent</i> (QTreeWidgetItem or QTreeWidget)</dt> 182 <dt><i>parent</i> (QTreeWidgetItem or QTreeWidget)</dt>
180 <dd> 183 <dd>
181 reference to the parent item 184 reference to the parent item
198 </dd> 201 </dd>
199 </dl> 202 </dl>
200 <a NAME="TabManagerWidget.__customContextMenuRequested" ID="TabManagerWidget.__customContextMenuRequested"></a> 203 <a NAME="TabManagerWidget.__customContextMenuRequested" ID="TabManagerWidget.__customContextMenuRequested"></a>
201 <h4>TabManagerWidget.__customContextMenuRequested</h4> 204 <h4>TabManagerWidget.__customContextMenuRequested</h4>
202 <b>__customContextMenuRequested</b>(<i>pos</i>) 205 <b>__customContextMenuRequested</b>(<i>pos</i>)
203
204 <p> 206 <p>
205 Private slot to show the context menu. 207 Private slot to show the context menu.
206 </p> 208 </p>
209
207 <dl> 210 <dl>
208 211
209 <dt><i>pos</i> (QPoint)</dt> 212 <dt><i>pos</i> (QPoint)</dt>
210 <dd> 213 <dd>
211 position the menu should be shown at 214 position the menu should be shown at
212 </dd> 215 </dd>
213 </dl> 216 </dl>
214 <a NAME="TabManagerWidget.__groupByDomainName" ID="TabManagerWidget.__groupByDomainName"></a> 217 <a NAME="TabManagerWidget.__groupByDomainName" ID="TabManagerWidget.__groupByDomainName"></a>
215 <h4>TabManagerWidget.__groupByDomainName</h4> 218 <h4>TabManagerWidget.__groupByDomainName</h4>
216 <b>__groupByDomainName</b>(<i>useHostName=False</i>) 219 <b>__groupByDomainName</b>(<i>useHostName=False</i>)
217
218 <p> 220 <p>
219 Private method to group the tree items by domain name. 221 Private method to group the tree items by domain name.
220 </p> 222 </p>
223
221 <dl> 224 <dl>
222 225
223 <dt><i>useHostName</i> (bool)</dt> 226 <dt><i>useHostName</i> (bool)</dt>
224 <dd> 227 <dd>
225 flag indicating to use the host name 228 flag indicating to use the host name
226 </dd> 229 </dd>
227 </dl> 230 </dl>
228 <a NAME="TabManagerWidget.__groupByWindow" ID="TabManagerWidget.__groupByWindow"></a> 231 <a NAME="TabManagerWidget.__groupByWindow" ID="TabManagerWidget.__groupByWindow"></a>
229 <h4>TabManagerWidget.__groupByWindow</h4> 232 <h4>TabManagerWidget.__groupByWindow</h4>
230 <b>__groupByWindow</b>(<i></i>) 233 <b>__groupByWindow</b>(<i></i>)
231
232 <p> 234 <p>
233 Private method to group the tree items by window. 235 Private method to group the tree items by window.
234 </p> 236 </p>
237
235 <a NAME="TabManagerWidget.__isBrowserSelected" ID="TabManagerWidget.__isBrowserSelected"></a> 238 <a NAME="TabManagerWidget.__isBrowserSelected" ID="TabManagerWidget.__isBrowserSelected"></a>
236 <h4>TabManagerWidget.__isBrowserSelected</h4> 239 <h4>TabManagerWidget.__isBrowserSelected</h4>
237 <b>__isBrowserSelected</b>(<i></i>) 240 <b>__isBrowserSelected</b>(<i></i>)
238
239 <p> 241 <p>
240 Private slot to check, if any browser entry is selected. 242 Private slot to check, if any browser entry is selected.
241 </p> 243 </p>
244
242 <dl> 245 <dl>
243 <dt>Return:</dt> 246 <dt>Return:</dt>
244 <dd> 247 <dd>
245 flag indicating the existence of a selected entry 248 flag indicating the existence of a selected entry
246 </dd> 249 </dd>
252 </dd> 255 </dd>
253 </dl> 256 </dl>
254 <a NAME="TabManagerWidget.__itemDoubleClicked" ID="TabManagerWidget.__itemDoubleClicked"></a> 257 <a NAME="TabManagerWidget.__itemDoubleClicked" ID="TabManagerWidget.__itemDoubleClicked"></a>
255 <h4>TabManagerWidget.__itemDoubleClicked</h4> 258 <h4>TabManagerWidget.__itemDoubleClicked</h4>
256 <b>__itemDoubleClicked</b>(<i>itm, column</i>) 259 <b>__itemDoubleClicked</b>(<i>itm, column</i>)
257
258 <p> 260 <p>
259 Private slot to handle double clicking a tree item. 261 Private slot to handle double clicking a tree item.
260 </p> 262 </p>
263
261 <dl> 264 <dl>
262 265
263 <dt><i>itm</i> (QTreeWidgetItem)</dt> 266 <dt><i>itm</i> (QTreeWidgetItem)</dt>
264 <dd> 267 <dd>
265 reference to the item having been double clicked 268 reference to the item having been double clicked
270 </dd> 273 </dd>
271 </dl> 274 </dl>
272 <a NAME="TabManagerWidget.__makeWebBrowserViewConnections" ID="TabManagerWidget.__makeWebBrowserViewConnections"></a> 275 <a NAME="TabManagerWidget.__makeWebBrowserViewConnections" ID="TabManagerWidget.__makeWebBrowserViewConnections"></a>
273 <h4>TabManagerWidget.__makeWebBrowserViewConnections</h4> 276 <h4>TabManagerWidget.__makeWebBrowserViewConnections</h4>
274 <b>__makeWebBrowserViewConnections</b>(<i>view</i>) 277 <b>__makeWebBrowserViewConnections</b>(<i>view</i>)
275
276 <p> 278 <p>
277 Private method to create the signal connections to the web view. 279 Private method to create the signal connections to the web view.
278 </p> 280 </p>
281
279 <dl> 282 <dl>
280 283
281 <dt><i>view</i> (WebBrowserView)</dt> 284 <dt><i>view</i> (WebBrowserView)</dt>
282 <dd> 285 <dd>
283 reference to the web view 286 reference to the web view
284 </dd> 287 </dd>
285 </dl> 288 </dl>
286 <a NAME="TabManagerWidget.__processActions" ID="TabManagerWidget.__processActions"></a> 289 <a NAME="TabManagerWidget.__processActions" ID="TabManagerWidget.__processActions"></a>
287 <h4>TabManagerWidget.__processActions</h4> 290 <h4>TabManagerWidget.__processActions</h4>
288 <b>__processActions</b>(<i>act</i>) 291 <b>__processActions</b>(<i>act</i>)
289
290 <p> 292 <p>
291 Private slot to process the actions. 293 Private slot to process the actions.
292 </p> 294 </p>
295
293 <dl> 296 <dl>
294 297
295 <dt><i>act</i> (QAction)</dt> 298 <dt><i>act</i> (QAction)</dt>
296 <dd> 299 <dd>
297 reference to the action that triggered 300 reference to the action that triggered
298 </dd> 301 </dd>
299 </dl> 302 </dl>
300 <a NAME="TabManagerWidget.__refreshTree" ID="TabManagerWidget.__refreshTree"></a> 303 <a NAME="TabManagerWidget.__refreshTree" ID="TabManagerWidget.__refreshTree"></a>
301 <h4>TabManagerWidget.__refreshTree</h4> 304 <h4>TabManagerWidget.__refreshTree</h4>
302 <b>__refreshTree</b>(<i></i>) 305 <b>__refreshTree</b>(<i></i>)
303
304 <p> 306 <p>
305 Private slot to referesh the tree. 307 Private slot to referesh the tree.
306 </p> 308 </p>
309
307 <a NAME="TabManagerWidget.__setGroupType" ID="TabManagerWidget.__setGroupType"></a> 310 <a NAME="TabManagerWidget.__setGroupType" ID="TabManagerWidget.__setGroupType"></a>
308 <h4>TabManagerWidget.__setGroupType</h4> 311 <h4>TabManagerWidget.__setGroupType</h4>
309 <b>__setGroupType</b>(<i>groupType</i>) 312 <b>__setGroupType</b>(<i>groupType</i>)
310
311 <p> 313 <p>
312 Private method to set the 'Group By' type. 314 Private method to set the 'Group By' type.
313 </p> 315 </p>
316
314 <dl> 317 <dl>
315 318
316 <dt><i>groupType</i> (int (0 - 2))</dt> 319 <dt><i>groupType</i> (int (0 - 2))</dt>
317 <dd> 320 <dd>
318 'Group By' type to be set 321 'Group By' type to be set
319 </dd> 322 </dd>
320 </dl> 323 </dl>
321 <a NAME="TabManagerWidget.bookmarkSelectedBrowsers" ID="TabManagerWidget.bookmarkSelectedBrowsers"></a> 324 <a NAME="TabManagerWidget.bookmarkSelectedBrowsers" ID="TabManagerWidget.bookmarkSelectedBrowsers"></a>
322 <h4>TabManagerWidget.bookmarkSelectedBrowsers</h4> 325 <h4>TabManagerWidget.bookmarkSelectedBrowsers</h4>
323 <b>bookmarkSelectedBrowsers</b>(<i>browsersDict</i>) 326 <b>bookmarkSelectedBrowsers</b>(<i>browsersDict</i>)
324
325 <p> 327 <p>
326 Public method to bookmark the selected browsers. 328 Public method to bookmark the selected browsers.
327 </p> 329 </p>
330
328 <dl> 331 <dl>
329 332
330 <dt><i>browsersDict</i> (dict with WebBrowserWindow as key and list of WebBrowserView)</dt> 333 <dt><i>browsersDict</i> (dict with WebBrowserWindow as key and list of WebBrowserView)</dt>
331 <dd> 334 <dd>
332 dictionary containing the browsers per window 335 dictionary containing the browsers per window
334 </dd> 337 </dd>
335 </dl> 338 </dl>
336 <a NAME="TabManagerWidget.changeGroupType" ID="TabManagerWidget.changeGroupType"></a> 339 <a NAME="TabManagerWidget.changeGroupType" ID="TabManagerWidget.changeGroupType"></a>
337 <h4>TabManagerWidget.changeGroupType</h4> 340 <h4>TabManagerWidget.changeGroupType</h4>
338 <b>changeGroupType</b>(<i>act</i>) 341 <b>changeGroupType</b>(<i>act</i>)
339
340 <p> 342 <p>
341 Public slot to change the 'Group By' type. 343 Public slot to change the 'Group By' type.
342 </p> 344 </p>
345
343 <dl> 346 <dl>
344 347
345 <dt><i>act</i> (QAction)</dt> 348 <dt><i>act</i> (QAction)</dt>
346 <dd> 349 <dd>
347 reference to the action that was triggered 350 reference to the action that was triggered
348 </dd> 351 </dd>
349 </dl> 352 </dl>
350 <a NAME="TabManagerWidget.closeSelectedBrowsers" ID="TabManagerWidget.closeSelectedBrowsers"></a> 353 <a NAME="TabManagerWidget.closeSelectedBrowsers" ID="TabManagerWidget.closeSelectedBrowsers"></a>
351 <h4>TabManagerWidget.closeSelectedBrowsers</h4> 354 <h4>TabManagerWidget.closeSelectedBrowsers</h4>
352 <b>closeSelectedBrowsers</b>(<i>browsersDict</i>) 355 <b>closeSelectedBrowsers</b>(<i>browsersDict</i>)
353
354 <p> 356 <p>
355 Public method to close the selected browsers. 357 Public method to close the selected browsers.
356 </p> 358 </p>
359
357 <dl> 360 <dl>
358 361
359 <dt><i>browsersDict</i> (dict with WebBrowserWindow as key and list of WebBrowserView)</dt> 362 <dt><i>browsersDict</i> (dict with WebBrowserWindow as key and list of WebBrowserView)</dt>
360 <dd> 363 <dd>
361 dictionary containing the browsers per window 364 dictionary containing the browsers per window
363 </dd> 366 </dd>
364 </dl> 367 </dl>
365 <a NAME="TabManagerWidget.createStatusBarIcon" ID="TabManagerWidget.createStatusBarIcon"></a> 368 <a NAME="TabManagerWidget.createStatusBarIcon" ID="TabManagerWidget.createStatusBarIcon"></a>
366 <h4>TabManagerWidget.createStatusBarIcon</h4> 369 <h4>TabManagerWidget.createStatusBarIcon</h4>
367 <b>createStatusBarIcon</b>(<i></i>) 370 <b>createStatusBarIcon</b>(<i></i>)
368
369 <p> 371 <p>
370 Public method to create a status bar icon. 372 Public method to create a status bar icon.
371 </p> 373 </p>
374
372 <dl> 375 <dl>
373 <dt>Return:</dt> 376 <dt>Return:</dt>
374 <dd> 377 <dd>
375 generated icon 378 generated icon
376 </dd> 379 </dd>
382 </dd> 385 </dd>
383 </dl> 386 </dl>
384 <a NAME="TabManagerWidget.delayedRefreshTree" ID="TabManagerWidget.delayedRefreshTree"></a> 387 <a NAME="TabManagerWidget.delayedRefreshTree" ID="TabManagerWidget.delayedRefreshTree"></a>
385 <h4>TabManagerWidget.delayedRefreshTree</h4> 388 <h4>TabManagerWidget.delayedRefreshTree</h4>
386 <b>delayedRefreshTree</b>(<i>page=None</i>) 389 <b>delayedRefreshTree</b>(<i>page=None</i>)
387
388 <p> 390 <p>
389 Public slot to do a delyed refresh of the tree. 391 Public slot to do a delyed refresh of the tree.
390 </p> 392 </p>
393
391 <dl> 394 <dl>
392 395
393 <dt><i>page</i> (WebBrowserPage)</dt> 396 <dt><i>page</i> (WebBrowserPage)</dt>
394 <dd> 397 <dd>
395 reference to the web page 398 reference to the web page
396 </dd> 399 </dd>
397 </dl> 400 </dl>
398 <a NAME="TabManagerWidget.domainFromUrl" ID="TabManagerWidget.domainFromUrl"></a> 401 <a NAME="TabManagerWidget.domainFromUrl" ID="TabManagerWidget.domainFromUrl"></a>
399 <h4>TabManagerWidget.domainFromUrl</h4> 402 <h4>TabManagerWidget.domainFromUrl</h4>
400 <b>domainFromUrl</b>(<i>url, useHostName=False</i>) 403 <b>domainFromUrl</b>(<i>url, useHostName=False</i>)
401
402 <p> 404 <p>
403 Public method to extract the domain from an URL. 405 Public method to extract the domain from an URL.
404 </p> 406 </p>
407
405 <dl> 408 <dl>
406 409
407 <dt><i>url</i> (QUrl)</dt> 410 <dt><i>url</i> (QUrl)</dt>
408 <dd> 411 <dd>
409 URL to extract the domain from 412 URL to extract the domain from
426 </dd> 429 </dd>
427 </dl> 430 </dl>
428 <a NAME="TabManagerWidget.mainWindowCreated" ID="TabManagerWidget.mainWindowCreated"></a> 431 <a NAME="TabManagerWidget.mainWindowCreated" ID="TabManagerWidget.mainWindowCreated"></a>
429 <h4>TabManagerWidget.mainWindowCreated</h4> 432 <h4>TabManagerWidget.mainWindowCreated</h4>
430 <b>mainWindowCreated</b>(<i>mainWin</i>) 433 <b>mainWindowCreated</b>(<i>mainWin</i>)
431
432 <p> 434 <p>
433 Public method to act on the creation of a new web browser window. 435 Public method to act on the creation of a new web browser window.
434 </p> 436 </p>
437
435 <dl> 438 <dl>
436 439
437 <dt><i>mainWin</i> (WebBrowserWindow)</dt> 440 <dt><i>mainWin</i> (WebBrowserWindow)</dt>
438 <dd> 441 <dd>
439 reference to the web browser window 442 reference to the web browser window
440 </dd> 443 </dd>
441 </dl> 444 </dl>
442 <a NAME="TabManagerWidget.raiseTabManager" ID="TabManagerWidget.raiseTabManager"></a> 445 <a NAME="TabManagerWidget.raiseTabManager" ID="TabManagerWidget.raiseTabManager"></a>
443 <h4>TabManagerWidget.raiseTabManager</h4> 446 <h4>TabManagerWidget.raiseTabManager</h4>
444 <b>raiseTabManager</b>(<i>icon</i>) 447 <b>raiseTabManager</b>(<i>icon</i>)
445
446 <p> 448 <p>
447 Public slot to show the tab manager. 449 Public slot to show the tab manager.
448 </p> 450 </p>
451
449 <dl> 452 <dl>
450 453
451 <dt><i>icon</i> (EricClickableLabel or QAction)</dt> 454 <dt><i>icon</i> (EricClickableLabel or QAction)</dt>
452 <dd> 455 <dd>
453 reference to the clicked icon 456 reference to the clicked icon

Mercurial Repository: eric

eric ide

mercurial