Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.TabManager.TabManagerWidget.html

eric6/Documentation/Source/eric6.WebBrowser.TabManager.TabManagerWidget.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.TabManager.TabManagerWidget</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.TabManager.TabManagerWidget</h1>
23 <p>
24 Module implementing a window for managing the web browser tabs.
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="#TabManagerWidget">TabManagerWidget</a></td>
34 <td>Class implementing a window for managing the web browser tabs.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="TabManagerWidget" ID="TabManagerWidget"></a>
43 <h2>TabManagerWidget</h2>
44 <p>
45 Class implementing a window for managing the web browser tabs.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>groupTypeChanged(int)</dt>
49 <dd>
50 emitted when the 'Group By' value was changed
51 </dd>
52 </dl>
53 <h3>Derived from</h3>
54 QWidget
55 <h3>Class Attributes</h3>
56 <table>
57 <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>
58 </table>
59 <h3>Class Methods</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#TabManagerWidget.__init__">TabManagerWidget</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#TabManagerWidget.__createEmptyItem">__createEmptyItem</a></td>
70 <td>Private method to create an empty tree item.</td>
71 </tr><tr>
72 <td><a href="#TabManagerWidget.__customContextMenuRequested">__customContextMenuRequested</a></td>
73 <td>Private slot to show the context menu.</td>
74 </tr><tr>
75 <td><a href="#TabManagerWidget.__groupByDomainName">__groupByDomainName</a></td>
76 <td>Private method to group the tree items by domain name.</td>
77 </tr><tr>
78 <td><a href="#TabManagerWidget.__groupByWindow">__groupByWindow</a></td>
79 <td>Private method to group the tree items by window.</td>
80 </tr><tr>
81 <td><a href="#TabManagerWidget.__isBrowserSelected">__isBrowserSelected</a></td>
82 <td>Private slot to check, if any browser entry is selected.</td>
83 </tr><tr>
84 <td><a href="#TabManagerWidget.__itemDoubleClicked">__itemDoubleClicked</a></td>
85 <td>Private slot to handle double clicking a tree item.</td>
86 </tr><tr>
87 <td><a href="#TabManagerWidget.__makeWebBrowserViewConnections">__makeWebBrowserViewConnections</a></td>
88 <td>Private method to create the signal connections to the web view.</td>
89 </tr><tr>
90 <td><a href="#TabManagerWidget.__processActions">__processActions</a></td>
91 <td>Private slot to process the actions.</td>
92 </tr><tr>
93 <td><a href="#TabManagerWidget.__refreshTree">__refreshTree</a></td>
94 <td>Private slot to referesh the tree.</td>
95 </tr><tr>
96 <td><a href="#TabManagerWidget.__setGroupType">__setGroupType</a></td>
97 <td>Private method to set the 'Group By' type.</td>
98 </tr><tr>
99 <td><a href="#TabManagerWidget.bookmarkSelectedBrowsers">bookmarkSelectedBrowsers</a></td>
100 <td>Public method to bookmark the selected browsers.</td>
101 </tr><tr>
102 <td><a href="#TabManagerWidget.changeGroupType">changeGroupType</a></td>
103 <td>Public slot to change the 'Group By' type.</td>
104 </tr><tr>
105 <td><a href="#TabManagerWidget.closeSelectedBrowsers">closeSelectedBrowsers</a></td>
106 <td>Public method to close the selected browsers.</td>
107 </tr><tr>
108 <td><a href="#TabManagerWidget.createStatusBarIcon">createStatusBarIcon</a></td>
109 <td>Public method to create a status bar icon.</td>
110 </tr><tr>
111 <td><a href="#TabManagerWidget.delayedRefreshTree">delayedRefreshTree</a></td>
112 <td>Public slot to do a delyed refresh of the tree.</td>
113 </tr><tr>
114 <td><a href="#TabManagerWidget.domainFromUrl">domainFromUrl</a></td>
115 <td>Public method to extract the domain from an URL.</td>
116 </tr><tr>
117 <td><a href="#TabManagerWidget.mainWindowCreated">mainWindowCreated</a></td>
118 <td>Public method to act on the creation of a new web browser window.</td>
119 </tr><tr>
120 <td><a href="#TabManagerWidget.raiseTabManager">raiseTabManager</a></td>
121 <td>Public slot to show the tab manager.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125 <table>
126 <tr><td>None</td></tr>
127 </table>
128 <a NAME="TabManagerWidget.__init__" ID="TabManagerWidget.__init__"></a>
129 <h4>TabManagerWidget (Constructor)</h4>
130 <b>TabManagerWidget</b>(<i>mainWindow, parent=None, defaultWidget=False</i>)
131 <p>
132 Constructor
133 </p><dl>
134 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
135 <dd>
136 reference to the main window
137 </dd><dt><i>parent</i> (QWidget)</dt>
138 <dd>
139 reference to the parent widget
140 </dd><dt><i>defaultWidget</i> (bool)</dt>
141 <dd>
142 flag indicating the default widget
143 </dd>
144 </dl><a NAME="TabManagerWidget.__createEmptyItem" ID="TabManagerWidget.__createEmptyItem"></a>
145 <h4>TabManagerWidget.__createEmptyItem</h4>
146 <b>__createEmptyItem</b>(<i>parent=None, addToTree=True</i>)
147 <p>
148 Private method to create an empty tree item.
149 </p><dl>
150 <dt><i>parent</i> (QTreeWidgetItem or QTreeWidget)</dt>
151 <dd>
152 reference to the parent item
153 </dd><dt><i>addToTree</i> (bool)</dt>
154 <dd>
155 flag indicating to add the item to the tree
156 </dd>
157 </dl><dl>
158 <dt>Returns:</dt>
159 <dd>
160 created item
161 </dd>
162 </dl><dl>
163 <dt>Return Type:</dt>
164 <dd>
165 QTreeWidgetItem
166 </dd>
167 </dl><a NAME="TabManagerWidget.__customContextMenuRequested" ID="TabManagerWidget.__customContextMenuRequested"></a>
168 <h4>TabManagerWidget.__customContextMenuRequested</h4>
169 <b>__customContextMenuRequested</b>(<i>pos</i>)
170 <p>
171 Private slot to show the context menu.
172 </p><dl>
173 <dt><i>pos</i> (QPoint)</dt>
174 <dd>
175 position the menu should be shown at
176 </dd>
177 </dl><a NAME="TabManagerWidget.__groupByDomainName" ID="TabManagerWidget.__groupByDomainName"></a>
178 <h4>TabManagerWidget.__groupByDomainName</h4>
179 <b>__groupByDomainName</b>(<i>useHostName=False</i>)
180 <p>
181 Private method to group the tree items by domain name.
182 </p><dl>
183 <dt><i>useHostName</i> (bool)</dt>
184 <dd>
185 flag indicating to use the host name
186 </dd>
187 </dl><a NAME="TabManagerWidget.__groupByWindow" ID="TabManagerWidget.__groupByWindow"></a>
188 <h4>TabManagerWidget.__groupByWindow</h4>
189 <b>__groupByWindow</b>(<i></i>)
190 <p>
191 Private method to group the tree items by window.
192 </p><a NAME="TabManagerWidget.__isBrowserSelected" ID="TabManagerWidget.__isBrowserSelected"></a>
193 <h4>TabManagerWidget.__isBrowserSelected</h4>
194 <b>__isBrowserSelected</b>(<i></i>)
195 <p>
196 Private slot to check, if any browser entry is selected.
197 </p><dl>
198 <dt>Returns:</dt>
199 <dd>
200 flag indicating the existence of a selected entry
201 </dd>
202 </dl><dl>
203 <dt>Return Type:</dt>
204 <dd>
205 bool
206 </dd>
207 </dl><a NAME="TabManagerWidget.__itemDoubleClicked" ID="TabManagerWidget.__itemDoubleClicked"></a>
208 <h4>TabManagerWidget.__itemDoubleClicked</h4>
209 <b>__itemDoubleClicked</b>(<i>itm, column</i>)
210 <p>
211 Private slot to handle double clicking a tree item.
212 </p><dl>
213 <dt><i>itm</i> (QTreeWidgetItem)</dt>
214 <dd>
215 reference to the item having been double clicked
216 </dd><dt><i>column</i> (int)</dt>
217 <dd>
218 column of the double click
219 </dd>
220 </dl><a NAME="TabManagerWidget.__makeWebBrowserViewConnections" ID="TabManagerWidget.__makeWebBrowserViewConnections"></a>
221 <h4>TabManagerWidget.__makeWebBrowserViewConnections</h4>
222 <b>__makeWebBrowserViewConnections</b>(<i>view</i>)
223 <p>
224 Private method to create the signal connections to the web view.
225 </p><dl>
226 <dt><i>view</i> (WebBrowserView)</dt>
227 <dd>
228 reference to the web view
229 </dd>
230 </dl><a NAME="TabManagerWidget.__processActions" ID="TabManagerWidget.__processActions"></a>
231 <h4>TabManagerWidget.__processActions</h4>
232 <b>__processActions</b>(<i>act</i>)
233 <p>
234 Private slot to process the actions.
235 </p><dl>
236 <dt><i>act</i> (QAction)</dt>
237 <dd>
238 reference to the action that triggered
239 </dd>
240 </dl><a NAME="TabManagerWidget.__refreshTree" ID="TabManagerWidget.__refreshTree"></a>
241 <h4>TabManagerWidget.__refreshTree</h4>
242 <b>__refreshTree</b>(<i></i>)
243 <p>
244 Private slot to referesh the tree.
245 </p><a NAME="TabManagerWidget.__setGroupType" ID="TabManagerWidget.__setGroupType"></a>
246 <h4>TabManagerWidget.__setGroupType</h4>
247 <b>__setGroupType</b>(<i>groupType</i>)
248 <p>
249 Private method to set the 'Group By' type.
250 </p><dl>
251 <dt><i>groupType</i> (int (0 - 2))</dt>
252 <dd>
253 'Group By' type to be set
254 </dd>
255 </dl><a NAME="TabManagerWidget.bookmarkSelectedBrowsers" ID="TabManagerWidget.bookmarkSelectedBrowsers"></a>
256 <h4>TabManagerWidget.bookmarkSelectedBrowsers</h4>
257 <b>bookmarkSelectedBrowsers</b>(<i>browsersDict</i>)
258 <p>
259 Public method to bookmark the selected browsers.
260 </p><dl>
261 <dt><i>browsersDict</i> (dict with WebBrowserWindow as key and list of WebBrowserView)</dt>
262 <dd>
263 dictionary containing the browsers per window
264 as value
265 </dd>
266 </dl><a NAME="TabManagerWidget.changeGroupType" ID="TabManagerWidget.changeGroupType"></a>
267 <h4>TabManagerWidget.changeGroupType</h4>
268 <b>changeGroupType</b>(<i>act</i>)
269 <p>
270 Public slot to change the 'Group By' type.
271 </p><dl>
272 <dt><i>act</i> (QAction)</dt>
273 <dd>
274 reference to the action that was triggered
275 </dd>
276 </dl><a NAME="TabManagerWidget.closeSelectedBrowsers" ID="TabManagerWidget.closeSelectedBrowsers"></a>
277 <h4>TabManagerWidget.closeSelectedBrowsers</h4>
278 <b>closeSelectedBrowsers</b>(<i>browsersDict</i>)
279 <p>
280 Public method to close the selected browsers.
281 </p><dl>
282 <dt><i>browsersDict</i> (dict with WebBrowserWindow as key and list of WebBrowserView)</dt>
283 <dd>
284 dictionary containing the browsers per window
285 as value
286 </dd>
287 </dl><a NAME="TabManagerWidget.createStatusBarIcon" ID="TabManagerWidget.createStatusBarIcon"></a>
288 <h4>TabManagerWidget.createStatusBarIcon</h4>
289 <b>createStatusBarIcon</b>(<i></i>)
290 <p>
291 Public method to create a status bar icon.
292 </p><dl>
293 <dt>Returns:</dt>
294 <dd>
295 generated icon
296 </dd>
297 </dl><dl>
298 <dt>Return Type:</dt>
299 <dd>
300 E5ClickableLabel
301 </dd>
302 </dl><a NAME="TabManagerWidget.delayedRefreshTree" ID="TabManagerWidget.delayedRefreshTree"></a>
303 <h4>TabManagerWidget.delayedRefreshTree</h4>
304 <b>delayedRefreshTree</b>(<i>page=None</i>)
305 <p>
306 Public slot to do a delyed refresh of the tree.
307 </p><dl>
308 <dt><i>page</i> (WebBrowserPage)</dt>
309 <dd>
310 reference to the web page
311 </dd>
312 </dl><a NAME="TabManagerWidget.domainFromUrl" ID="TabManagerWidget.domainFromUrl"></a>
313 <h4>TabManagerWidget.domainFromUrl</h4>
314 <b>domainFromUrl</b>(<i>url, useHostName=False</i>)
315 <p>
316 Public method to extract the domain from an URL.
317 </p><dl>
318 <dt><i>url</i> (QUrl)</dt>
319 <dd>
320 URL to extract the domain from
321 </dd><dt><i>useHostName</i> (bool)</dt>
322 <dd>
323 flag indicating to use the host name
324 </dd>
325 </dl><dl>
326 <dt>Returns:</dt>
327 <dd>
328 domain name
329 </dd>
330 </dl><dl>
331 <dt>Return Type:</dt>
332 <dd>
333 str
334 </dd>
335 </dl><a NAME="TabManagerWidget.mainWindowCreated" ID="TabManagerWidget.mainWindowCreated"></a>
336 <h4>TabManagerWidget.mainWindowCreated</h4>
337 <b>mainWindowCreated</b>(<i>mainWin, refresh=True</i>)
338 <p>
339 Public method to act on the creation of a new web browser window.
340 </p><dl>
341 <dt><i>mainWin</i> (WebBrowserWindow)</dt>
342 <dd>
343 reference to the web browser window
344 </dd><dt><i>refresh</i> (bool)</dt>
345 <dd>
346 flag indicating to refresh the widget
347 </dd>
348 </dl><a NAME="TabManagerWidget.raiseTabManager" ID="TabManagerWidget.raiseTabManager"></a>
349 <h4>TabManagerWidget.raiseTabManager</h4>
350 <b>raiseTabManager</b>(<i>icon</i>)
351 <p>
352 Public slot to show the tab manager.
353 </p><dl>
354 <dt><i>icon</i> (E5ClickableLabel or QAction)</dt>
355 <dd>
356 reference to the clicked icon
357 </dd>
358 </dl>
359 <div align="right"><a href="#top">Up</a></div>
360 <hr />
361 </body></html>

Mercurial Repository: eric

eric ide

mercurial