--- a/src/eric7/Documentation/Source/eric7.PdfViewer.PdfViewerWindow.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PdfViewer.PdfViewerWindow.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.PdfViewer.PdfViewerWindow</h1>
-
<p>
Module implementing the PDF viewer main window.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PdfViewerWindow">PdfViewerWindow</a></td>
<td>Class implementing the PDF viewer main window.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="PdfViewerWindow" ID="PdfViewerWindow"></a>
<h2>PdfViewerWindow</h2>
-
<p>
Class implementing the PDF viewer main window.
</p>
+
<h3>Signals</h3>
<dl>
@@ -49,19 +48,18 @@
<h3>Derived from</h3>
EricMainWindow
<h3>Class Attributes</h3>
+<table>
+<tr><td>maxMenuFilePathLen</td></tr>
+<tr><td>windows</td></tr>
+</table>
-<table>
-<tr><td>maxMenuFilePathLen</td></tr><tr><td>windows</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PdfViewerWindow.__init__">PdfViewerWindow</a></td>
<td>Constructor</td>
@@ -307,19 +305,20 @@
<td>Protected method handling the close event.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PdfViewerWindow.__init__" ID="PdfViewerWindow.__init__"></a>
<h4>PdfViewerWindow (Constructor)</h4>
<b>PdfViewerWindow</b>(<i>fileName="", parent=None, fromEric=False, project=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -343,24 +342,24 @@
<a NAME="PdfViewerWindow.__about" ID="PdfViewerWindow.__about"></a>
<h4>PdfViewerWindow.__about</h4>
<b>__about</b>(<i></i>)
-
<p>
Private slot to show a little About message.
</p>
+
<a NAME="PdfViewerWindow.__aboutQt" ID="PdfViewerWindow.__aboutQt"></a>
<h4>PdfViewerWindow.__aboutQt</h4>
<b>__aboutQt</b>(<i></i>)
-
<p>
Private slot to handle the About Qt dialog.
</p>
+
<a NAME="PdfViewerWindow.__addToRecentList" ID="PdfViewerWindow.__addToRecentList"></a>
<h4>PdfViewerWindow.__addToRecentList</h4>
<b>__addToRecentList</b>(<i>fileName</i>)
-
<p>
Private method to add a file name to the list of recently opened files.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -371,73 +370,73 @@
<a NAME="PdfViewerWindow.__backInHistory" ID="PdfViewerWindow.__backInHistory"></a>
<h4>PdfViewerWindow.__backInHistory</h4>
<b>__backInHistory</b>(<i></i>)
-
<p>
Private slot to go back in the view history.
</p>
+
<a NAME="PdfViewerWindow.__checkActions" ID="PdfViewerWindow.__checkActions"></a>
<h4>PdfViewerWindow.__checkActions</h4>
<b>__checkActions</b>(<i></i>)
-
<p>
Private slot to check some actions for their enable/disable status.
</p>
+
<a NAME="PdfViewerWindow.__clearRecent" ID="PdfViewerWindow.__clearRecent"></a>
<h4>PdfViewerWindow.__clearRecent</h4>
<b>__clearRecent</b>(<i></i>)
-
<p>
Private method to clear the list of recently opened files.
</p>
+
<a NAME="PdfViewerWindow.__closeAll" ID="PdfViewerWindow.__closeAll"></a>
<h4>PdfViewerWindow.__closeAll</h4>
<b>__closeAll</b>(<i></i>)
-
<p>
Private slot to close all windows.
</p>
+
<a NAME="PdfViewerWindow.__closeOthers" ID="PdfViewerWindow.__closeOthers"></a>
<h4>PdfViewerWindow.__closeOthers</h4>
<b>__closeOthers</b>(<i></i>)
-
<p>
Private slot to close all other windows.
</p>
+
<a NAME="PdfViewerWindow.__copyAllText" ID="PdfViewerWindow.__copyAllText"></a>
<h4>PdfViewerWindow.__copyAllText</h4>
<b>__copyAllText</b>(<i></i>)
-
<p>
Private slot to copy all text of the document to the system clipboard.
</p>
+
<a NAME="PdfViewerWindow.__copyAllTextOfPage" ID="PdfViewerWindow.__copyAllTextOfPage"></a>
<h4>PdfViewerWindow.__copyAllTextOfPage</h4>
<b>__copyAllTextOfPage</b>(<i></i>)
-
<p>
Private slot to copy all text of the current page to the system clipboard.
</p>
+
<a NAME="PdfViewerWindow.__copyText" ID="PdfViewerWindow.__copyText"></a>
<h4>PdfViewerWindow.__copyText</h4>
<b>__copyText</b>(<i></i>)
-
<p>
Private slot to copy the selected text to the system clipboard.
</p>
+
<a NAME="PdfViewerWindow.__createStatusBar" ID="PdfViewerWindow.__createStatusBar"></a>
<h4>PdfViewerWindow.__createStatusBar</h4>
<b>__createStatusBar</b>(<i></i>)
-
<p>
Private method to initialize the status bar.
</p>
+
<a NAME="PdfViewerWindow.__displayModeSelected" ID="PdfViewerWindow.__displayModeSelected"></a>
<h4>PdfViewerWindow.__displayModeSelected</h4>
<b>__displayModeSelected</b>(<i>act</i>)
-
<p>
Private slot to handle the selection of a display mode.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -448,24 +447,24 @@
<a NAME="PdfViewerWindow.__endDocument" ID="PdfViewerWindow.__endDocument"></a>
<h4>PdfViewerWindow.__endDocument</h4>
<b>__endDocument</b>(<i></i>)
-
<p>
Private slot to go to the last page of the document.
</p>
+
<a NAME="PdfViewerWindow.__forwardInHistory" ID="PdfViewerWindow.__forwardInHistory"></a>
<h4>PdfViewerWindow.__forwardInHistory</h4>
<b>__forwardInHistory</b>(<i></i>)
-
<p>
Private slot to go forward in the view history.
</p>
+
<a NAME="PdfViewerWindow.__getErrorString" ID="PdfViewerWindow.__getErrorString"></a>
<h4>PdfViewerWindow.__getErrorString</h4>
<b>__getErrorString</b>(<i>err</i>)
-
<p>
Private method to get an error string for the given error.
</p>
+
<dl>
<dt><i>err</i> (QPdfDocument.Error)</dt>
@@ -488,17 +487,17 @@
<a NAME="PdfViewerWindow.__gotoPage" ID="PdfViewerWindow.__gotoPage"></a>
<h4>PdfViewerWindow.__gotoPage</h4>
<b>__gotoPage</b>(<i></i>)
-
<p>
Private slot to show a dialog to select a page to jump to.
</p>
+
<a NAME="PdfViewerWindow.__handleSearchResult" ID="PdfViewerWindow.__handleSearchResult"></a>
<h4>PdfViewerWindow.__handleSearchResult</h4>
<b>__handleSearchResult</b>(<i>link</i>)
-
<p>
Private slot to handle the selection of a search result.
</p>
+
<dl>
<dt><i>link</i> (QPdfLink)</dt>
@@ -509,73 +508,73 @@
<a NAME="PdfViewerWindow.__initActions" ID="PdfViewerWindow.__initActions"></a>
<h4>PdfViewerWindow.__initActions</h4>
<b>__initActions</b>(<i></i>)
-
<p>
Private method to define the user interface actions.
</p>
+
<a NAME="PdfViewerWindow.__initEditActions" ID="PdfViewerWindow.__initEditActions"></a>
<h4>PdfViewerWindow.__initEditActions</h4>
<b>__initEditActions</b>(<i></i>)
-
<p>
Private method to create the Edit actions.
</p>
+
<a NAME="PdfViewerWindow.__initFileActions" ID="PdfViewerWindow.__initFileActions"></a>
<h4>PdfViewerWindow.__initFileActions</h4>
<b>__initFileActions</b>(<i></i>)
-
<p>
Private method to define the file related user interface actions.
</p>
+
<a NAME="PdfViewerWindow.__initGotoActions" ID="PdfViewerWindow.__initGotoActions"></a>
<h4>PdfViewerWindow.__initGotoActions</h4>
<b>__initGotoActions</b>(<i></i>)
-
<p>
Private method to define the navigation related user interface actions.
</p>
+
<a NAME="PdfViewerWindow.__initHelpActions" ID="PdfViewerWindow.__initHelpActions"></a>
<h4>PdfViewerWindow.__initHelpActions</h4>
<b>__initHelpActions</b>(<i></i>)
-
<p>
Private method to create the Help actions.
</p>
+
<a NAME="PdfViewerWindow.__initMenus" ID="PdfViewerWindow.__initMenus"></a>
<h4>PdfViewerWindow.__initMenus</h4>
<b>__initMenus</b>(<i></i>)
-
<p>
Private method to create the menus.
</p>
+
<a NAME="PdfViewerWindow.__initSettingsActions" ID="PdfViewerWindow.__initSettingsActions"></a>
<h4>PdfViewerWindow.__initSettingsActions</h4>
<b>__initSettingsActions</b>(<i></i>)
-
<p>
Private method to create the Settings actions.
</p>
+
<a NAME="PdfViewerWindow.__initToolbars" ID="PdfViewerWindow.__initToolbars"></a>
<h4>PdfViewerWindow.__initToolbars</h4>
<b>__initToolbars</b>(<i></i>)
-
<p>
Private method to create the toolbars.
</p>
+
<a NAME="PdfViewerWindow.__initViewActions" ID="PdfViewerWindow.__initViewActions"></a>
<h4>PdfViewerWindow.__initViewActions</h4>
<b>__initViewActions</b>(<i></i>)
-
<p>
Private method to define the view related user interface actions.
</p>
+
<a NAME="PdfViewerWindow.__loadPdfFile" ID="PdfViewerWindow.__loadPdfFile"></a>
<h4>PdfViewerWindow.__loadPdfFile</h4>
<b>__loadPdfFile</b>(<i>fileName</i>)
-
<p>
Private method to load a PDF file.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -586,31 +585,31 @@
<a NAME="PdfViewerWindow.__loadRecent" ID="PdfViewerWindow.__loadRecent"></a>
<h4>PdfViewerWindow.__loadRecent</h4>
<b>__loadRecent</b>(<i></i>)
-
<p>
Private method to load the list of recently opened files.
</p>
+
<a NAME="PdfViewerWindow.__nextPage" ID="PdfViewerWindow.__nextPage"></a>
<h4>PdfViewerWindow.__nextPage</h4>
<b>__nextPage</b>(<i></i>)
-
<p>
Private slot to go to the next page.
</p>
+
<a NAME="PdfViewerWindow.__openPdfFile" ID="PdfViewerWindow.__openPdfFile"></a>
<h4>PdfViewerWindow.__openPdfFile</h4>
<b>__openPdfFile</b>(<i></i>)
-
<p>
Private slot to open a PDF file.
</p>
+
<a NAME="PdfViewerWindow.__openPdfFileNewWindow" ID="PdfViewerWindow.__openPdfFileNewWindow"></a>
<h4>PdfViewerWindow.__openPdfFileNewWindow</h4>
<b>__openPdfFileNewWindow</b>(<i>fileName=""</i>)
-
<p>
Private slot called to open a PDF file in new viewer window.
</p>
+
<dl>
<dt><i>fileName</i> (str (optional))</dt>
@@ -621,10 +620,10 @@
<a NAME="PdfViewerWindow.__openRecentPdfFile" ID="PdfViewerWindow.__openRecentPdfFile"></a>
<h4>PdfViewerWindow.__openRecentPdfFile</h4>
<b>__openRecentPdfFile</b>(<i>act</i>)
-
<p>
Private method to open a file from the list of recently opened files.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -635,10 +634,10 @@
<a NAME="PdfViewerWindow.__pageSelected" ID="PdfViewerWindow.__pageSelected"></a>
<h4>PdfViewerWindow.__pageSelected</h4>
<b>__pageSelected</b>(<i>page</i>)
-
<p>
Private slot to navigate to the given page.
</p>
+
<dl>
<dt><i>page</i> (int)</dt>
@@ -649,52 +648,52 @@
<a NAME="PdfViewerWindow.__previousPage" ID="PdfViewerWindow.__previousPage"></a>
<h4>PdfViewerWindow.__previousPage</h4>
<b>__previousPage</b>(<i></i>)
-
<p>
Private slot to go to the previous page.
</p>
+
<a NAME="PdfViewerWindow.__reload" ID="PdfViewerWindow.__reload"></a>
<h4>PdfViewerWindow.__reload</h4>
<b>__reload</b>(<i></i>)
-
<p>
Private slot to reload the current PDF document.
</p>
+
<a NAME="PdfViewerWindow.__restoreViewerState" ID="PdfViewerWindow.__restoreViewerState"></a>
<h4>PdfViewerWindow.__restoreViewerState</h4>
<b>__restoreViewerState</b>(<i></i>)
-
<p>
Private method to restore the PDF Viewer state data.
</p>
+
<a NAME="PdfViewerWindow.__saveRecent" ID="PdfViewerWindow.__saveRecent"></a>
<h4>PdfViewerWindow.__saveRecent</h4>
<b>__saveRecent</b>(<i></i>)
-
<p>
Private method to save the list of recently opened files.
</p>
+
<a NAME="PdfViewerWindow.__saveViewerState" ID="PdfViewerWindow.__saveViewerState"></a>
<h4>PdfViewerWindow.__saveViewerState</h4>
<b>__saveViewerState</b>(<i></i>)
-
<p>
Private method to save the PDF Viewer state data.
</p>
+
<a NAME="PdfViewerWindow.__search" ID="PdfViewerWindow.__search"></a>
<h4>PdfViewerWindow.__search</h4>
<b>__search</b>(<i></i>)
-
<p>
Private slot to initiate a search.
</p>
+
<a NAME="PdfViewerWindow.__setCurrentFile" ID="PdfViewerWindow.__setCurrentFile"></a>
<h4>PdfViewerWindow.__setCurrentFile</h4>
<b>__setCurrentFile</b>(<i>fileName</i>)
-
<p>
Private method to register the file name of the current file.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -705,17 +704,17 @@
<a NAME="PdfViewerWindow.__setDisplayMode" ID="PdfViewerWindow.__setDisplayMode"></a>
<h4>PdfViewerWindow.__setDisplayMode</h4>
<b>__setDisplayMode</b>(<i></i>)
-
<p>
Private method to set the display mode iaw. configuration.
</p>
+
<a NAME="PdfViewerWindow.__setViewerTitle" ID="PdfViewerWindow.__setViewerTitle"></a>
<h4>PdfViewerWindow.__setViewerTitle</h4>
<b>__setViewerTitle</b>(<i>title</i>)
-
<p>
Private method to set the viewer title.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -726,45 +725,45 @@
<a NAME="PdfViewerWindow.__showDocumentProperties" ID="PdfViewerWindow.__showDocumentProperties"></a>
<h4>PdfViewerWindow.__showDocumentProperties</h4>
<b>__showDocumentProperties</b>(<i></i>)
-
<p>
Private slot to open a dialog showing the document properties.
</p>
+
<a NAME="PdfViewerWindow.__showFileMenu" ID="PdfViewerWindow.__showFileMenu"></a>
<h4>PdfViewerWindow.__showFileMenu</h4>
<b>__showFileMenu</b>(<i></i>)
-
<p>
Private slot to modify the file menu before being shown.
</p>
+
<a NAME="PdfViewerWindow.__showPreferences" ID="PdfViewerWindow.__showPreferences"></a>
<h4>PdfViewerWindow.__showPreferences</h4>
<b>__showPreferences</b>(<i></i>)
-
<p>
Private slot to set the preferences.
</p>
+
<a NAME="PdfViewerWindow.__showRecentMenu" ID="PdfViewerWindow.__showRecentMenu"></a>
<h4>PdfViewerWindow.__showRecentMenu</h4>
<b>__showRecentMenu</b>(<i></i>)
-
<p>
Private slot to set up the recent files menu.
</p>
+
<a NAME="PdfViewerWindow.__startDocument" ID="PdfViewerWindow.__startDocument"></a>
<h4>PdfViewerWindow.__startDocument</h4>
<b>__startDocument</b>(<i></i>)
-
<p>
Private slot to go to the first page of the document.
</p>
+
<a NAME="PdfViewerWindow.__tocActivated" ID="PdfViewerWindow.__tocActivated"></a>
<h4>PdfViewerWindow.__tocActivated</h4>
<b>__tocActivated</b>(<i>page, zoomFactor</i>)
-
<p>
Private slot to handle the selection of a ToC topic.
</p>
+
<dl>
<dt><i>page</i> (int)</dt>
@@ -779,10 +778,10 @@
<a NAME="PdfViewerWindow.__toggleFullScreen" ID="PdfViewerWindow.__toggleFullScreen"></a>
<h4>PdfViewerWindow.__toggleFullScreen</h4>
<b>__toggleFullScreen</b>(<i>on</i>)
-
<p>
Private slot to toggle the full screen mode.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -793,10 +792,10 @@
<a NAME="PdfViewerWindow.__toggleOpenRecentNew" ID="PdfViewerWindow.__toggleOpenRecentNew"></a>
<h4>PdfViewerWindow.__toggleOpenRecentNew</h4>
<b>__toggleOpenRecentNew</b>(<i>on</i>)
-
<p>
Private slot to toggle the 'Open Recent File in New Window' action.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -807,10 +806,10 @@
<a NAME="PdfViewerWindow.__toggleSideBar" ID="PdfViewerWindow.__toggleSideBar"></a>
<h4>PdfViewerWindow.__toggleSideBar</h4>
<b>__toggleSideBar</b>(<i>visible</i>)
-
<p>
Private slot to togle the sidebar (info) widget.
</p>
+
<dl>
<dt><i>visible</i> (bool)</dt>
@@ -821,24 +820,24 @@
<a NAME="PdfViewerWindow.__whatsThis" ID="PdfViewerWindow.__whatsThis"></a>
<h4>PdfViewerWindow.__whatsThis</h4>
<b>__whatsThis</b>(<i></i>)
-
<p>
Private slot called in to enter Whats This mode.
</p>
+
<a NAME="PdfViewerWindow.__zoomIn" ID="PdfViewerWindow.__zoomIn"></a>
<h4>PdfViewerWindow.__zoomIn</h4>
<b>__zoomIn</b>(<i></i>)
-
<p>
Private slot to zoom into the view.
</p>
+
<a NAME="PdfViewerWindow.__zoomModeChanged" ID="PdfViewerWindow.__zoomModeChanged"></a>
<h4>PdfViewerWindow.__zoomModeChanged</h4>
<b>__zoomModeChanged</b>(<i>zoomMode</i>)
-
<p>
Private slot to handle a change of the zoom mode.
</p>
+
<dl>
<dt><i>zoomMode</i> (QPdfView.ZoomMode)</dt>
@@ -849,17 +848,17 @@
<a NAME="PdfViewerWindow.__zoomOut" ID="PdfViewerWindow.__zoomOut"></a>
<h4>PdfViewerWindow.__zoomOut</h4>
<b>__zoomOut</b>(<i></i>)
-
<p>
Private slot to zoom out of the view.
</p>
+
<a NAME="PdfViewerWindow.__zoomPageWidth" ID="PdfViewerWindow.__zoomPageWidth"></a>
<h4>PdfViewerWindow.__zoomPageWidth</h4>
<b>__zoomPageWidth</b>(<i>checked</i>)
-
<p>
Private slot to fit the page width.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -870,17 +869,17 @@
<a NAME="PdfViewerWindow.__zoomReset" ID="PdfViewerWindow.__zoomReset"></a>
<h4>PdfViewerWindow.__zoomReset</h4>
<b>__zoomReset</b>(<i></i>)
-
<p>
Private slot to reset the zoom factor of the view.
</p>
+
<a NAME="PdfViewerWindow.__zoomWholePage" ID="PdfViewerWindow.__zoomWholePage"></a>
<h4>PdfViewerWindow.__zoomWholePage</h4>
<b>__zoomWholePage</b>(<i>checked</i>)
-
<p>
Private slot to fit the page width.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -891,10 +890,10 @@
<a NAME="PdfViewerWindow.closeEvent" ID="PdfViewerWindow.closeEvent"></a>
<h4>PdfViewerWindow.closeEvent</h4>
<b>closeEvent</b>(<i>evt</i>)
-
<p>
Protected method handling the close event.
</p>
+
<dl>
<dt><i>evt</i> (QCloseEvent)</dt>
@@ -904,4 +903,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
