eric6/Documentation/Source/eric6.WebBrowser.History.HistoryManager.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.History.HistoryManager</h1> 23 <h1>eric6.WebBrowser.History.HistoryManager</h1>
24
23 <p> 25 <p>
24 Module implementing the history manager. 26 Module implementing the history manager.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>HISTORY_VERSIONS</td></tr><tr><td>HISTORY_VERSION_42</td></tr><tr><td>HISTORY_VERSION_60</td></tr> 31 <tr><td>HISTORY_VERSIONS</td></tr><tr><td>HISTORY_VERSION_42</td></tr><tr><td>HISTORY_VERSION_60</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="#HistoryEntry">HistoryEntry</a></td> 38 <td><a href="#HistoryEntry">HistoryEntry</a></td>
34 <td>Class implementing a history entry.</td> 39 <td>Class implementing a history entry.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#HistoryManager">HistoryManager</a></td> 42 <td><a href="#HistoryManager">HistoryManager</a></td>
37 <td>Class implementing the history manager.</td> 43 <td>Class implementing the history manager.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
47
41 <table> 48 <table>
42 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
43 </table> 50 </table>
44 <hr /><hr /> 51 <hr />
52 <hr />
45 <a NAME="HistoryEntry" ID="HistoryEntry"></a> 53 <a NAME="HistoryEntry" ID="HistoryEntry"></a>
46 <h2>HistoryEntry</h2> 54 <h2>HistoryEntry</h2>
55
47 <p> 56 <p>
48 Class implementing a history entry. 57 Class implementing a history entry.
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="#HistoryEntry.__init__">HistoryEntry</a></td> 76 <td><a href="#HistoryEntry.__init__">HistoryEntry</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#HistoryEntry.__eq__">__eq__</a></td> 80 <td><a href="#HistoryEntry.__eq__">__eq__</a></td>
67 <td>Special method determining equality.</td> 81 <td>Special method determining equality.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#HistoryEntry.__lt__">__lt__</a></td> 84 <td><a href="#HistoryEntry.__lt__">__lt__</a></td>
70 <td>Special method determining less relation.</td> 85 <td>Special method determining less relation.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#HistoryEntry.isValid">isValid</a></td> 88 <td><a href="#HistoryEntry.isValid">isValid</a></td>
73 <td>Public method to determine validity.</td> 89 <td>Public method to determine validity.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#HistoryEntry.userTitle">userTitle</a></td> 92 <td><a href="#HistoryEntry.userTitle">userTitle</a></td>
76 <td>Public method to get the title of the history entry.</td> 93 <td>Public method to get the title of the history entry.</td>
77 </tr> 94 </tr>
78 </table> 95 </table>
79 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
97
80 <table> 98 <table>
81 <tr><td>None</td></tr> 99 <tr><td>None</td></tr>
82 </table> 100 </table>
101
83 <a NAME="HistoryEntry.__init__" ID="HistoryEntry.__init__"></a> 102 <a NAME="HistoryEntry.__init__" ID="HistoryEntry.__init__"></a>
84 <h4>HistoryEntry (Constructor)</h4> 103 <h4>HistoryEntry (Constructor)</h4>
85 <b>HistoryEntry</b>(<i>url=None, dateTime=None, title=None, visitCount=None</i>) 104 <b>HistoryEntry</b>(<i>url=None, dateTime=None, title=None, visitCount=None</i>)
105
86 <p> 106 <p>
87 Constructor 107 Constructor
88 </p><dl> 108 </p>
109 <dl>
110
89 <dt><i>url</i></dt> 111 <dt><i>url</i></dt>
90 <dd> 112 <dd>
91 URL of the history entry (string) 113 URL of the history entry (string)
92 </dd><dt><i>dateTime</i></dt> 114 </dd>
115 <dt><i>dateTime</i></dt>
93 <dd> 116 <dd>
94 date and time this entry was created (QDateTime) 117 date and time this entry was created (QDateTime)
95 </dd><dt><i>title</i></dt> 118 </dd>
119 <dt><i>title</i></dt>
96 <dd> 120 <dd>
97 title string for the history entry (string) 121 title string for the history entry (string)
98 </dd><dt><i>visitCount</i></dt> 122 </dd>
123 <dt><i>visitCount</i></dt>
99 <dd> 124 <dd>
100 number of visits of this URL (int) 125 number of visits of this URL (int)
101 </dd> 126 </dd>
102 </dl><a NAME="HistoryEntry.__eq__" ID="HistoryEntry.__eq__"></a> 127 </dl>
128 <a NAME="HistoryEntry.__eq__" ID="HistoryEntry.__eq__"></a>
103 <h4>HistoryEntry.__eq__</h4> 129 <h4>HistoryEntry.__eq__</h4>
104 <b>__eq__</b>(<i>other</i>) 130 <b>__eq__</b>(<i>other</i>)
131
105 <p> 132 <p>
106 Special method determining equality. 133 Special method determining equality.
107 </p><dl> 134 </p>
135 <dl>
136
108 <dt><i>other</i></dt> 137 <dt><i>other</i></dt>
109 <dd> 138 <dd>
110 reference to the history entry to compare against 139 reference to the history entry to compare against
111 (HistoryEntry) 140 (HistoryEntry)
112 </dd> 141 </dd>
113 </dl><dl> 142 </dl>
143 <dl>
114 <dt>Returns:</dt> 144 <dt>Returns:</dt>
115 <dd> 145 <dd>
116 flag indicating equality (boolean) 146 flag indicating equality (boolean)
117 </dd> 147 </dd>
118 </dl><a NAME="HistoryEntry.__lt__" ID="HistoryEntry.__lt__"></a> 148 </dl>
149 <a NAME="HistoryEntry.__lt__" ID="HistoryEntry.__lt__"></a>
119 <h4>HistoryEntry.__lt__</h4> 150 <h4>HistoryEntry.__lt__</h4>
120 <b>__lt__</b>(<i>other</i>) 151 <b>__lt__</b>(<i>other</i>)
152
121 <p> 153 <p>
122 Special method determining less relation. 154 Special method determining less relation.
123 </p><p> 155 </p>
156 <p>
124 Note: History is sorted in reverse order by date and time 157 Note: History is sorted in reverse order by date and time
125 </p><dl> 158 </p>
159 <dl>
160
126 <dt><i>other</i></dt> 161 <dt><i>other</i></dt>
127 <dd> 162 <dd>
128 reference to the history entry to compare against 163 reference to the history entry to compare against
129 (HistoryEntry) 164 (HistoryEntry)
130 </dd> 165 </dd>
131 </dl><dl> 166 </dl>
167 <dl>
132 <dt>Returns:</dt> 168 <dt>Returns:</dt>
133 <dd> 169 <dd>
134 flag indicating less (boolean) 170 flag indicating less (boolean)
135 </dd> 171 </dd>
136 </dl><a NAME="HistoryEntry.isValid" ID="HistoryEntry.isValid"></a> 172 </dl>
173 <a NAME="HistoryEntry.isValid" ID="HistoryEntry.isValid"></a>
137 <h4>HistoryEntry.isValid</h4> 174 <h4>HistoryEntry.isValid</h4>
138 <b>isValid</b>(<i></i>) 175 <b>isValid</b>(<i></i>)
176
139 <p> 177 <p>
140 Public method to determine validity. 178 Public method to determine validity.
141 </p><dl> 179 </p>
180 <dl>
142 <dt>Returns:</dt> 181 <dt>Returns:</dt>
143 <dd> 182 <dd>
144 flag indicating validity 183 flag indicating validity
145 </dd> 184 </dd>
146 </dl><dl> 185 </dl>
186 <dl>
147 <dt>Return Type:</dt> 187 <dt>Return Type:</dt>
148 <dd> 188 <dd>
149 bool 189 bool
150 </dd> 190 </dd>
151 </dl><a NAME="HistoryEntry.userTitle" ID="HistoryEntry.userTitle"></a> 191 </dl>
192 <a NAME="HistoryEntry.userTitle" ID="HistoryEntry.userTitle"></a>
152 <h4>HistoryEntry.userTitle</h4> 193 <h4>HistoryEntry.userTitle</h4>
153 <b>userTitle</b>(<i></i>) 194 <b>userTitle</b>(<i></i>)
195
154 <p> 196 <p>
155 Public method to get the title of the history entry. 197 Public method to get the title of the history entry.
156 </p><dl> 198 </p>
199 <dl>
157 <dt>Returns:</dt> 200 <dt>Returns:</dt>
158 <dd> 201 <dd>
159 title of the entry (string) 202 title of the entry (string)
160 </dd> 203 </dd>
161 </dl> 204 </dl>
162 <div align="right"><a href="#top">Up</a></div> 205 <div align="right"><a href="#top">Up</a></div>
163 <hr /><hr /> 206 <hr />
207 <hr />
164 <a NAME="HistoryManager" ID="HistoryManager"></a> 208 <a NAME="HistoryManager" ID="HistoryManager"></a>
165 <h2>HistoryManager</h2> 209 <h2>HistoryManager</h2>
210
166 <p> 211 <p>
167 Class implementing the history manager. 212 Class implementing the history manager.
168 </p><h3>Signals</h3> 213 </p>
169 <dl> 214 <h3>Signals</h3>
215 <dl>
216
170 <dt>entryAdded(HistoryEntry)</dt> 217 <dt>entryAdded(HistoryEntry)</dt>
171 <dd> 218 <dd>
172 emitted after a history entry has been 219 emitted after a history entry has been
173 added 220 added
174 </dd><dt>entryRemoved(HistoryEntry)</dt> 221 </dd>
222 <dt>entryRemoved(HistoryEntry)</dt>
175 <dd> 223 <dd>
176 emitted after a history entry has been 224 emitted after a history entry has been
177 removed 225 removed
178 </dd><dt>entryUpdated(int)</dt> 226 </dd>
227 <dt>entryUpdated(int)</dt>
179 <dd> 228 <dd>
180 emitted after a history entry has been updated 229 emitted after a history entry has been updated
181 </dd><dt>historyCleared()</dt> 230 </dd>
231 <dt>historyCleared()</dt>
182 <dd> 232 <dd>
183 emitted after the history has been cleared 233 emitted after the history has been cleared
184 </dd><dt>historyReset()</dt> 234 </dd>
235 <dt>historyReset()</dt>
185 <dd> 236 <dd>
186 emitted after the history has been reset 237 emitted after the history has been reset
187 </dd><dt>historySaved()</dt> 238 </dd>
239 <dt>historySaved()</dt>
188 <dd> 240 <dd>
189 emitted after the history was saved 241 emitted after the history was saved
190 </dd> 242 </dd>
191 </dl> 243 </dl>
192 <h3>Derived from</h3> 244 <h3>Derived from</h3>
193 QObject 245 QObject
194 <h3>Class Attributes</h3> 246 <h3>Class Attributes</h3>
247
195 <table> 248 <table>
196 <tr><td>None</td></tr> 249 <tr><td>None</td></tr>
197 </table> 250 </table>
198 <h3>Class Methods</h3> 251 <h3>Class Methods</h3>
252
199 <table> 253 <table>
200 <tr><td>None</td></tr> 254 <tr><td>None</td></tr>
201 </table> 255 </table>
202 <h3>Methods</h3> 256 <h3>Methods</h3>
203 <table> 257
258 <table>
259
204 <tr> 260 <tr>
205 <td><a href="#HistoryManager.__init__">HistoryManager</a></td> 261 <td><a href="#HistoryManager.__init__">HistoryManager</a></td>
206 <td>Constructor</td> 262 <td>Constructor</td>
207 </tr><tr> 263 </tr>
264 <tr>
208 <td><a href="#HistoryManager.__checkForExpired">__checkForExpired</a></td> 265 <td><a href="#HistoryManager.__checkForExpired">__checkForExpired</a></td>
209 <td>Private slot to check entries for expiration.</td> 266 <td>Private slot to check entries for expiration.</td>
210 </tr><tr> 267 </tr>
268 <tr>
211 <td><a href="#HistoryManager.__cleanUrl">__cleanUrl</a></td> 269 <td><a href="#HistoryManager.__cleanUrl">__cleanUrl</a></td>
212 <td>Private method to generate a clean URL usable for the history entry.</td> 270 <td>Private method to generate a clean URL usable for the history entry.</td>
213 </tr><tr> 271 </tr>
272 <tr>
214 <td><a href="#HistoryManager.__cleanUrlStr">__cleanUrlStr</a></td> 273 <td><a href="#HistoryManager.__cleanUrlStr">__cleanUrlStr</a></td>
215 <td>Private method to generate a clean URL usable for the history entry.</td> 274 <td>Private method to generate a clean URL usable for the history entry.</td>
216 </tr><tr> 275 </tr>
276 <tr>
217 <td><a href="#HistoryManager.__findFirstHistoryEntry">__findFirstHistoryEntry</a></td> 277 <td><a href="#HistoryManager.__findFirstHistoryEntry">__findFirstHistoryEntry</a></td>
218 <td>Private method to find the first entry for the given URL.</td> 278 <td>Private method to find the first entry for the given URL.</td>
219 </tr><tr> 279 </tr>
280 <tr>
220 <td><a href="#HistoryManager.__load">__load</a></td> 281 <td><a href="#HistoryManager.__load">__load</a></td>
221 <td>Private method to load the saved history entries from disk.</td> 282 <td>Private method to load the saved history entries from disk.</td>
222 </tr><tr> 283 </tr>
284 <tr>
223 <td><a href="#HistoryManager.__refreshFrequencies">__refreshFrequencies</a></td> 285 <td><a href="#HistoryManager.__refreshFrequencies">__refreshFrequencies</a></td>
224 <td>Private slot to recalculate the refresh frequencies.</td> 286 <td>Private slot to recalculate the refresh frequencies.</td>
225 </tr><tr> 287 </tr>
288 <tr>
226 <td><a href="#HistoryManager.__startFrequencyTimer">__startFrequencyTimer</a></td> 289 <td><a href="#HistoryManager.__startFrequencyTimer">__startFrequencyTimer</a></td>
227 <td>Private method to start the timer to recalculate the frequencies.</td> 290 <td>Private method to start the timer to recalculate the frequencies.</td>
228 </tr><tr> 291 </tr>
292 <tr>
229 <td><a href="#HistoryManager.__updateVisitCount">__updateVisitCount</a></td> 293 <td><a href="#HistoryManager.__updateVisitCount">__updateVisitCount</a></td>
230 <td>Private method to update the visit count for all entries of the given URL.</td> 294 <td>Private method to update the visit count for all entries of the given URL.</td>
231 </tr><tr> 295 </tr>
296 <tr>
232 <td><a href="#HistoryManager.addHistoryEntry">addHistoryEntry</a></td> 297 <td><a href="#HistoryManager.addHistoryEntry">addHistoryEntry</a></td>
233 <td>Public method to add a history entry.</td> 298 <td>Public method to add a history entry.</td>
234 </tr><tr> 299 </tr>
300 <tr>
235 <td><a href="#HistoryManager.clear">clear</a></td> 301 <td><a href="#HistoryManager.clear">clear</a></td>
236 <td>Public slot to clear the complete history.</td> 302 <td>Public slot to clear the complete history.</td>
237 </tr><tr> 303 </tr>
304 <tr>
238 <td><a href="#HistoryManager.close">close</a></td> 305 <td><a href="#HistoryManager.close">close</a></td>
239 <td>Public method to close the history manager.</td> 306 <td>Public method to close the history manager.</td>
240 </tr><tr> 307 </tr>
308 <tr>
241 <td><a href="#HistoryManager.daysToExpire">daysToExpire</a></td> 309 <td><a href="#HistoryManager.daysToExpire">daysToExpire</a></td>
242 <td>Public method to get the days for entry expiration.</td> 310 <td>Public method to get the days for entry expiration.</td>
243 </tr><tr> 311 </tr>
312 <tr>
244 <td><a href="#HistoryManager.getFileName">getFileName</a></td> 313 <td><a href="#HistoryManager.getFileName">getFileName</a></td>
245 <td>Public method to get the file name of the history file.</td> 314 <td>Public method to get the file name of the history file.</td>
246 </tr><tr> 315 </tr>
316 <tr>
247 <td><a href="#HistoryManager.history">history</a></td> 317 <td><a href="#HistoryManager.history">history</a></td>
248 <td>Public method to return the history.</td> 318 <td>Public method to return the history.</td>
249 </tr><tr> 319 </tr>
320 <tr>
250 <td><a href="#HistoryManager.historyFilterModel">historyFilterModel</a></td> 321 <td><a href="#HistoryManager.historyFilterModel">historyFilterModel</a></td>
251 <td>Public method to get a reference to the history filter model.</td> 322 <td>Public method to get a reference to the history filter model.</td>
252 </tr><tr> 323 </tr>
324 <tr>
253 <td><a href="#HistoryManager.historyModel">historyModel</a></td> 325 <td><a href="#HistoryManager.historyModel">historyModel</a></td>
254 <td>Public method to get a reference to the history model.</td> 326 <td>Public method to get a reference to the history model.</td>
255 </tr><tr> 327 </tr>
328 <tr>
256 <td><a href="#HistoryManager.historyTreeModel">historyTreeModel</a></td> 329 <td><a href="#HistoryManager.historyTreeModel">historyTreeModel</a></td>
257 <td>Public method to get a reference to the history tree model.</td> 330 <td>Public method to get a reference to the history tree model.</td>
258 </tr><tr> 331 </tr>
332 <tr>
259 <td><a href="#HistoryManager.preferencesChanged">preferencesChanged</a></td> 333 <td><a href="#HistoryManager.preferencesChanged">preferencesChanged</a></td>
260 <td>Public method to indicate a change of preferences.</td> 334 <td>Public method to indicate a change of preferences.</td>
261 </tr><tr> 335 </tr>
336 <tr>
262 <td><a href="#HistoryManager.reload">reload</a></td> 337 <td><a href="#HistoryManager.reload">reload</a></td>
263 <td>Public method to reload the history.</td> 338 <td>Public method to reload the history.</td>
264 </tr><tr> 339 </tr>
340 <tr>
265 <td><a href="#HistoryManager.removeHistoryEntry">removeHistoryEntry</a></td> 341 <td><a href="#HistoryManager.removeHistoryEntry">removeHistoryEntry</a></td>
266 <td>Public method to remove a history entry.</td> 342 <td>Public method to remove a history entry.</td>
267 </tr><tr> 343 </tr>
344 <tr>
268 <td><a href="#HistoryManager.save">save</a></td> 345 <td><a href="#HistoryManager.save">save</a></td>
269 <td>Public slot to save the history entries to disk.</td> 346 <td>Public slot to save the history entries to disk.</td>
270 </tr><tr> 347 </tr>
348 <tr>
271 <td><a href="#HistoryManager.setDaysToExpire">setDaysToExpire</a></td> 349 <td><a href="#HistoryManager.setDaysToExpire">setDaysToExpire</a></td>
272 <td>Public method to set the days for entry expiration.</td> 350 <td>Public method to set the days for entry expiration.</td>
273 </tr><tr> 351 </tr>
352 <tr>
274 <td><a href="#HistoryManager.setHistory">setHistory</a></td> 353 <td><a href="#HistoryManager.setHistory">setHistory</a></td>
275 <td>Public method to set a new history.</td> 354 <td>Public method to set a new history.</td>
276 </tr><tr> 355 </tr>
356 <tr>
277 <td><a href="#HistoryManager.siteVisitsCount">siteVisitsCount</a></td> 357 <td><a href="#HistoryManager.siteVisitsCount">siteVisitsCount</a></td>
278 <td>Public method to get the visit count for a web site using the given scheme.</td> 358 <td>Public method to get the visit count for a web site using the given scheme.</td>
279 </tr><tr> 359 </tr>
360 <tr>
280 <td><a href="#HistoryManager.updateHistoryEntry">updateHistoryEntry</a></td> 361 <td><a href="#HistoryManager.updateHistoryEntry">updateHistoryEntry</a></td>
281 <td>Public method to update a history entry.</td> 362 <td>Public method to update a history entry.</td>
282 </tr> 363 </tr>
283 </table> 364 </table>
284 <h3>Static Methods</h3> 365 <h3>Static Methods</h3>
366
285 <table> 367 <table>
286 <tr><td>None</td></tr> 368 <tr><td>None</td></tr>
287 </table> 369 </table>
370
288 <a NAME="HistoryManager.__init__" ID="HistoryManager.__init__"></a> 371 <a NAME="HistoryManager.__init__" ID="HistoryManager.__init__"></a>
289 <h4>HistoryManager (Constructor)</h4> 372 <h4>HistoryManager (Constructor)</h4>
290 <b>HistoryManager</b>(<i>parent=None</i>) 373 <b>HistoryManager</b>(<i>parent=None</i>)
374
291 <p> 375 <p>
292 Constructor 376 Constructor
293 </p><dl> 377 </p>
378 <dl>
379
294 <dt><i>parent</i></dt> 380 <dt><i>parent</i></dt>
295 <dd> 381 <dd>
296 reference to the parent object (QObject) 382 reference to the parent object (QObject)
297 </dd> 383 </dd>
298 </dl><a NAME="HistoryManager.__checkForExpired" ID="HistoryManager.__checkForExpired"></a> 384 </dl>
385 <a NAME="HistoryManager.__checkForExpired" ID="HistoryManager.__checkForExpired"></a>
299 <h4>HistoryManager.__checkForExpired</h4> 386 <h4>HistoryManager.__checkForExpired</h4>
300 <b>__checkForExpired</b>(<i></i>) 387 <b>__checkForExpired</b>(<i></i>)
388
301 <p> 389 <p>
302 Private slot to check entries for expiration. 390 Private slot to check entries for expiration.
303 </p><a NAME="HistoryManager.__cleanUrl" ID="HistoryManager.__cleanUrl"></a> 391 </p>
392 <a NAME="HistoryManager.__cleanUrl" ID="HistoryManager.__cleanUrl"></a>
304 <h4>HistoryManager.__cleanUrl</h4> 393 <h4>HistoryManager.__cleanUrl</h4>
305 <b>__cleanUrl</b>(<i>url</i>) 394 <b>__cleanUrl</b>(<i>url</i>)
395
306 <p> 396 <p>
307 Private method to generate a clean URL usable for the history entry. 397 Private method to generate a clean URL usable for the history entry.
308 </p><dl> 398 </p>
399 <dl>
400
309 <dt><i>url</i> (QUrl)</dt> 401 <dt><i>url</i> (QUrl)</dt>
310 <dd> 402 <dd>
311 original URL 403 original URL
312 </dd> 404 </dd>
313 </dl><dl> 405 </dl>
406 <dl>
314 <dt>Returns:</dt> 407 <dt>Returns:</dt>
315 <dd> 408 <dd>
316 cleaned URL 409 cleaned URL
317 </dd> 410 </dd>
318 </dl><dl> 411 </dl>
412 <dl>
319 <dt>Return Type:</dt> 413 <dt>Return Type:</dt>
320 <dd> 414 <dd>
321 QUrl 415 QUrl
322 </dd> 416 </dd>
323 </dl><a NAME="HistoryManager.__cleanUrlStr" ID="HistoryManager.__cleanUrlStr"></a> 417 </dl>
418 <a NAME="HistoryManager.__cleanUrlStr" ID="HistoryManager.__cleanUrlStr"></a>
324 <h4>HistoryManager.__cleanUrlStr</h4> 419 <h4>HistoryManager.__cleanUrlStr</h4>
325 <b>__cleanUrlStr</b>(<i>url</i>) 420 <b>__cleanUrlStr</b>(<i>url</i>)
421
326 <p> 422 <p>
327 Private method to generate a clean URL usable for the history entry. 423 Private method to generate a clean URL usable for the history entry.
328 </p><dl> 424 </p>
425 <dl>
426
329 <dt><i>url</i> (QUrl)</dt> 427 <dt><i>url</i> (QUrl)</dt>
330 <dd> 428 <dd>
331 original URL 429 original URL
332 </dd> 430 </dd>
333 </dl><dl> 431 </dl>
432 <dl>
334 <dt>Returns:</dt> 433 <dt>Returns:</dt>
335 <dd> 434 <dd>
336 cleaned URL 435 cleaned URL
337 </dd> 436 </dd>
338 </dl><dl> 437 </dl>
438 <dl>
339 <dt>Return Type:</dt> 439 <dt>Return Type:</dt>
340 <dd> 440 <dd>
341 str 441 str
342 </dd> 442 </dd>
343 </dl><a NAME="HistoryManager.__findFirstHistoryEntry" ID="HistoryManager.__findFirstHistoryEntry"></a> 443 </dl>
444 <a NAME="HistoryManager.__findFirstHistoryEntry" ID="HistoryManager.__findFirstHistoryEntry"></a>
344 <h4>HistoryManager.__findFirstHistoryEntry</h4> 445 <h4>HistoryManager.__findFirstHistoryEntry</h4>
345 <b>__findFirstHistoryEntry</b>(<i>url</i>) 446 <b>__findFirstHistoryEntry</b>(<i>url</i>)
447
346 <p> 448 <p>
347 Private method to find the first entry for the given URL. 449 Private method to find the first entry for the given URL.
348 </p><dl> 450 </p>
451 <dl>
452
349 <dt><i>url</i> (str)</dt> 453 <dt><i>url</i> (str)</dt>
350 <dd> 454 <dd>
351 URL to search for 455 URL to search for
352 </dd> 456 </dd>
353 </dl><dl> 457 </dl>
458 <dl>
354 <dt>Returns:</dt> 459 <dt>Returns:</dt>
355 <dd> 460 <dd>
356 first entry for the given URL 461 first entry for the given URL
357 </dd> 462 </dd>
358 </dl><dl> 463 </dl>
464 <dl>
359 <dt>Return Type:</dt> 465 <dt>Return Type:</dt>
360 <dd> 466 <dd>
361 HistoryEntry 467 HistoryEntry
362 </dd> 468 </dd>
363 </dl><a NAME="HistoryManager.__load" ID="HistoryManager.__load"></a> 469 </dl>
470 <a NAME="HistoryManager.__load" ID="HistoryManager.__load"></a>
364 <h4>HistoryManager.__load</h4> 471 <h4>HistoryManager.__load</h4>
365 <b>__load</b>(<i></i>) 472 <b>__load</b>(<i></i>)
473
366 <p> 474 <p>
367 Private method to load the saved history entries from disk. 475 Private method to load the saved history entries from disk.
368 </p><a NAME="HistoryManager.__refreshFrequencies" ID="HistoryManager.__refreshFrequencies"></a> 476 </p>
477 <a NAME="HistoryManager.__refreshFrequencies" ID="HistoryManager.__refreshFrequencies"></a>
369 <h4>HistoryManager.__refreshFrequencies</h4> 478 <h4>HistoryManager.__refreshFrequencies</h4>
370 <b>__refreshFrequencies</b>(<i></i>) 479 <b>__refreshFrequencies</b>(<i></i>)
480
371 <p> 481 <p>
372 Private slot to recalculate the refresh frequencies. 482 Private slot to recalculate the refresh frequencies.
373 </p><a NAME="HistoryManager.__startFrequencyTimer" ID="HistoryManager.__startFrequencyTimer"></a> 483 </p>
484 <a NAME="HistoryManager.__startFrequencyTimer" ID="HistoryManager.__startFrequencyTimer"></a>
374 <h4>HistoryManager.__startFrequencyTimer</h4> 485 <h4>HistoryManager.__startFrequencyTimer</h4>
375 <b>__startFrequencyTimer</b>(<i></i>) 486 <b>__startFrequencyTimer</b>(<i></i>)
487
376 <p> 488 <p>
377 Private method to start the timer to recalculate the frequencies. 489 Private method to start the timer to recalculate the frequencies.
378 </p><a NAME="HistoryManager.__updateVisitCount" ID="HistoryManager.__updateVisitCount"></a> 490 </p>
491 <a NAME="HistoryManager.__updateVisitCount" ID="HistoryManager.__updateVisitCount"></a>
379 <h4>HistoryManager.__updateVisitCount</h4> 492 <h4>HistoryManager.__updateVisitCount</h4>
380 <b>__updateVisitCount</b>(<i>url, count</i>) 493 <b>__updateVisitCount</b>(<i>url, count</i>)
494
381 <p> 495 <p>
382 Private method to update the visit count for all entries of the 496 Private method to update the visit count for all entries of the
383 given URL. 497 given URL.
384 </p><dl> 498 </p>
499 <dl>
500
385 <dt><i>url</i> (str)</dt> 501 <dt><i>url</i> (str)</dt>
386 <dd> 502 <dd>
387 URL to be updated 503 URL to be updated
388 </dd><dt><i>count</i> (int)</dt> 504 </dd>
505 <dt><i>count</i> (int)</dt>
389 <dd> 506 <dd>
390 new visit count 507 new visit count
391 </dd> 508 </dd>
392 </dl><a NAME="HistoryManager.addHistoryEntry" ID="HistoryManager.addHistoryEntry"></a> 509 </dl>
510 <a NAME="HistoryManager.addHistoryEntry" ID="HistoryManager.addHistoryEntry"></a>
393 <h4>HistoryManager.addHistoryEntry</h4> 511 <h4>HistoryManager.addHistoryEntry</h4>
394 <b>addHistoryEntry</b>(<i>view</i>) 512 <b>addHistoryEntry</b>(<i>view</i>)
513
395 <p> 514 <p>
396 Public method to add a history entry. 515 Public method to add a history entry.
397 </p><dl> 516 </p>
517 <dl>
518
398 <dt><i>view</i> (WebBrowserView)</dt> 519 <dt><i>view</i> (WebBrowserView)</dt>
399 <dd> 520 <dd>
400 reference to the view to add an entry for 521 reference to the view to add an entry for
401 </dd> 522 </dd>
402 </dl><a NAME="HistoryManager.clear" ID="HistoryManager.clear"></a> 523 </dl>
524 <a NAME="HistoryManager.clear" ID="HistoryManager.clear"></a>
403 <h4>HistoryManager.clear</h4> 525 <h4>HistoryManager.clear</h4>
404 <b>clear</b>(<i>period=0</i>) 526 <b>clear</b>(<i>period=0</i>)
527
405 <p> 528 <p>
406 Public slot to clear the complete history. 529 Public slot to clear the complete history.
407 </p><dl> 530 </p>
531 <dl>
532
408 <dt><i>period</i></dt> 533 <dt><i>period</i></dt>
409 <dd> 534 <dd>
410 history period in milliseconds to be cleared (integer) 535 history period in milliseconds to be cleared (integer)
411 </dd> 536 </dd>
412 </dl><a NAME="HistoryManager.close" ID="HistoryManager.close"></a> 537 </dl>
538 <a NAME="HistoryManager.close" ID="HistoryManager.close"></a>
413 <h4>HistoryManager.close</h4> 539 <h4>HistoryManager.close</h4>
414 <b>close</b>(<i></i>) 540 <b>close</b>(<i></i>)
541
415 <p> 542 <p>
416 Public method to close the history manager. 543 Public method to close the history manager.
417 </p><a NAME="HistoryManager.daysToExpire" ID="HistoryManager.daysToExpire"></a> 544 </p>
545 <a NAME="HistoryManager.daysToExpire" ID="HistoryManager.daysToExpire"></a>
418 <h4>HistoryManager.daysToExpire</h4> 546 <h4>HistoryManager.daysToExpire</h4>
419 <b>daysToExpire</b>(<i></i>) 547 <b>daysToExpire</b>(<i></i>)
548
420 <p> 549 <p>
421 Public method to get the days for entry expiration. 550 Public method to get the days for entry expiration.
422 </p><dl> 551 </p>
552 <dl>
423 <dt>Returns:</dt> 553 <dt>Returns:</dt>
424 <dd> 554 <dd>
425 days for entry expiration (integer) 555 days for entry expiration (integer)
426 </dd> 556 </dd>
427 </dl><a NAME="HistoryManager.getFileName" ID="HistoryManager.getFileName"></a> 557 </dl>
558 <a NAME="HistoryManager.getFileName" ID="HistoryManager.getFileName"></a>
428 <h4>HistoryManager.getFileName</h4> 559 <h4>HistoryManager.getFileName</h4>
429 <b>getFileName</b>(<i></i>) 560 <b>getFileName</b>(<i></i>)
561
430 <p> 562 <p>
431 Public method to get the file name of the history file. 563 Public method to get the file name of the history file.
432 </p><dl> 564 </p>
565 <dl>
433 <dt>Returns:</dt> 566 <dt>Returns:</dt>
434 <dd> 567 <dd>
435 name of the history file (string) 568 name of the history file (string)
436 </dd> 569 </dd>
437 </dl><a NAME="HistoryManager.history" ID="HistoryManager.history"></a> 570 </dl>
571 <a NAME="HistoryManager.history" ID="HistoryManager.history"></a>
438 <h4>HistoryManager.history</h4> 572 <h4>HistoryManager.history</h4>
439 <b>history</b>(<i></i>) 573 <b>history</b>(<i></i>)
574
440 <p> 575 <p>
441 Public method to return the history. 576 Public method to return the history.
442 </p><dl> 577 </p>
578 <dl>
443 <dt>Returns:</dt> 579 <dt>Returns:</dt>
444 <dd> 580 <dd>
445 reference to the list of history entries (list of HistoryEntry) 581 reference to the list of history entries (list of HistoryEntry)
446 </dd> 582 </dd>
447 </dl><a NAME="HistoryManager.historyFilterModel" ID="HistoryManager.historyFilterModel"></a> 583 </dl>
584 <a NAME="HistoryManager.historyFilterModel" ID="HistoryManager.historyFilterModel"></a>
448 <h4>HistoryManager.historyFilterModel</h4> 585 <h4>HistoryManager.historyFilterModel</h4>
449 <b>historyFilterModel</b>(<i></i>) 586 <b>historyFilterModel</b>(<i></i>)
587
450 <p> 588 <p>
451 Public method to get a reference to the history filter model. 589 Public method to get a reference to the history filter model.
452 </p><dl> 590 </p>
591 <dl>
453 <dt>Returns:</dt> 592 <dt>Returns:</dt>
454 <dd> 593 <dd>
455 reference to the history filter model (HistoryFilterModel) 594 reference to the history filter model (HistoryFilterModel)
456 </dd> 595 </dd>
457 </dl><a NAME="HistoryManager.historyModel" ID="HistoryManager.historyModel"></a> 596 </dl>
597 <a NAME="HistoryManager.historyModel" ID="HistoryManager.historyModel"></a>
458 <h4>HistoryManager.historyModel</h4> 598 <h4>HistoryManager.historyModel</h4>
459 <b>historyModel</b>(<i></i>) 599 <b>historyModel</b>(<i></i>)
600
460 <p> 601 <p>
461 Public method to get a reference to the history model. 602 Public method to get a reference to the history model.
462 </p><dl> 603 </p>
604 <dl>
463 <dt>Returns:</dt> 605 <dt>Returns:</dt>
464 <dd> 606 <dd>
465 reference to the history model (HistoryModel) 607 reference to the history model (HistoryModel)
466 </dd> 608 </dd>
467 </dl><a NAME="HistoryManager.historyTreeModel" ID="HistoryManager.historyTreeModel"></a> 609 </dl>
610 <a NAME="HistoryManager.historyTreeModel" ID="HistoryManager.historyTreeModel"></a>
468 <h4>HistoryManager.historyTreeModel</h4> 611 <h4>HistoryManager.historyTreeModel</h4>
469 <b>historyTreeModel</b>(<i></i>) 612 <b>historyTreeModel</b>(<i></i>)
613
470 <p> 614 <p>
471 Public method to get a reference to the history tree model. 615 Public method to get a reference to the history tree model.
472 </p><dl> 616 </p>
617 <dl>
473 <dt>Returns:</dt> 618 <dt>Returns:</dt>
474 <dd> 619 <dd>
475 reference to the history tree model (HistoryTreeModel) 620 reference to the history tree model (HistoryTreeModel)
476 </dd> 621 </dd>
477 </dl><a NAME="HistoryManager.preferencesChanged" ID="HistoryManager.preferencesChanged"></a> 622 </dl>
623 <a NAME="HistoryManager.preferencesChanged" ID="HistoryManager.preferencesChanged"></a>
478 <h4>HistoryManager.preferencesChanged</h4> 624 <h4>HistoryManager.preferencesChanged</h4>
479 <b>preferencesChanged</b>(<i></i>) 625 <b>preferencesChanged</b>(<i></i>)
626
480 <p> 627 <p>
481 Public method to indicate a change of preferences. 628 Public method to indicate a change of preferences.
482 </p><a NAME="HistoryManager.reload" ID="HistoryManager.reload"></a> 629 </p>
630 <a NAME="HistoryManager.reload" ID="HistoryManager.reload"></a>
483 <h4>HistoryManager.reload</h4> 631 <h4>HistoryManager.reload</h4>
484 <b>reload</b>(<i></i>) 632 <b>reload</b>(<i></i>)
633
485 <p> 634 <p>
486 Public method to reload the history. 635 Public method to reload the history.
487 </p><a NAME="HistoryManager.removeHistoryEntry" ID="HistoryManager.removeHistoryEntry"></a> 636 </p>
637 <a NAME="HistoryManager.removeHistoryEntry" ID="HistoryManager.removeHistoryEntry"></a>
488 <h4>HistoryManager.removeHistoryEntry</h4> 638 <h4>HistoryManager.removeHistoryEntry</h4>
489 <b>removeHistoryEntry</b>(<i>url, title=""</i>) 639 <b>removeHistoryEntry</b>(<i>url, title=""</i>)
640
490 <p> 641 <p>
491 Public method to remove a history entry. 642 Public method to remove a history entry.
492 </p><dl> 643 </p>
644 <dl>
645
493 <dt><i>url</i></dt> 646 <dt><i>url</i></dt>
494 <dd> 647 <dd>
495 URL of the entry to remove (QUrl) 648 URL of the entry to remove (QUrl)
496 </dd><dt><i>title</i></dt> 649 </dd>
650 <dt><i>title</i></dt>
497 <dd> 651 <dd>
498 title of the entry to remove (string) 652 title of the entry to remove (string)
499 </dd> 653 </dd>
500 </dl><a NAME="HistoryManager.save" ID="HistoryManager.save"></a> 654 </dl>
655 <a NAME="HistoryManager.save" ID="HistoryManager.save"></a>
501 <h4>HistoryManager.save</h4> 656 <h4>HistoryManager.save</h4>
502 <b>save</b>(<i></i>) 657 <b>save</b>(<i></i>)
658
503 <p> 659 <p>
504 Public slot to save the history entries to disk. 660 Public slot to save the history entries to disk.
505 </p><a NAME="HistoryManager.setDaysToExpire" ID="HistoryManager.setDaysToExpire"></a> 661 </p>
662 <a NAME="HistoryManager.setDaysToExpire" ID="HistoryManager.setDaysToExpire"></a>
506 <h4>HistoryManager.setDaysToExpire</h4> 663 <h4>HistoryManager.setDaysToExpire</h4>
507 <b>setDaysToExpire</b>(<i>limit</i>) 664 <b>setDaysToExpire</b>(<i>limit</i>)
665
508 <p> 666 <p>
509 Public method to set the days for entry expiration. 667 Public method to set the days for entry expiration.
510 </p><dl> 668 </p>
669 <dl>
670
511 <dt><i>limit</i></dt> 671 <dt><i>limit</i></dt>
512 <dd> 672 <dd>
513 days for entry expiration (integer) 673 days for entry expiration (integer)
514 </dd> 674 </dd>
515 </dl><a NAME="HistoryManager.setHistory" ID="HistoryManager.setHistory"></a> 675 </dl>
676 <a NAME="HistoryManager.setHistory" ID="HistoryManager.setHistory"></a>
516 <h4>HistoryManager.setHistory</h4> 677 <h4>HistoryManager.setHistory</h4>
517 <b>setHistory</b>(<i>history, loadedAndSorted=False</i>) 678 <b>setHistory</b>(<i>history, loadedAndSorted=False</i>)
679
518 <p> 680 <p>
519 Public method to set a new history. 681 Public method to set a new history.
520 </p><dl> 682 </p>
683 <dl>
684
521 <dt><i>history</i></dt> 685 <dt><i>history</i></dt>
522 <dd> 686 <dd>
523 reference to the list of history entries to be set 687 reference to the list of history entries to be set
524 (list of HistoryEntry) 688 (list of HistoryEntry)
525 </dd><dt><i>loadedAndSorted</i></dt> 689 </dd>
690 <dt><i>loadedAndSorted</i></dt>
526 <dd> 691 <dd>
527 flag indicating that the list is sorted 692 flag indicating that the list is sorted
528 (boolean) 693 (boolean)
529 </dd> 694 </dd>
530 </dl><a NAME="HistoryManager.siteVisitsCount" ID="HistoryManager.siteVisitsCount"></a> 695 </dl>
696 <a NAME="HistoryManager.siteVisitsCount" ID="HistoryManager.siteVisitsCount"></a>
531 <h4>HistoryManager.siteVisitsCount</h4> 697 <h4>HistoryManager.siteVisitsCount</h4>
532 <b>siteVisitsCount</b>(<i>scheme, host</i>) 698 <b>siteVisitsCount</b>(<i>scheme, host</i>)
699
533 <p> 700 <p>
534 Public method to get the visit count for a web site using the given 701 Public method to get the visit count for a web site using the given
535 scheme. 702 scheme.
536 </p><dl> 703 </p>
704 <dl>
705
537 <dt><i>scheme</i> (str)</dt> 706 <dt><i>scheme</i> (str)</dt>
538 <dd> 707 <dd>
539 scheme to look for 708 scheme to look for
540 </dd><dt><i>host</i> (str)</dt> 709 </dd>
710 <dt><i>host</i> (str)</dt>
541 <dd> 711 <dd>
542 host to look for 712 host to look for
543 </dd> 713 </dd>
544 </dl><dl> 714 </dl>
715 <dl>
545 <dt>Returns:</dt> 716 <dt>Returns:</dt>
546 <dd> 717 <dd>
547 number of visits to this site 718 number of visits to this site
548 </dd> 719 </dd>
549 </dl><dl> 720 </dl>
721 <dl>
550 <dt>Return Type:</dt> 722 <dt>Return Type:</dt>
551 <dd> 723 <dd>
552 int 724 int
553 </dd> 725 </dd>
554 </dl><a NAME="HistoryManager.updateHistoryEntry" ID="HistoryManager.updateHistoryEntry"></a> 726 </dl>
727 <a NAME="HistoryManager.updateHistoryEntry" ID="HistoryManager.updateHistoryEntry"></a>
555 <h4>HistoryManager.updateHistoryEntry</h4> 728 <h4>HistoryManager.updateHistoryEntry</h4>
556 <b>updateHistoryEntry</b>(<i>url, title</i>) 729 <b>updateHistoryEntry</b>(<i>url, title</i>)
730
557 <p> 731 <p>
558 Public method to update a history entry. 732 Public method to update a history entry.
559 </p><dl> 733 </p>
734 <dl>
735
560 <dt><i>url</i></dt> 736 <dt><i>url</i></dt>
561 <dd> 737 <dd>
562 URL of the entry to update (string) 738 URL of the entry to update (string)
563 </dd><dt><i>title</i></dt> 739 </dd>
740 <dt><i>title</i></dt>
564 <dd> 741 <dd>
565 title of the entry to update (string) 742 title of the entry to update (string)
566 </dd> 743 </dd>
567 </dl> 744 </dl>
568 <div align="right"><a href="#top">Up</a></div> 745 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial