Wed, 05 Jan 2022 17:28:05 +0100
Updated source documentation.
--- a/eric7/APIs/Python3/eric7.api Wed Jan 05 17:26:04 2022 +0100 +++ b/eric7/APIs/Python3/eric7.api Wed Jan 05 17:28:05 2022 +0100 @@ -2083,6 +2083,17 @@ eric7.Graphics.UMLItem.UMLModel?1(name) eric7.Graphics.UMLSceneSizeDialog.UMLSceneSizeDialog.getData?4() eric7.Graphics.UMLSceneSizeDialog.UMLSceneSizeDialog?1(w, h, minW, minH, parent=None, name=None) +eric7.HelpViewer.HelpBookmarkPropertiesDialog.HelpBookmarkPropertiesDialog.getData?4() +eric7.HelpViewer.HelpBookmarkPropertiesDialog.HelpBookmarkPropertiesDialog?1(title="", url="", parent=None) +eric7.HelpViewer.HelpBookmarksImportDialog.HelpBookmarksImportDialog.getData?4() +eric7.HelpViewer.HelpBookmarksImportDialog.HelpBookmarksImportDialog?1(parent=None) +eric7.HelpViewer.HelpBookmarksWidget.HelpBookmarksWidget.UrlRole?7 +eric7.HelpViewer.HelpBookmarksWidget.HelpBookmarksWidget.addBookmark?4(title, url) +eric7.HelpViewer.HelpBookmarksWidget.HelpBookmarksWidget.escapePressed?7 +eric7.HelpViewer.HelpBookmarksWidget.HelpBookmarksWidget.newBackgroundTab?7 +eric7.HelpViewer.HelpBookmarksWidget.HelpBookmarksWidget.newTab?7 +eric7.HelpViewer.HelpBookmarksWidget.HelpBookmarksWidget.openUrl?7 +eric7.HelpViewer.HelpBookmarksWidget.HelpBookmarksWidget?1(parent=None) eric7.HelpViewer.HelpViewerImpl.HelpViewerImpl.gotoHistory?4(index) eric7.HelpViewer.HelpViewerImpl.HelpViewerImpl.isBackwardAvailable?4() eric7.HelpViewer.HelpViewerImpl.HelpViewerImpl.isEmptyPage?4() @@ -2161,6 +2172,7 @@ eric7.HelpViewer.HelpViewerWidget.HelpViewerWidget.MaxHistoryItems?7 eric7.HelpViewer.HelpViewerWidget.HelpViewerWidget.activate?4(searchWord=None, url=None) eric7.HelpViewer.HelpViewerWidget.HelpViewerWidget.addPage?4(url=None, background=False) +eric7.HelpViewer.HelpViewerWidget.HelpViewerWidget.bookmarkPage?4(title, url) eric7.HelpViewer.HelpViewerWidget.HelpViewerWidget.closeAllPages?4() eric7.HelpViewer.HelpViewerWidget.HelpViewerWidget.closeCurrentPage?4() eric7.HelpViewer.HelpViewerWidget.HelpViewerWidget.closeOtherPages?4() @@ -2181,7 +2193,7 @@ eric7.HelpViewer.OpenPagesWidget.OpenPagesWidget.closeAllPages?4() eric7.HelpViewer.OpenPagesWidget.OpenPagesWidget.closeCurrentPage?4() eric7.HelpViewer.OpenPagesWidget.OpenPagesWidget.closeOtherPages?4() -eric7.HelpViewer.OpenPagesWidget.OpenPagesWidget.currentChanged?7 +eric7.HelpViewer.OpenPagesWidget.OpenPagesWidget.currentPageChanged?7 eric7.HelpViewer.OpenPagesWidget.OpenPagesWidget.insertPage?4(index, viewer, background=False) eric7.HelpViewer.OpenPagesWidget.OpenPagesWidget?1(stack, parent=None) eric7.HexEdit.HexEditChunks.HexEditChunk?1()
--- a/eric7/APIs/Python3/eric7.bas Wed Jan 05 17:26:04 2022 +0100 +++ b/eric7/APIs/Python3/eric7.bas Wed Jan 05 17:28:05 2022 +0100 @@ -411,6 +411,9 @@ GreaseMonkeyManager QObject GreaseMonkeyScript QObject GroupEnum enum.IntEnum +HelpBookmarkPropertiesDialog QDialog Ui_HelpBookmarkPropertiesDialog +HelpBookmarksImportDialog QDialog Ui_HelpBookmarksImportDialog +HelpBookmarksWidget QListWidget HelpDocsInstaller QThread HelpDocumentationPage ConfigurationPageBase Ui_HelpDocumentationPage HelpIndexWidget QWidget @@ -666,7 +669,7 @@ NsHtmlReader QObject NsHtmlWriter QObject NumbersWidget QWidget Ui_NumbersWidget -OpenPagesWidget QWidget +OpenPagesWidget QListWidget OpenSearchDialog QDialog Ui_OpenSearchDialog OpenSearchEditDialog QDialog Ui_OpenSearchEditDialog OpenSearchEngine QObject
--- a/eric7/Documentation/Help/source.qhp Wed Jan 05 17:26:04 2022 +0100 +++ b/eric7/Documentation/Help/source.qhp Wed Jan 05 17:28:05 2022 +0100 @@ -214,6 +214,9 @@ <section title="eric7.Graphics.UMLSceneSizeDialog" ref="eric7.Graphics.UMLSceneSizeDialog.html" /> </section> <section title="eric7.HelpViewer" ref="index-eric7.HelpViewer.html"> + <section title="eric7.HelpViewer.HelpBookmarkPropertiesDialog" ref="eric7.HelpViewer.HelpBookmarkPropertiesDialog.html" /> + <section title="eric7.HelpViewer.HelpBookmarksImportDialog" ref="eric7.HelpViewer.HelpBookmarksImportDialog.html" /> + <section title="eric7.HelpViewer.HelpBookmarksWidget" ref="eric7.HelpViewer.HelpBookmarksWidget.html" /> <section title="eric7.HelpViewer.HelpViewerImpl" ref="eric7.HelpViewer.HelpViewerImpl.html" /> <section title="eric7.HelpViewer.HelpViewerImplQTB" ref="eric7.HelpViewer.HelpViewerImplQTB.html" /> <section title="eric7.HelpViewer.HelpViewerImplQWE" ref="eric7.HelpViewer.HelpViewerImplQWE.html" /> @@ -7175,6 +7178,35 @@ <keyword name="HashPrefixList (Constructor)" id="HashPrefixList (Constructor)" ref="eric7.WebBrowser.SafeBrowsing.SafeBrowsingThreatList.html#HashPrefixList.__init__" /> <keyword name="HashPrefixList.__iter__" id="HashPrefixList.__iter__" ref="eric7.WebBrowser.SafeBrowsing.SafeBrowsingThreatList.html#HashPrefixList.__iter__" /> <keyword name="HashPrefixList.__len__" id="HashPrefixList.__len__" ref="eric7.WebBrowser.SafeBrowsing.SafeBrowsingThreatList.html#HashPrefixList.__len__" /> + <keyword name="HelpBookmarkPropertiesDialog" id="HelpBookmarkPropertiesDialog" ref="eric7.HelpViewer.HelpBookmarkPropertiesDialog.html#HelpBookmarkPropertiesDialog" /> + <keyword name="HelpBookmarkPropertiesDialog (Constructor)" id="HelpBookmarkPropertiesDialog (Constructor)" ref="eric7.HelpViewer.HelpBookmarkPropertiesDialog.html#HelpBookmarkPropertiesDialog.__init__" /> + <keyword name="HelpBookmarkPropertiesDialog (Module)" id="HelpBookmarkPropertiesDialog (Module)" ref="eric7.HelpViewer.HelpBookmarkPropertiesDialog.html" /> + <keyword name="HelpBookmarkPropertiesDialog.__updateOkButton" id="HelpBookmarkPropertiesDialog.__updateOkButton" ref="eric7.HelpViewer.HelpBookmarkPropertiesDialog.html#HelpBookmarkPropertiesDialog.__updateOkButton" /> + <keyword name="HelpBookmarkPropertiesDialog.getData" id="HelpBookmarkPropertiesDialog.getData" ref="eric7.HelpViewer.HelpBookmarkPropertiesDialog.html#HelpBookmarkPropertiesDialog.getData" /> + <keyword name="HelpBookmarksImportDialog" id="HelpBookmarksImportDialog" ref="eric7.HelpViewer.HelpBookmarksImportDialog.html#HelpBookmarksImportDialog" /> + <keyword name="HelpBookmarksImportDialog (Constructor)" id="HelpBookmarksImportDialog (Constructor)" ref="eric7.HelpViewer.HelpBookmarksImportDialog.html#HelpBookmarksImportDialog.__init__" /> + <keyword name="HelpBookmarksImportDialog (Module)" id="HelpBookmarksImportDialog (Module)" ref="eric7.HelpViewer.HelpBookmarksImportDialog.html" /> + <keyword name="HelpBookmarksImportDialog.__updateOkButton" id="HelpBookmarksImportDialog.__updateOkButton" ref="eric7.HelpViewer.HelpBookmarksImportDialog.html#HelpBookmarksImportDialog.__updateOkButton" /> + <keyword name="HelpBookmarksImportDialog.getData" id="HelpBookmarksImportDialog.getData" ref="eric7.HelpViewer.HelpBookmarksImportDialog.html#HelpBookmarksImportDialog.getData" /> + <keyword name="HelpBookmarksWidget" id="HelpBookmarksWidget" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget" /> + <keyword name="HelpBookmarksWidget (Constructor)" id="HelpBookmarksWidget (Constructor)" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__init__" /> + <keyword name="HelpBookmarksWidget (Module)" id="HelpBookmarksWidget (Module)" ref="eric7.HelpViewer.HelpBookmarksWidget.html" /> + <keyword name="HelpBookmarksWidget.__addBookmark" id="HelpBookmarksWidget.__addBookmark" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__addBookmark" /> + <keyword name="HelpBookmarksWidget.__bookmarkActivated" id="HelpBookmarksWidget.__bookmarkActivated" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__bookmarkActivated" /> + <keyword name="HelpBookmarksWidget.__bookmarkCurrentPage" id="HelpBookmarksWidget.__bookmarkCurrentPage" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__bookmarkCurrentPage" /> + <keyword name="HelpBookmarksWidget.__deleteBookmarks" id="HelpBookmarksWidget.__deleteBookmarks" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__deleteBookmarks" /> + <keyword name="HelpBookmarksWidget.__editBookmark" id="HelpBookmarksWidget.__editBookmark" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__editBookmark" /> + <keyword name="HelpBookmarksWidget.__exportBookmarks" id="HelpBookmarksWidget.__exportBookmarks" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__exportBookmarks" /> + <keyword name="HelpBookmarksWidget.__importBookmarks" id="HelpBookmarksWidget.__importBookmarks" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__importBookmarks" /> + <keyword name="HelpBookmarksWidget.__loadBookmarks" id="HelpBookmarksWidget.__loadBookmarks" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__loadBookmarks" /> + <keyword name="HelpBookmarksWidget.__newBookmark" id="HelpBookmarksWidget.__newBookmark" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__newBookmark" /> + <keyword name="HelpBookmarksWidget.__openBookmarks" id="HelpBookmarksWidget.__openBookmarks" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__openBookmarks" /> + <keyword name="HelpBookmarksWidget.__saveBookmarks" id="HelpBookmarksWidget.__saveBookmarks" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__saveBookmarks" /> + <keyword name="HelpBookmarksWidget.__showBackgroundMenu" id="HelpBookmarksWidget.__showBackgroundMenu" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__showBackgroundMenu" /> + <keyword name="HelpBookmarksWidget.__showBookmarkContextMenu" id="HelpBookmarksWidget.__showBookmarkContextMenu" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__showBookmarkContextMenu" /> + <keyword name="HelpBookmarksWidget.__showBookmarksContextMenu" id="HelpBookmarksWidget.__showBookmarksContextMenu" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__showBookmarksContextMenu" /> + <keyword name="HelpBookmarksWidget.__showContextMenu" id="HelpBookmarksWidget.__showContextMenu" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.__showContextMenu" /> + <keyword name="HelpBookmarksWidget.addBookmark" id="HelpBookmarksWidget.addBookmark" ref="eric7.HelpViewer.HelpBookmarksWidget.html#HelpBookmarksWidget.addBookmark" /> <keyword name="HelpDocsInstaller" id="HelpDocsInstaller" ref="eric7.WebBrowser.QtHelp.HelpDocsInstaller.html#HelpDocsInstaller" /> <keyword name="HelpDocsInstaller (Constructor)" id="HelpDocsInstaller (Constructor)" ref="eric7.WebBrowser.QtHelp.HelpDocsInstaller.html#HelpDocsInstaller.__init__" /> <keyword name="HelpDocsInstaller (Module)" id="HelpDocsInstaller (Module)" ref="eric7.WebBrowser.QtHelp.HelpDocsInstaller.html" /> @@ -7244,6 +7276,7 @@ <keyword name="HelpViewerImplQTB" id="HelpViewerImplQTB" ref="eric7.HelpViewer.HelpViewerImplQTB.html#HelpViewerImplQTB" /> <keyword name="HelpViewerImplQTB (Constructor)" id="HelpViewerImplQTB (Constructor)" ref="eric7.HelpViewer.HelpViewerImplQTB.html#HelpViewerImplQTB.__init__" /> <keyword name="HelpViewerImplQTB (Module)" id="HelpViewerImplQTB (Module)" ref="eric7.HelpViewer.HelpViewerImplQTB.html" /> + <keyword name="HelpViewerImplQTB.__bookmarkPage" id="HelpViewerImplQTB.__bookmarkPage" ref="eric7.HelpViewer.HelpViewerImplQTB.html#HelpViewerImplQTB.__bookmarkPage" /> <keyword name="HelpViewerImplQTB.__canLoadResource" id="HelpViewerImplQTB.__canLoadResource" ref="eric7.HelpViewer.HelpViewerImplQTB.html#HelpViewerImplQTB.__canLoadResource" /> <keyword name="HelpViewerImplQTB.__closeOtherPages" id="HelpViewerImplQTB.__closeOtherPages" ref="eric7.HelpViewer.HelpViewerImplQTB.html#HelpViewerImplQTB.__closeOtherPages" /> <keyword name="HelpViewerImplQTB.__closePage" id="HelpViewerImplQTB.__closePage" ref="eric7.HelpViewer.HelpViewerImplQTB.html#HelpViewerImplQTB.__closePage" /> @@ -7277,6 +7310,7 @@ <keyword name="HelpViewerImplQWE" id="HelpViewerImplQWE" ref="eric7.HelpViewer.HelpViewerImplQWE.html#HelpViewerImplQWE" /> <keyword name="HelpViewerImplQWE (Constructor)" id="HelpViewerImplQWE (Constructor)" ref="eric7.HelpViewer.HelpViewerImplQWE.html#HelpViewerImplQWE.__init__" /> <keyword name="HelpViewerImplQWE (Module)" id="HelpViewerImplQWE (Module)" ref="eric7.HelpViewer.HelpViewerImplQWE.html" /> + <keyword name="HelpViewerImplQWE.__bookmarkPage" id="HelpViewerImplQWE.__bookmarkPage" ref="eric7.HelpViewer.HelpViewerImplQWE.html#HelpViewerImplQWE.__bookmarkPage" /> <keyword name="HelpViewerImplQWE.__closeOtherPages" id="HelpViewerImplQWE.__closeOtherPages" ref="eric7.HelpViewer.HelpViewerImplQWE.html#HelpViewerImplQWE.__closeOtherPages" /> <keyword name="HelpViewerImplQWE.__closePage" id="HelpViewerImplQWE.__closePage" ref="eric7.HelpViewer.HelpViewerImplQWE.html#HelpViewerImplQWE.__closePage" /> <keyword name="HelpViewerImplQWE.__copyLink" id="HelpViewerImplQWE.__copyLink" ref="eric7.HelpViewer.HelpViewerImplQWE.html#HelpViewerImplQWE.__copyLink" /> @@ -7366,6 +7400,7 @@ <keyword name="HelpViewerWidget.__zoomReset" id="HelpViewerWidget.__zoomReset" ref="eric7.HelpViewer.HelpViewerWidget.html#HelpViewerWidget.__zoomReset" /> <keyword name="HelpViewerWidget.activate" id="HelpViewerWidget.activate" ref="eric7.HelpViewer.HelpViewerWidget.html#HelpViewerWidget.activate" /> <keyword name="HelpViewerWidget.addPage" id="HelpViewerWidget.addPage" ref="eric7.HelpViewer.HelpViewerWidget.html#HelpViewerWidget.addPage" /> + <keyword name="HelpViewerWidget.bookmarkPage" id="HelpViewerWidget.bookmarkPage" ref="eric7.HelpViewer.HelpViewerWidget.html#HelpViewerWidget.bookmarkPage" /> <keyword name="HelpViewerWidget.closeAllPages" id="HelpViewerWidget.closeAllPages" ref="eric7.HelpViewer.HelpViewerWidget.html#HelpViewerWidget.closeAllPages" /> <keyword name="HelpViewerWidget.closeCurrentPage" id="HelpViewerWidget.closeCurrentPage" ref="eric7.HelpViewer.HelpViewerWidget.html#HelpViewerWidget.closeCurrentPage" /> <keyword name="HelpViewerWidget.closeOtherPages" id="HelpViewerWidget.closeOtherPages" ref="eric7.HelpViewer.HelpViewerWidget.html#HelpViewerWidget.closeOtherPages" /> @@ -19250,6 +19285,9 @@ <file>eric7.Graphics.UMLGraphicsView.html</file> <file>eric7.Graphics.UMLItem.html</file> <file>eric7.Graphics.UMLSceneSizeDialog.html</file> + <file>eric7.HelpViewer.HelpBookmarkPropertiesDialog.html</file> + <file>eric7.HelpViewer.HelpBookmarksImportDialog.html</file> + <file>eric7.HelpViewer.HelpBookmarksWidget.html</file> <file>eric7.HelpViewer.HelpViewerImpl.html</file> <file>eric7.HelpViewer.HelpViewerImplQTB.html</file> <file>eric7.HelpViewer.HelpViewerImplQWE.html</file>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarkPropertiesDialog.html Wed Jan 05 17:28:05 2022 +0100 @@ -0,0 +1,126 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.HelpViewer.HelpBookmarkPropertiesDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.HelpViewer.HelpBookmarkPropertiesDialog</h1> + +<p> +Module implementing a dialog to edit the bookmark properties. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HelpBookmarkPropertiesDialog">HelpBookmarkPropertiesDialog</a></td> +<td>Class implementing a dialog to edit the bookmark properties.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HelpBookmarkPropertiesDialog" ID="HelpBookmarkPropertiesDialog"></a> +<h2>HelpBookmarkPropertiesDialog</h2> + +<p> + Class implementing a dialog to edit the bookmark properties. +</p> +<h3>Derived from</h3> +QDialog, Ui_HelpBookmarkPropertiesDialog +<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="#HelpBookmarkPropertiesDialog.__init__">HelpBookmarkPropertiesDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HelpBookmarkPropertiesDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private method to set the enabled state of the OK button.</td> +</tr> +<tr> +<td><a href="#HelpBookmarkPropertiesDialog.getData">getData</a></td> +<td>Public method to retrieve the entered data.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HelpBookmarkPropertiesDialog.__init__" ID="HelpBookmarkPropertiesDialog.__init__"></a> +<h4>HelpBookmarkPropertiesDialog (Constructor)</h4> +<b>HelpBookmarkPropertiesDialog</b>(<i>title="", url="", parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>title</i> (str (optional))</dt> +<dd> +title for the bookmark (defaults to "") +</dd> +<dt><i>url</i> (str (optional))</dt> +<dd> +URL for the bookmark (defaults to "") +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="HelpBookmarkPropertiesDialog.__updateOkButton" ID="HelpBookmarkPropertiesDialog.__updateOkButton"></a> +<h4>HelpBookmarkPropertiesDialog.__updateOkButton</h4> +<b>__updateOkButton</b>(<i></i>) + +<p> + Private method to set the enabled state of the OK button. +</p> +<a NAME="HelpBookmarkPropertiesDialog.getData" ID="HelpBookmarkPropertiesDialog.getData"></a> +<h4>HelpBookmarkPropertiesDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to retrieve the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the title and URL for the bookmark +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarksImportDialog.html Wed Jan 05 17:28:05 2022 +0100 @@ -0,0 +1,119 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.HelpViewer.HelpBookmarksImportDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.HelpViewer.HelpBookmarksImportDialog</h1> + +<p> +Module implementing a dialog to enter the bookmarks import parameters. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HelpBookmarksImportDialog">HelpBookmarksImportDialog</a></td> +<td>Class implementing a dialog to enter the bookmarks import parameters.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HelpBookmarksImportDialog" ID="HelpBookmarksImportDialog"></a> +<h2>HelpBookmarksImportDialog</h2> + +<p> + Class implementing a dialog to enter the bookmarks import parameters. +</p> +<h3>Derived from</h3> +QDialog, Ui_HelpBookmarksImportDialog +<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="#HelpBookmarksImportDialog.__init__">HelpBookmarksImportDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HelpBookmarksImportDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private method to update the state of the OK button.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksImportDialog.getData">getData</a></td> +<td>Public method to retrieve the entered data.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HelpBookmarksImportDialog.__init__" ID="HelpBookmarksImportDialog.__init__"></a> +<h4>HelpBookmarksImportDialog (Constructor)</h4> +<b>HelpBookmarksImportDialog</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="HelpBookmarksImportDialog.__updateOkButton" ID="HelpBookmarksImportDialog.__updateOkButton"></a> +<h4>HelpBookmarksImportDialog.__updateOkButton</h4> +<b>__updateOkButton</b>(<i></i>) + +<p> + Private method to update the state of the OK button. +</p> +<a NAME="HelpBookmarksImportDialog.getData" ID="HelpBookmarksImportDialog.getData"></a> +<h4>HelpBookmarksImportDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to retrieve the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating to replace the existing + bookmarks and the path of the bookmarks file to be imported +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarksWidget.html Wed Jan 05 17:28:05 2022 +0100 @@ -0,0 +1,369 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.HelpViewer.HelpBookmarksWidget</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<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> + +<dt>escapePressed()</dt> +<dd> +emitted when the ESC key was pressed +</dd> +<dt>newBackgroundTab(QUrl, str)</dt> +<dd> +emitted to open an entry in a + new background tab +</dd> +<dt>newTab(QUrl, str)</dt> +<dd> +emitted to open an entry in a new tab +</dd> +<dt>openUrl(QUrl, str)</dt> +<dd> +emitted to open an entry in the current tab +</dd> +</dl> +<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> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__addBookmark">__addBookmark</a></td> +<td>Private slot to add a bookmark entry.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__bookmarkActivated">__bookmarkActivated</a></td> +<td>Private slot handling the activation of a bookmark.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__bookmarkCurrentPage">__bookmarkCurrentPage</a></td> +<td>Private slot to bookmark the current page.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__deleteBookmarks">__deleteBookmarks</a></td> +<td>Private method to delete the given bookmark items.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__editBookmark">__editBookmark</a></td> +<td>Private slot to edit a bookmark.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__exportBookmarks">__exportBookmarks</a></td> +<td>Private slot to export the bookmarks into a JSON file.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__importBookmarks">__importBookmarks</a></td> +<td>Private slot to import bookmarks from a JSON file.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__loadBookmarks">__loadBookmarks</a></td> +<td>Private method to load the defined bookmarks.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__newBookmark">__newBookmark</a></td> +<td>Private slot to create a new bookmark.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__openBookmarks">__openBookmarks</a></td> +<td>Private method to open all or selected bookmarks.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__saveBookmarks">__saveBookmarks</a></td> +<td>Private method to save the defined bookmarks.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__showBackgroundMenu">__showBackgroundMenu</a></td> +<td>Private slot to show the background menu (i.e.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__showBookmarkContextMenu">__showBookmarkContextMenu</a></td> +<td>Private slot to show the context menu for a bookmark.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__showBookmarksContextMenu">__showBookmarksContextMenu</a></td> +<td>Private slot to show the context menu for multiple bookmark.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.__showContextMenu">__showContextMenu</a></td> +<td>Private slot to handle the customContextMenuRequested signal of the viewlist.</td> +</tr> +<tr> +<td><a href="#HelpBookmarksWidget.addBookmark">addBookmark</a></td> +<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> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<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> +<dd> +title for the bookmark +</dd> +<dt><i>url</i> (str)</dt> +<dd> +URL for the bookmark +</dd> +</dl> +<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> +<dd> +reference to the activated item +</dd> +</dl> +<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> +<dd> +list of bookmarks to be deleted +</dd> +</dl> +<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> +<dd> +reference to the bookmark item to be edited +</dd> +</dl> +<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> +<dd> +flag indicating to export the selected bookmarks + (defaults to False) +</dd> +</dl> +<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> +<dd> +flag indicating to open the selected bookmarks + (defaults to False) +</dd> +</dl> +<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> +<dd> +position to open the menu at +</dd> +</dl> +<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> +<dd> +position to open the menu at +</dd> +</dl> +<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> +<dd> +position to open the menu at +</dd> +</dl> +<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> +<dd> +position to open the menu at +</dd> +</dl> +<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> +<dd> +title for the bookmark +</dd> +<dt><i>url</i> (QUrl)</dt> +<dd> +URL for the bookmark +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- a/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQTB.html Wed Jan 05 17:26:04 2022 +0100 +++ b/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQTB.html Wed Jan 05 17:28:05 2022 +0100 @@ -59,6 +59,10 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#HelpViewerImplQTB.__bookmarkPage">__bookmarkPage</a></td> +<td>Private method called by the context menu to bookmark the page.</td> +</tr> +<tr> <td><a href="#HelpViewerImplQTB.__canLoadResource">__canLoadResource</a></td> <td>Private method to check, if the given resource can be loaded.</td> </tr> @@ -203,6 +207,20 @@ reference to the parent widget </dd> </dl> +<a NAME="HelpViewerImplQTB.__bookmarkPage" ID="HelpViewerImplQTB.__bookmarkPage"></a> +<h4>HelpViewerImplQTB.__bookmarkPage</h4> +<b>__bookmarkPage</b>(<i>act</i>) + +<p> + Private method called by the context menu to bookmark the page. +</p> +<dl> + +<dt><i>act</i> (QAction)</dt> +<dd> +reference to the action that triggered +</dd> +</dl> <a NAME="HelpViewerImplQTB.__canLoadResource" ID="HelpViewerImplQTB.__canLoadResource"></a> <h4>HelpViewerImplQTB.__canLoadResource</h4> <b>__canLoadResource</b>(<i>url</i>)
--- a/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQWE.html Wed Jan 05 17:26:04 2022 +0100 +++ b/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQWE.html Wed Jan 05 17:28:05 2022 +0100 @@ -59,6 +59,10 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#HelpViewerImplQWE.__bookmarkPage">__bookmarkPage</a></td> +<td>Private method called by the context menu to bookmark the page.</td> +</tr> +<tr> <td><a href="#HelpViewerImplQWE.__closeOtherPages">__closeOtherPages</a></td> <td>Private method called by the context menu to close all other pages.</td> </tr> @@ -255,6 +259,20 @@ reference to the parent widget </dd> </dl> +<a NAME="HelpViewerImplQWE.__bookmarkPage" ID="HelpViewerImplQWE.__bookmarkPage"></a> +<h4>HelpViewerImplQWE.__bookmarkPage</h4> +<b>__bookmarkPage</b>(<i>act</i>) + +<p> + Private method called by the context menu to bookmark the page. +</p> +<dl> + +<dt><i>act</i> (QAction)</dt> +<dd> +reference to the action that triggered +</dd> +</dl> <a NAME="HelpViewerImplQWE.__closeOtherPages" ID="HelpViewerImplQWE.__closeOtherPages"></a> <h4>HelpViewerImplQWE.__closeOtherPages</h4> <b>__closeOtherPages</b>(<i></i>)
--- a/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html Wed Jan 05 17:26:04 2022 +0100 +++ b/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html Wed Jan 05 17:28:05 2022 +0100 @@ -231,6 +231,10 @@ <td>Public method to add a new help page with the given URL.</td> </tr> <tr> +<td><a href="#HelpViewerWidget.bookmarkPage">bookmarkPage</a></td> +<td>Public method to bookmark a page with the given data.</td> +</tr> +<tr> <td><a href="#HelpViewerWidget.closeAllPages">closeAllPages</a></td> <td>Public slot to close all pages.</td> </tr> @@ -770,6 +774,24 @@ HelpViewerImpl </dd> </dl> +<a NAME="HelpViewerWidget.bookmarkPage" ID="HelpViewerWidget.bookmarkPage"></a> +<h4>HelpViewerWidget.bookmarkPage</h4> +<b>bookmarkPage</b>(<i>title, url</i>) + +<p> + Public method to bookmark a page with the given data. +</p> +<dl> + +<dt><i>title</i> (str)</dt> +<dd> +title of the page +</dd> +<dt><i>url</i> (QUrl)</dt> +<dd> +URL of the page +</dd> +</dl> <a NAME="HelpViewerWidget.closeAllPages" ID="HelpViewerWidget.closeAllPages"></a> <h4>HelpViewerWidget.closeAllPages</h4> <b>closeAllPages</b>(<i></i>)
--- a/eric7/Documentation/Source/eric7.HelpViewer.OpenPagesWidget.html Wed Jan 05 17:26:04 2022 +0100 +++ b/eric7/Documentation/Source/eric7.HelpViewer.OpenPagesWidget.html Wed Jan 05 17:28:05 2022 +0100 @@ -41,14 +41,14 @@ <h3>Signals</h3> <dl> -<dt>currentChanged(index)</dt> +<dt>currentPageChanged(index)</dt> <dd> emitted to signal a change of the current page index </dd> </dl> <h3>Derived from</h3> -QWidget +QListWidget <h3>Class Attributes</h3> <table>
--- a/eric7/Documentation/Source/index-eric7.HelpViewer.html Wed Jan 05 17:26:04 2022 +0100 +++ b/eric7/Documentation/Source/index-eric7.HelpViewer.html Wed Jan 05 17:28:05 2022 +0100 @@ -16,6 +16,18 @@ <table> <tr> +<td><a href="eric7.HelpViewer.HelpBookmarkPropertiesDialog.html">HelpBookmarkPropertiesDialog</a></td> +<td>Module implementing a dialog to edit the bookmark properties.</td> +</tr> +<tr> +<td><a href="eric7.HelpViewer.HelpBookmarksImportDialog.html">HelpBookmarksImportDialog</a></td> +<td>Module implementing a dialog to enter the bookmarks import parameters.</td> +</tr> +<tr> +<td><a href="eric7.HelpViewer.HelpBookmarksWidget.html">HelpBookmarksWidget</a></td> +<td>Module implementing a widget showing the list of bookmarks.</td> +</tr> +<tr> <td><a href="eric7.HelpViewer.HelpViewerImpl.html">HelpViewerImpl</a></td> <td>Module implementing the help viewer base class.</td> </tr>