--- a/src/eric7/Documentation/Source/eric7.HexEdit.HexEditMainWindow.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.HexEdit.HexEditMainWindow.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.HexEdit.HexEditMainWindow</h1>
-
<p>
Module implementing the hex editor main window.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#HexEditMainWindow">HexEditMainWindow</a></td>
<td>Class implementing the hex editor main window.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="HexEditMainWindow" ID="HexEditMainWindow"></a>
<h2>HexEditMainWindow</h2>
-
<p>
Class implementing the hex editor 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="#HexEditMainWindow.__init__">HexEditMainWindow</a></td>
<td>Constructor</td>
@@ -271,19 +269,20 @@
<td>Public method to set the last open and save paths.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HexEditMainWindow.__init__" ID="HexEditMainWindow.__init__"></a>
<h4>HexEditMainWindow (Constructor)</h4>
<b>HexEditMainWindow</b>(<i>fileName="", parent=None, fromEric=False, project=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -307,24 +306,24 @@
<a NAME="HexEditMainWindow.__about" ID="HexEditMainWindow.__about"></a>
<h4>HexEditMainWindow.__about</h4>
<b>__about</b>(<i></i>)
-
<p>
Private slot to show a little About message.
</p>
+
<a NAME="HexEditMainWindow.__aboutQt" ID="HexEditMainWindow.__aboutQt"></a>
<h4>HexEditMainWindow.__aboutQt</h4>
<b>__aboutQt</b>(<i></i>)
-
<p>
Private slot to handle the About Qt dialog.
</p>
+
<a NAME="HexEditMainWindow.__addToRecentList" ID="HexEditMainWindow.__addToRecentList"></a>
<h4>HexEditMainWindow.__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>
@@ -335,101 +334,101 @@
<a NAME="HexEditMainWindow.__checkActions" ID="HexEditMainWindow.__checkActions"></a>
<h4>HexEditMainWindow.__checkActions</h4>
<b>__checkActions</b>(<i></i>)
-
<p>
Private slot to check some actions for their enable/disable status.
</p>
+
<a NAME="HexEditMainWindow.__clearRecent" ID="HexEditMainWindow.__clearRecent"></a>
<h4>HexEditMainWindow.__clearRecent</h4>
<b>__clearRecent</b>(<i></i>)
-
<p>
Private method to clear the list of recently opened files.
</p>
+
<a NAME="HexEditMainWindow.__closeAll" ID="HexEditMainWindow.__closeAll"></a>
<h4>HexEditMainWindow.__closeAll</h4>
<b>__closeAll</b>(<i></i>)
-
<p>
Private slot to close all windows.
</p>
+
<a NAME="HexEditMainWindow.__closeOthers" ID="HexEditMainWindow.__closeOthers"></a>
<h4>HexEditMainWindow.__closeOthers</h4>
<b>__closeOthers</b>(<i></i>)
-
<p>
Private slot to close all other windows.
</p>
+
<a NAME="HexEditMainWindow.__createStatusBar" ID="HexEditMainWindow.__createStatusBar"></a>
<h4>HexEditMainWindow.__createStatusBar</h4>
<b>__createStatusBar</b>(<i></i>)
-
<p>
Private method to initialize the status bar.
</p>
+
<a NAME="HexEditMainWindow.__goto" ID="HexEditMainWindow.__goto"></a>
<h4>HexEditMainWindow.__goto</h4>
<b>__goto</b>(<i></i>)
-
<p>
Private method to handle the goto action.
</p>
+
<a NAME="HexEditMainWindow.__initActions" ID="HexEditMainWindow.__initActions"></a>
<h4>HexEditMainWindow.__initActions</h4>
<b>__initActions</b>(<i></i>)
-
<p>
Private method to define the user interface actions.
</p>
+
<a NAME="HexEditMainWindow.__initConfigActions" ID="HexEditMainWindow.__initConfigActions"></a>
<h4>HexEditMainWindow.__initConfigActions</h4>
<b>__initConfigActions</b>(<i></i>)
-
<p>
Private method to create the Settings actions.
</p>
+
<a NAME="HexEditMainWindow.__initEditActions" ID="HexEditMainWindow.__initEditActions"></a>
<h4>HexEditMainWindow.__initEditActions</h4>
<b>__initEditActions</b>(<i></i>)
-
<p>
Private method to create the Edit actions.
</p>
+
<a NAME="HexEditMainWindow.__initFileActions" ID="HexEditMainWindow.__initFileActions"></a>
<h4>HexEditMainWindow.__initFileActions</h4>
<b>__initFileActions</b>(<i></i>)
-
<p>
Private method to define the file related user interface actions.
</p>
+
<a NAME="HexEditMainWindow.__initHelpActions" ID="HexEditMainWindow.__initHelpActions"></a>
<h4>HexEditMainWindow.__initHelpActions</h4>
<b>__initHelpActions</b>(<i></i>)
-
<p>
Private method to create the Help actions.
</p>
+
<a NAME="HexEditMainWindow.__initMenus" ID="HexEditMainWindow.__initMenus"></a>
<h4>HexEditMainWindow.__initMenus</h4>
<b>__initMenus</b>(<i></i>)
-
<p>
Private method to create the menus.
</p>
+
<a NAME="HexEditMainWindow.__initToolbars" ID="HexEditMainWindow.__initToolbars"></a>
<h4>HexEditMainWindow.__initToolbars</h4>
<b>__initToolbars</b>(<i></i>)
-
<p>
Private method to create the toolbars.
</p>
+
<a NAME="HexEditMainWindow.__loadHexFile" ID="HexEditMainWindow.__loadHexFile"></a>
<h4>HexEditMainWindow.__loadHexFile</h4>
<b>__loadHexFile</b>(<i>fileName</i>)
-
<p>
Private method to load a binary file.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -440,17 +439,17 @@
<a NAME="HexEditMainWindow.__loadRecent" ID="HexEditMainWindow.__loadRecent"></a>
<h4>HexEditMainWindow.__loadRecent</h4>
<b>__loadRecent</b>(<i></i>)
-
<p>
Private method to load the list of recently opened files.
</p>
+
<a NAME="HexEditMainWindow.__maybeSave" ID="HexEditMainWindow.__maybeSave"></a>
<h4>HexEditMainWindow.__maybeSave</h4>
<b>__maybeSave</b>(<i></i>)
-
<p>
Private method to ask the user to save the file, if it was modified.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -466,10 +465,10 @@
<a NAME="HexEditMainWindow.__modificationChanged" ID="HexEditMainWindow.__modificationChanged"></a>
<h4>HexEditMainWindow.__modificationChanged</h4>
<b>__modificationChanged</b>(<i>m</i>)
-
<p>
Private slot to handle the dataChanged signal.
</p>
+
<dl>
<dt><i>m</i> (bool)</dt>
@@ -480,31 +479,31 @@
<a NAME="HexEditMainWindow.__openHexFile" ID="HexEditMainWindow.__openHexFile"></a>
<h4>HexEditMainWindow.__openHexFile</h4>
<b>__openHexFile</b>(<i></i>)
-
<p>
Private slot to open a binary file.
</p>
+
<a NAME="HexEditMainWindow.__openHexFileNewWindow" ID="HexEditMainWindow.__openHexFileNewWindow"></a>
<h4>HexEditMainWindow.__openHexFileNewWindow</h4>
<b>__openHexFileNewWindow</b>(<i></i>)
-
<p>
Private slot called to open a binary file in new hex editor window.
</p>
+
<a NAME="HexEditMainWindow.__openHexFileReadOnly" ID="HexEditMainWindow.__openHexFileReadOnly"></a>
<h4>HexEditMainWindow.__openHexFileReadOnly</h4>
<b>__openHexFileReadOnly</b>(<i></i>)
-
<p>
Private slot to open a binary file in read only mode.
</p>
+
<a NAME="HexEditMainWindow.__openRecentHexFile" ID="HexEditMainWindow.__openRecentHexFile"></a>
<h4>HexEditMainWindow.__openRecentHexFile</h4>
<b>__openRecentHexFile</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>
@@ -515,24 +514,24 @@
<a NAME="HexEditMainWindow.__preferencesChangedByLocalPreferencesDialog" ID="HexEditMainWindow.__preferencesChangedByLocalPreferencesDialog"></a>
<h4>HexEditMainWindow.__preferencesChangedByLocalPreferencesDialog</h4>
<b>__preferencesChangedByLocalPreferencesDialog</b>(<i></i>)
-
<p>
Private slot to handle preferences changes by our local dialog.
</p>
+
<a NAME="HexEditMainWindow.__replace" ID="HexEditMainWindow.__replace"></a>
<h4>HexEditMainWindow.__replace</h4>
<b>__replace</b>(<i></i>)
-
<p>
Private method to handle the replace action.
</p>
+
<a NAME="HexEditMainWindow.__saveHexDataFile" ID="HexEditMainWindow.__saveHexDataFile"></a>
<h4>HexEditMainWindow.__saveHexDataFile</h4>
<b>__saveHexDataFile</b>(<i>fileName</i>)
-
<p>
Private method to save the binary data to a file.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -555,10 +554,10 @@
<a NAME="HexEditMainWindow.__saveHexFile" ID="HexEditMainWindow.__saveHexFile"></a>
<h4>HexEditMainWindow.__saveHexFile</h4>
<b>__saveHexFile</b>(<i></i>)
-
<p>
Private method to save a binary file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -574,10 +573,10 @@
<a NAME="HexEditMainWindow.__saveHexFileAs" ID="HexEditMainWindow.__saveHexFileAs"></a>
<h4>HexEditMainWindow.__saveHexFileAs</h4>
<b>__saveHexFileAs</b>(<i></i>)
-
<p>
Private method to save the data to a new file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -593,10 +592,10 @@
<a NAME="HexEditMainWindow.__saveHexFileReadable" ID="HexEditMainWindow.__saveHexFileReadable"></a>
<h4>HexEditMainWindow.__saveHexFileReadable</h4>
<b>__saveHexFileReadable</b>(<i>selectionOnly=False</i>)
-
<p>
Private method to save the binary data in readable format.
</p>
+
<dl>
<dt><i>selectionOnly</i> (bool)</dt>
@@ -607,32 +606,32 @@
<a NAME="HexEditMainWindow.__saveRecent" ID="HexEditMainWindow.__saveRecent"></a>
<h4>HexEditMainWindow.__saveRecent</h4>
<b>__saveRecent</b>(<i></i>)
-
<p>
Private method to save the list of recently opened files.
</p>
+
<a NAME="HexEditMainWindow.__saveSelectionReadable" ID="HexEditMainWindow.__saveSelectionReadable"></a>
<h4>HexEditMainWindow.__saveSelectionReadable</h4>
<b>__saveSelectionReadable</b>(<i></i>)
-
<p>
Private method to save the data of the current selection in readable
format.
</p>
+
<a NAME="HexEditMainWindow.__search" ID="HexEditMainWindow.__search"></a>
<h4>HexEditMainWindow.__search</h4>
<b>__search</b>(<i></i>)
-
<p>
Private method to handle the search action.
</p>
+
<a NAME="HexEditMainWindow.__setCurrentFile" ID="HexEditMainWindow.__setCurrentFile"></a>
<h4>HexEditMainWindow.__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>
@@ -643,18 +642,18 @@
<a NAME="HexEditMainWindow.__setReadOnlyActionTexts" ID="HexEditMainWindow.__setReadOnlyActionTexts"></a>
<h4>HexEditMainWindow.__setReadOnlyActionTexts</h4>
<b>__setReadOnlyActionTexts</b>(<i></i>)
-
<p>
Private method to switch the 'Open Read Only' action between
'read only' and 'read write'.
</p>
+
<a NAME="HexEditMainWindow.__showAddress" ID="HexEditMainWindow.__showAddress"></a>
<h4>HexEditMainWindow.__showAddress</h4>
<b>__showAddress</b>(<i>address</i>)
-
<p>
Private slot to show the address of the cursor position.
</p>
+
<dl>
<dt><i>address</i> (int)</dt>
@@ -665,10 +664,10 @@
<a NAME="HexEditMainWindow.__showEditMode" ID="HexEditMainWindow.__showEditMode"></a>
<h4>HexEditMainWindow.__showEditMode</h4>
<b>__showEditMode</b>(<i>overwrite</i>)
-
<p>
Private slot to show the edit mode.
</p>
+
<dl>
<dt><i>overwrite</i> (bool)</dt>
@@ -679,24 +678,24 @@
<a NAME="HexEditMainWindow.__showFileMenu" ID="HexEditMainWindow.__showFileMenu"></a>
<h4>HexEditMainWindow.__showFileMenu</h4>
<b>__showFileMenu</b>(<i></i>)
-
<p>
Private slot to modify the file menu before being shown.
</p>
+
<a NAME="HexEditMainWindow.__showPreferences" ID="HexEditMainWindow.__showPreferences"></a>
<h4>HexEditMainWindow.__showPreferences</h4>
<b>__showPreferences</b>(<i></i>)
-
<p>
Private slot to set the preferences.
</p>
+
<a NAME="HexEditMainWindow.__showReadOnlyMode" ID="HexEditMainWindow.__showReadOnlyMode"></a>
<h4>HexEditMainWindow.__showReadOnlyMode</h4>
<b>__showReadOnlyMode</b>(<i>on</i>)
-
<p>
Private slot to show the read only mode.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -707,17 +706,17 @@
<a NAME="HexEditMainWindow.__showRecentMenu" ID="HexEditMainWindow.__showRecentMenu"></a>
<h4>HexEditMainWindow.__showRecentMenu</h4>
<b>__showRecentMenu</b>(<i></i>)
-
<p>
Private slot to set up the recent files menu.
</p>
+
<a NAME="HexEditMainWindow.__showSelectionInfo" ID="HexEditMainWindow.__showSelectionInfo"></a>
<h4>HexEditMainWindow.__showSelectionInfo</h4>
<b>__showSelectionInfo</b>(<i>avail</i>)
-
<p>
Private slot to show selection information.
</p>
+
<dl>
<dt><i>avail</i> (bool)</dt>
@@ -728,10 +727,10 @@
<a NAME="HexEditMainWindow.__showSize" ID="HexEditMainWindow.__showSize"></a>
<h4>HexEditMainWindow.__showSize</h4>
<b>__showSize</b>(<i>size</i>)
-
<p>
Private slot to show the binary data size.
</p>
+
<dl>
<dt><i>size</i> (int)</dt>
@@ -742,10 +741,10 @@
<a NAME="HexEditMainWindow.__strippedName" ID="HexEditMainWindow.__strippedName"></a>
<h4>HexEditMainWindow.__strippedName</h4>
<b>__strippedName</b>(<i>fullFileName</i>)
-
<p>
Private method to return the filename part of the given path.
</p>
+
<dl>
<dt><i>fullFileName</i> (str)</dt>
@@ -768,33 +767,33 @@
<a NAME="HexEditMainWindow.__toggleEditMode" ID="HexEditMainWindow.__toggleEditMode"></a>
<h4>HexEditMainWindow.__toggleEditMode</h4>
<b>__toggleEditMode</b>(<i></i>)
-
<p>
Private slot to toggle the edit mode upon a click on the status bar
label.
</p>
+
<a NAME="HexEditMainWindow.__toggleReadOnlyMode" ID="HexEditMainWindow.__toggleReadOnlyMode"></a>
<h4>HexEditMainWindow.__toggleReadOnlyMode</h4>
<b>__toggleReadOnlyMode</b>(<i></i>)
-
<p>
Private slot to toggle the read only mode upon a click on the status
bar label.
</p>
+
<a NAME="HexEditMainWindow.__whatsThis" ID="HexEditMainWindow.__whatsThis"></a>
<h4>HexEditMainWindow.__whatsThis</h4>
<b>__whatsThis</b>(<i></i>)
-
<p>
Private slot called in to enter Whats This mode.
</p>
+
<a NAME="HexEditMainWindow.closeEvent" ID="HexEditMainWindow.closeEvent"></a>
<h4>HexEditMainWindow.closeEvent</h4>
<b>closeEvent</b>(<i>evt</i>)
-
<p>
Protected event handler for the close event.
</p>
+
<dl>
<dt><i>evt</i> (QCloseEvent)</dt>
@@ -807,10 +806,10 @@
<a NAME="HexEditMainWindow.getSRHistory" ID="HexEditMainWindow.getSRHistory"></a>
<h4>HexEditMainWindow.getSRHistory</h4>
<b>getSRHistory</b>(<i>key</i>)
-
<p>
Public method to get the search or replace history list.
</p>
+
<dl>
<dt><i>key</i> (str (must be 'search' or 'replace'))</dt>
@@ -833,17 +832,17 @@
<a NAME="HexEditMainWindow.preferencesChanged" ID="HexEditMainWindow.preferencesChanged"></a>
<h4>HexEditMainWindow.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public method to (re-)read the various settings.
</p>
+
<a NAME="HexEditMainWindow.setRecentPaths" ID="HexEditMainWindow.setRecentPaths"></a>
<h4>HexEditMainWindow.setRecentPaths</h4>
<b>setRecentPaths</b>(<i>openPath, savePath</i>)
-
<p>
Public method to set the last open and save paths.
</p>
+
<dl>
<dt><i>openPath</i> (str)</dt>
@@ -857,4 +856,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
