--- a/src/eric7/Documentation/Source/eric7.WebBrowser.History.HistoryManager.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.History.HistoryManager.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,19 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.History.HistoryManager</h1>
-
<p>
Module implementing the history manager.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>HISTORY_VERSIONS</td></tr><tr><td>HISTORY_VERSION_42</td></tr><tr><td>HISTORY_VERSION_60</td></tr>
+<tr><td>HISTORY_VERSIONS</td></tr>
+<tr><td>HISTORY_VERSION_42</td></tr>
+<tr><td>HISTORY_VERSION_60</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#HistoryEntry">HistoryEntry</a></td>
<td>Class implementing a history entry.</td>
@@ -29,35 +29,34 @@
<td>Class implementing the history manager.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="HistoryEntry" ID="HistoryEntry"></a>
<h2>HistoryEntry</h2>
-
<p>
Class implementing a history entry.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#HistoryEntry.__init__">HistoryEntry</a></td>
<td>Constructor</td>
@@ -79,19 +78,20 @@
<td>Public method to get the title of the history entry.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HistoryEntry.__init__" ID="HistoryEntry.__init__"></a>
<h4>HistoryEntry (Constructor)</h4>
<b>HistoryEntry</b>(<i>url=None, dateTime=None, title=None, visitCount=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>url</i> (str)</dt>
@@ -114,10 +114,10 @@
<a NAME="HistoryEntry.__eq__" ID="HistoryEntry.__eq__"></a>
<h4>HistoryEntry.__eq__</h4>
<b>__eq__</b>(<i>other</i>)
-
<p>
Special method determining equality.
</p>
+
<dl>
<dt><i>other</i> (HistoryEntry)</dt>
@@ -140,13 +140,13 @@
<a NAME="HistoryEntry.__lt__" ID="HistoryEntry.__lt__"></a>
<h4>HistoryEntry.__lt__</h4>
<b>__lt__</b>(<i>other</i>)
-
<p>
Special method determining less relation.
</p>
<p>
Note: History is sorted in reverse order by date and time
</p>
+
<dl>
<dt><i>other</i> (HistoryEntry)</dt>
@@ -169,10 +169,10 @@
<a NAME="HistoryEntry.isValid" ID="HistoryEntry.isValid"></a>
<h4>HistoryEntry.isValid</h4>
<b>isValid</b>(<i></i>)
-
<p>
Public method to determine validity.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -188,10 +188,10 @@
<a NAME="HistoryEntry.userTitle" ID="HistoryEntry.userTitle"></a>
<h4>HistoryEntry.userTitle</h4>
<b>userTitle</b>(<i></i>)
-
<p>
Public method to get the title of the history entry.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -209,10 +209,10 @@
<hr />
<a NAME="HistoryManager" ID="HistoryManager"></a>
<h2>HistoryManager</h2>
-
<p>
Class implementing the history manager.
</p>
+
<h3>Signals</h3>
<dl>
@@ -246,19 +246,17 @@
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#HistoryManager.__init__">HistoryManager</a></td>
<td>Constructor</td>
@@ -364,19 +362,20 @@
<td>Public method to update a history entry.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HistoryManager.__init__" ID="HistoryManager.__init__"></a>
<h4>HistoryManager (Constructor)</h4>
<b>HistoryManager</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -387,17 +386,17 @@
<a NAME="HistoryManager.__checkForExpired" ID="HistoryManager.__checkForExpired"></a>
<h4>HistoryManager.__checkForExpired</h4>
<b>__checkForExpired</b>(<i></i>)
-
<p>
Private slot to check entries for expiration.
</p>
+
<a NAME="HistoryManager.__cleanUrl" ID="HistoryManager.__cleanUrl"></a>
<h4>HistoryManager.__cleanUrl</h4>
<b>__cleanUrl</b>(<i>url</i>)
-
<p>
Private method to generate a clean URL usable for the history entry.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -420,10 +419,10 @@
<a NAME="HistoryManager.__cleanUrlStr" ID="HistoryManager.__cleanUrlStr"></a>
<h4>HistoryManager.__cleanUrlStr</h4>
<b>__cleanUrlStr</b>(<i>url</i>)
-
<p>
Private method to generate a clean URL usable for the history entry.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -446,10 +445,10 @@
<a NAME="HistoryManager.__findFirstHistoryEntry" ID="HistoryManager.__findFirstHistoryEntry"></a>
<h4>HistoryManager.__findFirstHistoryEntry</h4>
<b>__findFirstHistoryEntry</b>(<i>url</i>)
-
<p>
Private method to find the first entry for the given URL.
</p>
+
<dl>
<dt><i>url</i> (str)</dt>
@@ -472,32 +471,32 @@
<a NAME="HistoryManager.__load" ID="HistoryManager.__load"></a>
<h4>HistoryManager.__load</h4>
<b>__load</b>(<i></i>)
-
<p>
Private method to load the saved history entries from disk.
</p>
+
<a NAME="HistoryManager.__refreshFrequencies" ID="HistoryManager.__refreshFrequencies"></a>
<h4>HistoryManager.__refreshFrequencies</h4>
<b>__refreshFrequencies</b>(<i></i>)
-
<p>
Private slot to recalculate the refresh frequencies.
</p>
+
<a NAME="HistoryManager.__startFrequencyTimer" ID="HistoryManager.__startFrequencyTimer"></a>
<h4>HistoryManager.__startFrequencyTimer</h4>
<b>__startFrequencyTimer</b>(<i></i>)
-
<p>
Private method to start the timer to recalculate the frequencies.
</p>
+
<a NAME="HistoryManager.__updateVisitCount" ID="HistoryManager.__updateVisitCount"></a>
<h4>HistoryManager.__updateVisitCount</h4>
<b>__updateVisitCount</b>(<i>url, count</i>)
-
<p>
Private method to update the visit count for all entries of the
given URL.
</p>
+
<dl>
<dt><i>url</i> (str)</dt>
@@ -512,10 +511,10 @@
<a NAME="HistoryManager.addHistoryEntry" ID="HistoryManager.addHistoryEntry"></a>
<h4>HistoryManager.addHistoryEntry</h4>
<b>addHistoryEntry</b>(<i>view</i>)
-
<p>
Public method to add a history entry.
</p>
+
<dl>
<dt><i>view</i> (WebBrowserView)</dt>
@@ -526,10 +525,10 @@
<a NAME="HistoryManager.clear" ID="HistoryManager.clear"></a>
<h4>HistoryManager.clear</h4>
<b>clear</b>(<i>period=0</i>)
-
<p>
Public slot to clear the complete history.
</p>
+
<dl>
<dt><i>period</i> (int)</dt>
@@ -540,17 +539,17 @@
<a NAME="HistoryManager.close" ID="HistoryManager.close"></a>
<h4>HistoryManager.close</h4>
<b>close</b>(<i></i>)
-
<p>
Public method to close the history manager.
</p>
+
<a NAME="HistoryManager.daysToExpire" ID="HistoryManager.daysToExpire"></a>
<h4>HistoryManager.daysToExpire</h4>
<b>daysToExpire</b>(<i></i>)
-
<p>
Public method to get the days for entry expiration.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -566,10 +565,10 @@
<a NAME="HistoryManager.getFileName" ID="HistoryManager.getFileName"></a>
<h4>HistoryManager.getFileName</h4>
<b>getFileName</b>(<i></i>)
-
<p>
Public method to get the file name of the history file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -585,10 +584,10 @@
<a NAME="HistoryManager.history" ID="HistoryManager.history"></a>
<h4>HistoryManager.history</h4>
<b>history</b>(<i></i>)
-
<p>
Public method to return the history.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -604,10 +603,10 @@
<a NAME="HistoryManager.historyFilterModel" ID="HistoryManager.historyFilterModel"></a>
<h4>HistoryManager.historyFilterModel</h4>
<b>historyFilterModel</b>(<i></i>)
-
<p>
Public method to get a reference to the history filter model.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -623,10 +622,10 @@
<a NAME="HistoryManager.historyModel" ID="HistoryManager.historyModel"></a>
<h4>HistoryManager.historyModel</h4>
<b>historyModel</b>(<i></i>)
-
<p>
Public method to get a reference to the history model.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -642,10 +641,10 @@
<a NAME="HistoryManager.historyTreeModel" ID="HistoryManager.historyTreeModel"></a>
<h4>HistoryManager.historyTreeModel</h4>
<b>historyTreeModel</b>(<i></i>)
-
<p>
Public method to get a reference to the history tree model.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -661,24 +660,24 @@
<a NAME="HistoryManager.preferencesChanged" ID="HistoryManager.preferencesChanged"></a>
<h4>HistoryManager.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public method to indicate a change of preferences.
</p>
+
<a NAME="HistoryManager.reload" ID="HistoryManager.reload"></a>
<h4>HistoryManager.reload</h4>
<b>reload</b>(<i></i>)
-
<p>
Public method to reload the history.
</p>
+
<a NAME="HistoryManager.removeHistoryEntry" ID="HistoryManager.removeHistoryEntry"></a>
<h4>HistoryManager.removeHistoryEntry</h4>
<b>removeHistoryEntry</b>(<i>url, title=""</i>)
-
<p>
Public method to remove a history entry.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -693,17 +692,17 @@
<a NAME="HistoryManager.save" ID="HistoryManager.save"></a>
<h4>HistoryManager.save</h4>
<b>save</b>(<i></i>)
-
<p>
Public slot to save the history entries to disk.
</p>
+
<a NAME="HistoryManager.setDaysToExpire" ID="HistoryManager.setDaysToExpire"></a>
<h4>HistoryManager.setDaysToExpire</h4>
<b>setDaysToExpire</b>(<i>limit</i>)
-
<p>
Public method to set the days for entry expiration.
</p>
+
<dl>
<dt><i>limit</i> (int)</dt>
@@ -714,10 +713,10 @@
<a NAME="HistoryManager.setHistory" ID="HistoryManager.setHistory"></a>
<h4>HistoryManager.setHistory</h4>
<b>setHistory</b>(<i>history, loadedAndSorted=False</i>)
-
<p>
Public method to set a new history.
</p>
+
<dl>
<dt><i>history</i> (list of HistoryEntry)</dt>
@@ -732,11 +731,11 @@
<a NAME="HistoryManager.siteVisitsCount" ID="HistoryManager.siteVisitsCount"></a>
<h4>HistoryManager.siteVisitsCount</h4>
<b>siteVisitsCount</b>(<i>scheme, host</i>)
-
<p>
Public method to get the visit count for a web site using the given
scheme.
</p>
+
<dl>
<dt><i>scheme</i> (str)</dt>
@@ -763,10 +762,10 @@
<a NAME="HistoryManager.updateHistoryEntry" ID="HistoryManager.updateHistoryEntry"></a>
<h4>HistoryManager.updateHistoryEntry</h4>
<b>updateHistoryEntry</b>(<i>url, title</i>)
-
<p>
Public method to update a history entry.
</p>
+
<dl>
<dt><i>url</i> (str)</dt>
@@ -780,4 +779,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
