eric6/Documentation/Source/eric6.WebBrowser.ClosedTabsManager.html

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

eric ide

mercurial