--- a/src/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarksWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarksWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.HelpViewer.HelpBookmarksWidget</h1>
-
<p>
Module implementing a widget showing the list of bookmarks.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#HelpBookmarksWidget">HelpBookmarksWidget</a></td>
<td>Class implementing a widget showing the list of bookmarks.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="HelpBookmarksWidget" ID="HelpBookmarksWidget"></a>
<h2>HelpBookmarksWidget</h2>
-
<p>
Class implementing a widget showing the list of bookmarks.
</p>
+
<h3>Signals</h3>
<dl>
@@ -62,19 +61,17 @@
<h3>Derived from</h3>
QListWidget
<h3>Class Attributes</h3>
-
<table>
<tr><td>UrlRole</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#HelpBookmarksWidget.__init__">HelpBookmarksWidget</a></td>
<td>Constructor</td>
@@ -144,19 +141,20 @@
<td>Public slot to add a bookmark with given data.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HelpBookmarksWidget.__init__" ID="HelpBookmarksWidget.__init__"></a>
<h4>HelpBookmarksWidget (Constructor)</h4>
<b>HelpBookmarksWidget</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget (optional))</dt>
@@ -167,10 +165,10 @@
<a NAME="HelpBookmarksWidget.__addBookmark" ID="HelpBookmarksWidget.__addBookmark"></a>
<h4>HelpBookmarksWidget.__addBookmark</h4>
<b>__addBookmark</b>(<i>title, url</i>)
-
<p>
Private slot to add a bookmark entry.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -185,10 +183,10 @@
<a NAME="HelpBookmarksWidget.__bookmarkActivated" ID="HelpBookmarksWidget.__bookmarkActivated"></a>
<h4>HelpBookmarksWidget.__bookmarkActivated</h4>
<b>__bookmarkActivated</b>(<i>itm</i>)
-
<p>
Private slot handling the activation of a bookmark.
</p>
+
<dl>
<dt><i>itm</i> (QListWidgetItem)</dt>
@@ -199,17 +197,17 @@
<a NAME="HelpBookmarksWidget.__bookmarkCurrentPage" ID="HelpBookmarksWidget.__bookmarkCurrentPage"></a>
<h4>HelpBookmarksWidget.__bookmarkCurrentPage</h4>
<b>__bookmarkCurrentPage</b>(<i></i>)
-
<p>
Private slot to bookmark the current page.
</p>
+
<a NAME="HelpBookmarksWidget.__deleteBookmarks" ID="HelpBookmarksWidget.__deleteBookmarks"></a>
<h4>HelpBookmarksWidget.__deleteBookmarks</h4>
<b>__deleteBookmarks</b>(<i>items</i>)
-
<p>
Private method to delete the given bookmark items.
</p>
+
<dl>
<dt><i>items</i> (list of QListWidgetItem)</dt>
@@ -220,10 +218,10 @@
<a NAME="HelpBookmarksWidget.__editBookmark" ID="HelpBookmarksWidget.__editBookmark"></a>
<h4>HelpBookmarksWidget.__editBookmark</h4>
<b>__editBookmark</b>(<i>itm</i>)
-
<p>
Private slot to edit a bookmark.
</p>
+
<dl>
<dt><i>itm</i> (QListWidgetItem)</dt>
@@ -234,10 +232,10 @@
<a NAME="HelpBookmarksWidget.__exportBookmarks" ID="HelpBookmarksWidget.__exportBookmarks"></a>
<h4>HelpBookmarksWidget.__exportBookmarks</h4>
<b>__exportBookmarks</b>(<i>selected=False</i>)
-
<p>
Private slot to export the bookmarks into a JSON file.
</p>
+
<dl>
<dt><i>selected</i> (bool (optional))</dt>
@@ -249,31 +247,31 @@
<a NAME="HelpBookmarksWidget.__importBookmarks" ID="HelpBookmarksWidget.__importBookmarks"></a>
<h4>HelpBookmarksWidget.__importBookmarks</h4>
<b>__importBookmarks</b>(<i></i>)
-
<p>
Private slot to import bookmarks from a JSON file.
</p>
+
<a NAME="HelpBookmarksWidget.__loadBookmarks" ID="HelpBookmarksWidget.__loadBookmarks"></a>
<h4>HelpBookmarksWidget.__loadBookmarks</h4>
<b>__loadBookmarks</b>(<i></i>)
-
<p>
Private method to load the defined bookmarks.
</p>
+
<a NAME="HelpBookmarksWidget.__newBookmark" ID="HelpBookmarksWidget.__newBookmark"></a>
<h4>HelpBookmarksWidget.__newBookmark</h4>
<b>__newBookmark</b>(<i></i>)
-
<p>
Private slot to create a new bookmark.
</p>
+
<a NAME="HelpBookmarksWidget.__openBookmarks" ID="HelpBookmarksWidget.__openBookmarks"></a>
<h4>HelpBookmarksWidget.__openBookmarks</h4>
<b>__openBookmarks</b>(<i>selected=False</i>)
-
<p>
Private method to open all or selected bookmarks.
</p>
+
<dl>
<dt><i>selected</i> (bool (optional))</dt>
@@ -285,17 +283,17 @@
<a NAME="HelpBookmarksWidget.__saveBookmarks" ID="HelpBookmarksWidget.__saveBookmarks"></a>
<h4>HelpBookmarksWidget.__saveBookmarks</h4>
<b>__saveBookmarks</b>(<i></i>)
-
<p>
Private method to save the defined bookmarks.
</p>
+
<a NAME="HelpBookmarksWidget.__showBackgroundMenu" ID="HelpBookmarksWidget.__showBackgroundMenu"></a>
<h4>HelpBookmarksWidget.__showBackgroundMenu</h4>
<b>__showBackgroundMenu</b>(<i>point</i>)
-
<p>
Private slot to show the background menu (i.e. no selection).
</p>
+
<dl>
<dt><i>point</i> (QPoint)</dt>
@@ -306,10 +304,10 @@
<a NAME="HelpBookmarksWidget.__showBookmarkContextMenu" ID="HelpBookmarksWidget.__showBookmarkContextMenu"></a>
<h4>HelpBookmarksWidget.__showBookmarkContextMenu</h4>
<b>__showBookmarkContextMenu</b>(<i>point</i>)
-
<p>
Private slot to show the context menu for a bookmark.
</p>
+
<dl>
<dt><i>point</i> (QPoint)</dt>
@@ -320,10 +318,10 @@
<a NAME="HelpBookmarksWidget.__showBookmarksContextMenu" ID="HelpBookmarksWidget.__showBookmarksContextMenu"></a>
<h4>HelpBookmarksWidget.__showBookmarksContextMenu</h4>
<b>__showBookmarksContextMenu</b>(<i>point</i>)
-
<p>
Private slot to show the context menu for multiple bookmark.
</p>
+
<dl>
<dt><i>point</i> (QPoint)</dt>
@@ -334,11 +332,11 @@
<a NAME="HelpBookmarksWidget.__showContextMenu" ID="HelpBookmarksWidget.__showContextMenu"></a>
<h4>HelpBookmarksWidget.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>point</i>)
-
<p>
Private slot to handle the customContextMenuRequested signal of
the viewlist.
</p>
+
<dl>
<dt><i>point</i> (QPoint)</dt>
@@ -349,10 +347,10 @@
<a NAME="HelpBookmarksWidget.addBookmark" ID="HelpBookmarksWidget.addBookmark"></a>
<h4>HelpBookmarksWidget.addBookmark</h4>
<b>addBookmark</b>(<i>title, url</i>)
-
<p>
Public slot to add a bookmark with given data.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -366,4 +364,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
