src/eric7/Documentation/Source/eric7.WebBrowser.ClosedTabsManager.html

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

eric ide

mercurial