eric7/Documentation/Source/eric7.WebBrowser.ClosedTabsManager.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.ClosedTabsManager</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.ClosedTabsManager</h1>
24
25 <p>
26 Module implementing a class to manage closed tabs.
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="#ClosedTab">ClosedTab</a></td>
39 <td>Class implementing a structure to store data about a closed tab.</td>
40 </tr>
41 <tr>
42 <td><a href="#ClosedTabsManager">ClosedTabsManager</a></td>
43 <td>Class implementing a manager for closed tabs.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="ClosedTab" ID="ClosedTab"></a>
54 <h2>ClosedTab</h2>
55
56 <p>
57 Class implementing a structure to store data about a closed tab.
58 </p>
59 <h3>Derived from</h3>
60 None
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#ClosedTab.__init__">ClosedTab</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#ClosedTab.__eq__">__eq__</a></td>
81 <td>Special method implementing the equality operator.</td>
82 </tr>
83 </table>
84 <h3>Static Methods</h3>
85
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89
90 <a NAME="ClosedTab.__init__" ID="ClosedTab.__init__"></a>
91 <h4>ClosedTab (Constructor)</h4>
92 <b>ClosedTab</b>(<i>url=None, title="", position=-1</i>)
93
94 <p>
95 Constructor
96 </p>
97 <dl>
98
99 <dt><i>url</i></dt>
100 <dd>
101 URL of the closed tab (QUrl)
102 </dd>
103 <dt><i>title</i></dt>
104 <dd>
105 title of the closed tab (string)
106 </dd>
107 <dt><i>position</i></dt>
108 <dd>
109 index of the closed tab (integer)
110 </dd>
111 </dl>
112 <a NAME="ClosedTab.__eq__" ID="ClosedTab.__eq__"></a>
113 <h4>ClosedTab.__eq__</h4>
114 <b>__eq__</b>(<i>other</i>)
115
116 <p>
117 Special method implementing the equality operator.
118 </p>
119 <dl>
120
121 <dt><i>other</i></dt>
122 <dd>
123 reference to the object to compare against (ClosedTab)
124 </dd>
125 </dl>
126 <dl>
127 <dt>Return:</dt>
128 <dd>
129 flag indicating equality of the tabs (boolean)
130 </dd>
131 </dl>
132 <div align="right"><a href="#top">Up</a></div>
133 <hr />
134 <hr />
135 <a NAME="ClosedTabsManager" ID="ClosedTabsManager"></a>
136 <h2>ClosedTabsManager</h2>
137
138 <p>
139 Class implementing a manager for closed tabs.
140 </p>
141 <h3>Signals</h3>
142 <dl>
143
144 <dt>closedTabAvailable(boolean)</dt>
145 <dd>
146 emitted to signal a change of
147 availability of closed tabs
148 </dd>
149 </dl>
150 <h3>Derived from</h3>
151 QObject
152 <h3>Class Attributes</h3>
153
154 <table>
155 <tr><td>None</td></tr>
156 </table>
157 <h3>Class Methods</h3>
158
159 <table>
160 <tr><td>None</td></tr>
161 </table>
162 <h3>Methods</h3>
163
164 <table>
165
166 <tr>
167 <td><a href="#ClosedTabsManager.__init__">ClosedTabsManager</a></td>
168 <td>Constructor</td>
169 </tr>
170 <tr>
171 <td><a href="#ClosedTabsManager.allClosedTabs">allClosedTabs</a></td>
172 <td>Public method to get a list of all closed tabs.</td>
173 </tr>
174 <tr>
175 <td><a href="#ClosedTabsManager.clearList">clearList</a></td>
176 <td>Public method to clear the list of closed tabs.</td>
177 </tr>
178 <tr>
179 <td><a href="#ClosedTabsManager.getClosedTabAt">getClosedTabAt</a></td>
180 <td>Public method to get the indexed closed tab.</td>
181 </tr>
182 <tr>
183 <td><a href="#ClosedTabsManager.isClosedTabAvailable">isClosedTabAvailable</a></td>
184 <td>Public method to check for closed tabs.</td>
185 </tr>
186 <tr>
187 <td><a href="#ClosedTabsManager.recordBrowser">recordBrowser</a></td>
188 <td>Public method to record the data of a browser about to be closed.</td>
189 </tr>
190 </table>
191 <h3>Static Methods</h3>
192
193 <table>
194 <tr><td>None</td></tr>
195 </table>
196
197 <a NAME="ClosedTabsManager.__init__" ID="ClosedTabsManager.__init__"></a>
198 <h4>ClosedTabsManager (Constructor)</h4>
199 <b>ClosedTabsManager</b>(<i>parent=None</i>)
200
201 <p>
202 Constructor
203 </p>
204 <dl>
205
206 <dt><i>parent</i></dt>
207 <dd>
208 reference to the parent object (QObject)
209 </dd>
210 </dl>
211 <a NAME="ClosedTabsManager.allClosedTabs" ID="ClosedTabsManager.allClosedTabs"></a>
212 <h4>ClosedTabsManager.allClosedTabs</h4>
213 <b>allClosedTabs</b>(<i></i>)
214
215 <p>
216 Public method to get a list of all closed tabs.
217 </p>
218 <dl>
219 <dt>Return:</dt>
220 <dd>
221 list of closed tabs (list of ClosedTab)
222 </dd>
223 </dl>
224 <a NAME="ClosedTabsManager.clearList" ID="ClosedTabsManager.clearList"></a>
225 <h4>ClosedTabsManager.clearList</h4>
226 <b>clearList</b>(<i></i>)
227
228 <p>
229 Public method to clear the list of closed tabs.
230 </p>
231 <a NAME="ClosedTabsManager.getClosedTabAt" ID="ClosedTabsManager.getClosedTabAt"></a>
232 <h4>ClosedTabsManager.getClosedTabAt</h4>
233 <b>getClosedTabAt</b>(<i>index</i>)
234
235 <p>
236 Public method to get the indexed closed tab.
237 </p>
238 <dl>
239
240 <dt><i>index</i></dt>
241 <dd>
242 index of the tab to return (integer)
243 </dd>
244 </dl>
245 <dl>
246 <dt>Return:</dt>
247 <dd>
248 requested tab (ClosedTab)
249 </dd>
250 </dl>
251 <a NAME="ClosedTabsManager.isClosedTabAvailable" ID="ClosedTabsManager.isClosedTabAvailable"></a>
252 <h4>ClosedTabsManager.isClosedTabAvailable</h4>
253 <b>isClosedTabAvailable</b>(<i></i>)
254
255 <p>
256 Public method to check for closed tabs.
257 </p>
258 <dl>
259 <dt>Return:</dt>
260 <dd>
261 flag indicating the availability of closed tab data (boolean)
262 </dd>
263 </dl>
264 <a NAME="ClosedTabsManager.recordBrowser" ID="ClosedTabsManager.recordBrowser"></a>
265 <h4>ClosedTabsManager.recordBrowser</h4>
266 <b>recordBrowser</b>(<i>browser, position</i>)
267
268 <p>
269 Public method to record the data of a browser about to be closed.
270 </p>
271 <dl>
272
273 <dt><i>browser</i></dt>
274 <dd>
275 reference to the browser to be closed (HelpBrowser)
276 </dd>
277 <dt><i>position</i></dt>
278 <dd>
279 index of the tab to be closed (integer)
280 </dd>
281 </dl>
282 <div align="right"><a href="#top">Up</a></div>
283 <hr />
284 </body></html>

eric ide

mercurial