--- a/src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Listspace.Listspace.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Listspace.Listspace.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.ViewManagerPlugins.Listspace.Listspace</h1>
-
<p>
Module implementing the listspace viewmanager class.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#Listspace">Listspace</a></td>
<td>Class implementing the listspace viewmanager class.</td>
@@ -29,19 +27,20 @@
<td>Class implementing a custimized StackedWidget.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="Listspace" ID="Listspace"></a>
<h2>Listspace</h2>
-
<p>
Class implementing the listspace viewmanager class.
</p>
+
<h3>Signals</h3>
<dl>
@@ -150,19 +149,17 @@
<h3>Derived from</h3>
ViewManager
<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="#Listspace.__init__">Listspace</a></td>
<td>Constructor</td>
@@ -364,19 +361,20 @@
<td>Public method to tile the managed windows.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="Listspace.__init__" ID="Listspace.__init__"></a>
<h4>Listspace (Constructor)</h4>
<b>Listspace</b>(<i>parent</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -387,13 +385,13 @@
<a NAME="Listspace.__captionChange" ID="Listspace.__captionChange"></a>
<h4>Listspace.__captionChange</h4>
<b>__captionChange</b>(<i>cap, editor</i>)
-
<p>
Private method to handle caption change signals from the editor.
</p>
<p>
Updates the listwidget text to reflect the new caption information.
</p>
+
<dl>
<dt><i>cap</i> (str)</dt>
@@ -408,124 +406,124 @@
<a NAME="Listspace.__contextMenuClose" ID="Listspace.__contextMenuClose"></a>
<h4>Listspace.__contextMenuClose</h4>
<b>__contextMenuClose</b>(<i></i>)
-
<p>
Private method to close the selected editor.
</p>
+
<a NAME="Listspace.__contextMenuCloseAbove" ID="Listspace.__contextMenuCloseAbove"></a>
<h4>Listspace.__contextMenuCloseAbove</h4>
<b>__contextMenuCloseAbove</b>(<i></i>)
-
<p>
Private method to close editors above.
</p>
+
<a NAME="Listspace.__contextMenuCloseAll" ID="Listspace.__contextMenuCloseAll"></a>
<h4>Listspace.__contextMenuCloseAll</h4>
<b>__contextMenuCloseAll</b>(<i></i>)
-
<p>
Private method to close all editors.
</p>
+
<a NAME="Listspace.__contextMenuCloseBelow" ID="Listspace.__contextMenuCloseBelow"></a>
<h4>Listspace.__contextMenuCloseBelow</h4>
<b>__contextMenuCloseBelow</b>(<i></i>)
-
<p>
Private method to close editors below.
</p>
+
<a NAME="Listspace.__contextMenuCloseOthers" ID="Listspace.__contextMenuCloseOthers"></a>
<h4>Listspace.__contextMenuCloseOthers</h4>
<b>__contextMenuCloseOthers</b>(<i></i>)
-
<p>
Private method to close the other editors.
</p>
+
<a NAME="Listspace.__contextMenuCopyPathToClipboard" ID="Listspace.__contextMenuCopyPathToClipboard"></a>
<h4>Listspace.__contextMenuCopyPathToClipboard</h4>
<b>__contextMenuCopyPathToClipboard</b>(<i></i>)
-
<p>
Private method to copy the file name of the selected editor to the
clipboard.
</p>
+
<a NAME="Listspace.__contextMenuCoverageScript" ID="Listspace.__contextMenuCoverageScript"></a>
<h4>Listspace.__contextMenuCoverageScript</h4>
<b>__contextMenuCoverageScript</b>(<i></i>)
-
<p>
Private method to run a coverage test of the editor script.
</p>
+
<a NAME="Listspace.__contextMenuDebugScript" ID="Listspace.__contextMenuDebugScript"></a>
<h4>Listspace.__contextMenuDebugScript</h4>
<b>__contextMenuDebugScript</b>(<i></i>)
-
<p>
Private method to debug the editor script.
</p>
+
<a NAME="Listspace.__contextMenuOpenRejections" ID="Listspace.__contextMenuOpenRejections"></a>
<h4>Listspace.__contextMenuOpenRejections</h4>
<b>__contextMenuOpenRejections</b>(<i></i>)
-
<p>
Private slot to open a rejections file associated with the selected
editor.
</p>
+
<a NAME="Listspace.__contextMenuPrintFile" ID="Listspace.__contextMenuPrintFile"></a>
<h4>Listspace.__contextMenuPrintFile</h4>
<b>__contextMenuPrintFile</b>(<i></i>)
-
<p>
Private method to print the selected editor.
</p>
+
<a NAME="Listspace.__contextMenuPrintPreviewFile" ID="Listspace.__contextMenuPrintPreviewFile"></a>
<h4>Listspace.__contextMenuPrintPreviewFile</h4>
<b>__contextMenuPrintPreviewFile</b>(<i></i>)
-
<p>
Private method to show a print preview of the selected editor.
</p>
+
<a NAME="Listspace.__contextMenuProfileScript" ID="Listspace.__contextMenuProfileScript"></a>
<h4>Listspace.__contextMenuProfileScript</h4>
<b>__contextMenuProfileScript</b>(<i></i>)
-
<p>
Private method to profile the editor script.
</p>
+
<a NAME="Listspace.__contextMenuRunScript" ID="Listspace.__contextMenuRunScript"></a>
<h4>Listspace.__contextMenuRunScript</h4>
<b>__contextMenuRunScript</b>(<i></i>)
-
<p>
Private method to run the editor script.
</p>
+
<a NAME="Listspace.__contextMenuSave" ID="Listspace.__contextMenuSave"></a>
<h4>Listspace.__contextMenuSave</h4>
<b>__contextMenuSave</b>(<i></i>)
-
<p>
Private method to save the selected editor.
</p>
+
<a NAME="Listspace.__contextMenuSaveAll" ID="Listspace.__contextMenuSaveAll"></a>
<h4>Listspace.__contextMenuSaveAll</h4>
<b>__contextMenuSaveAll</b>(<i></i>)
-
<p>
Private method to save all editors.
</p>
+
<a NAME="Listspace.__contextMenuSaveAs" ID="Listspace.__contextMenuSaveAs"></a>
<h4>Listspace.__contextMenuSaveAs</h4>
<b>__contextMenuSaveAs</b>(<i></i>)
-
<p>
Private method to save the selected editor to a new file.
</p>
+
<a NAME="Listspace.__currentChanged" ID="Listspace.__currentChanged"></a>
<h4>Listspace.__currentChanged</h4>
<b>__currentChanged</b>(<i>index</i>)
-
<p>
Private slot to handle the currentChanged signal.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -536,10 +534,10 @@
<a NAME="Listspace.__cursorLineChanged" ID="Listspace.__cursorLineChanged"></a>
<h4>Listspace.__cursorLineChanged</h4>
<b>__cursorLineChanged</b>(<i>lineno, editor</i>)
-
<p>
Private slot to handle a change of the current editor's cursor line.
</p>
+
<dl>
<dt><i>lineno</i> (int)</dt>
@@ -554,17 +552,17 @@
<a NAME="Listspace.__initMenu" ID="Listspace.__initMenu"></a>
<h4>Listspace.__initMenu</h4>
<b>__initMenu</b>(<i></i>)
-
<p>
Private method to initialize the viewlist context menu.
</p>
+
<a NAME="Listspace.__setIcon" ID="Listspace.__setIcon"></a>
<h4>Listspace.__setIcon</h4>
<b>__setIcon</b>(<i>editor, modified</i>)
-
<p>
Private method to set the icon for the given editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -579,11 +577,11 @@
<a NAME="Listspace.__showMenu" ID="Listspace.__showMenu"></a>
<h4>Listspace.__showMenu</h4>
<b>__showMenu</b>(<i>point</i>)
-
<p>
Private slot to handle the customContextMenuRequested signal of
the viewlist.
</p>
+
<dl>
<dt><i>point</i> (QPoint)</dt>
@@ -594,10 +592,10 @@
<a NAME="Listspace.__showSelectedView" ID="Listspace.__showSelectedView"></a>
<h4>Listspace.__showSelectedView</h4>
<b>__showSelectedView</b>(<i>row</i>)
-
<p>
Private slot called to show a view selected in the list.
</p>
+
<dl>
<dt><i>row</i> (int)</dt>
@@ -608,10 +606,10 @@
<a NAME="Listspace._addView" ID="Listspace._addView"></a>
<h4>Listspace._addView</h4>
<b>_addView</b>(<i>win, fn=None, noName="", addNext=False, indexes=None</i>)
-
<p>
Protected method to add a view (i.e. window).
</p>
+
<dl>
<dt><i>win</i> (EditorAssembly)</dt>
@@ -640,18 +638,18 @@
<a NAME="Listspace._initWindowActions" ID="Listspace._initWindowActions"></a>
<h4>Listspace._initWindowActions</h4>
<b>_initWindowActions</b>(<i></i>)
-
<p>
Protected method to define the user interface actions for window
handling.
</p>
+
<a NAME="Listspace._modificationStatusChanged" ID="Listspace._modificationStatusChanged"></a>
<h4>Listspace._modificationStatusChanged</h4>
<b>_modificationStatusChanged</b>(<i>modified, editor</i>)
-
<p>
Protected slot to handle the modificationStatusChanged signal.
</p>
+
<dl>
<dt><i>modified</i> (bool)</dt>
@@ -666,17 +664,17 @@
<a NAME="Listspace._removeAllViews" ID="Listspace._removeAllViews"></a>
<h4>Listspace._removeAllViews</h4>
<b>_removeAllViews</b>(<i></i>)
-
<p>
Protected method to remove all views (i.e. windows).
</p>
+
<a NAME="Listspace._removeView" ID="Listspace._removeView"></a>
<h4>Listspace._removeView</h4>
<b>_removeView</b>(<i>win</i>)
-
<p>
Protected method to remove a view (i.e. window).
</p>
+
<dl>
<dt><i>win</i> (Editor)</dt>
@@ -687,10 +685,10 @@
<a NAME="Listspace._showView" ID="Listspace._showView"></a>
<h4>Listspace._showView</h4>
<b>_showView</b>(<i>win, fn=None</i>)
-
<p>
Protected method to show a view (i.e. window).
</p>
+
<dl>
<dt><i>win</i> (EditorAssembly)</dt>
@@ -705,10 +703,10 @@
<a NAME="Listspace._syntaxErrorToggled" ID="Listspace._syntaxErrorToggled"></a>
<h4>Listspace._syntaxErrorToggled</h4>
<b>_syntaxErrorToggled</b>(<i>editor</i>)
-
<p>
Protected slot to handle the syntaxerrorToggled signal.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -719,10 +717,10 @@
<a NAME="Listspace.activeWindow" ID="Listspace.activeWindow"></a>
<h4>Listspace.activeWindow</h4>
<b>activeWindow</b>(<i></i>)
-
<p>
Public method to return the active (i.e. current) window.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -738,17 +736,17 @@
<a NAME="Listspace.addSplit" ID="Listspace.addSplit"></a>
<h4>Listspace.addSplit</h4>
<b>addSplit</b>(<i></i>)
-
<p>
Public method used to split the current view.
</p>
+
<a NAME="Listspace.canCascade" ID="Listspace.canCascade"></a>
<h4>Listspace.canCascade</h4>
<b>canCascade</b>(<i></i>)
-
<p>
Public method to signal if cascading of managed windows is available.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -764,10 +762,10 @@
<a NAME="Listspace.canSplit" ID="Listspace.canSplit"></a>
<h4>Listspace.canSplit</h4>
<b>canSplit</b>(<i></i>)
-
<p>
public method to signal if splitting of the view is available.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -783,10 +781,10 @@
<a NAME="Listspace.canTile" ID="Listspace.canTile"></a>
<h4>Listspace.canTile</h4>
<b>canTile</b>(<i></i>)
-
<p>
Public method to signal if tiling of managed windows is available.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -802,17 +800,17 @@
<a NAME="Listspace.cascade" ID="Listspace.cascade"></a>
<h4>Listspace.cascade</h4>
<b>cascade</b>(<i></i>)
-
<p>
Public method to cascade the managed windows.
</p>
+
<a NAME="Listspace.eventFilter" ID="Listspace.eventFilter"></a>
<h4>Listspace.eventFilter</h4>
<b>eventFilter</b>(<i>watched, event</i>)
-
<p>
Public method called to filter the event queue.
</p>
+
<dl>
<dt><i>watched</i> (QObject)</dt>
@@ -839,7 +837,6 @@
<a NAME="Listspace.getOpenEditorsForSession" ID="Listspace.getOpenEditorsForSession"></a>
<h4>Listspace.getOpenEditorsForSession</h4>
<b>getOpenEditorsForSession</b>(<i></i>)
-
<p>
Public method to get a lists of all open editors.
</p>
@@ -847,6 +844,7 @@
The returned list contains one list per split view. If the view manager
cannot split the view, only one list of editors is returned.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -862,10 +860,10 @@
<a NAME="Listspace.getSplitOrientation" ID="Listspace.getSplitOrientation"></a>
<h4>Listspace.getSplitOrientation</h4>
<b>getSplitOrientation</b>(<i></i>)
-
<p>
Public method to get the orientation of the split view.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -881,11 +879,11 @@
<a NAME="Listspace.mainWidget" ID="Listspace.mainWidget"></a>
<h4>Listspace.mainWidget</h4>
<b>mainWidget</b>(<i></i>)
-
<p>
Public method to return a reference to the main Widget of a
specific view manager subclass.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -901,25 +899,25 @@
<a NAME="Listspace.nextSplit" ID="Listspace.nextSplit"></a>
<h4>Listspace.nextSplit</h4>
<b>nextSplit</b>(<i></i>)
-
<p>
Public slot used to move to the next split.
</p>
+
<a NAME="Listspace.prevSplit" ID="Listspace.prevSplit"></a>
<h4>Listspace.prevSplit</h4>
<b>prevSplit</b>(<i></i>)
-
<p>
Public slot used to move to the previous split.
</p>
+
<a NAME="Listspace.removeSplit" ID="Listspace.removeSplit"></a>
<h4>Listspace.removeSplit</h4>
<b>removeSplit</b>(<i>index=-1</i>)
-
<p>
Public method used to remove the current split view or a split view
by index.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -943,10 +941,10 @@
<a NAME="Listspace.setEditorName" ID="Listspace.setEditorName"></a>
<h4>Listspace.setEditorName</h4>
<b>setEditorName</b>(<i>editor, newName</i>)
-
<p>
Public method to change the displayed name of the editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -961,10 +959,10 @@
<a NAME="Listspace.setSplitCount" ID="Listspace.setSplitCount"></a>
<h4>Listspace.setSplitCount</h4>
<b>setSplitCount</b>(<i>count</i>)
-
<p>
Public method to set the number of split views.
</p>
+
<dl>
<dt><i>count</i> (int)</dt>
@@ -975,10 +973,10 @@
<a NAME="Listspace.setSplitOrientation" ID="Listspace.setSplitOrientation"></a>
<h4>Listspace.setSplitOrientation</h4>
<b>setSplitOrientation</b>(<i>orientation</i>)
-
<p>
Public method used to set the orientation of the split view.
</p>
+
<dl>
<dt><i>orientation</i> (Qt.Orientation.Horizontal or Qt.Orientation.Vertical)</dt>
@@ -989,10 +987,10 @@
<a NAME="Listspace.showWindowMenu" ID="Listspace.showWindowMenu"></a>
<h4>Listspace.showWindowMenu</h4>
<b>showWindowMenu</b>(<i>windowMenu</i>)
-
<p>
Public method to set up the viewmanager part of the Window menu.
</p>
+
<dl>
<dt><i>windowMenu</i> (QMenu)</dt>
@@ -1003,10 +1001,10 @@
<a NAME="Listspace.splitCount" ID="Listspace.splitCount"></a>
<h4>Listspace.splitCount</h4>
<b>splitCount</b>(<i></i>)
-
<p>
Public method to get the number of splitted views.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1022,35 +1020,33 @@
<a NAME="Listspace.tile" ID="Listspace.tile"></a>
<h4>Listspace.tile</h4>
<b>tile</b>(<i></i>)
-
<p>
Public method to tile the managed windows.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="StackedWidget" ID="StackedWidget"></a>
<h2>StackedWidget</h2>
-
<p>
Class implementing a custimized StackedWidget.
</p>
+
<h3>Derived from</h3>
QStackedWidget
<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="#StackedWidget.__init__">StackedWidget</a></td>
<td>Constructor</td>
@@ -1092,19 +1088,20 @@
<td>Public method to set the current widget.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="StackedWidget.__init__" ID="StackedWidget.__init__"></a>
<h4>StackedWidget (Constructor)</h4>
<b>StackedWidget</b>(<i>parent</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -1115,10 +1112,10 @@
<a NAME="StackedWidget.addWidget" ID="StackedWidget.addWidget"></a>
<h4>StackedWidget.addWidget</h4>
<b>addWidget</b>(<i>assembly</i>)
-
<p>
Public method to add a new widget.
</p>
+
<dl>
<dt><i>assembly</i> (QScintilla.EditorAssembly.EditorAssembly)</dt>
@@ -1129,10 +1126,10 @@
<a NAME="StackedWidget.currentWidget" ID="StackedWidget.currentWidget"></a>
<h4>StackedWidget.currentWidget</h4>
<b>currentWidget</b>(<i></i>)
-
<p>
Public method to get a reference to the current editor.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1148,11 +1145,11 @@
<a NAME="StackedWidget.firstEditor" ID="StackedWidget.firstEditor"></a>
<h4>StackedWidget.firstEditor</h4>
<b>firstEditor</b>(<i></i>)
-
<p>
Public method to retrieve the first editor in the list of managed
editors.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1168,10 +1165,10 @@
<a NAME="StackedWidget.hasEditor" ID="StackedWidget.hasEditor"></a>
<h4>StackedWidget.hasEditor</h4>
<b>hasEditor</b>(<i>editor</i>)
-
<p>
Public method to check for an editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -1195,24 +1192,24 @@
<a NAME="StackedWidget.nextTab" ID="StackedWidget.nextTab"></a>
<h4>StackedWidget.nextTab</h4>
<b>nextTab</b>(<i></i>)
-
<p>
Public slot used to show the next tab.
</p>
+
<a NAME="StackedWidget.prevTab" ID="StackedWidget.prevTab"></a>
<h4>StackedWidget.prevTab</h4>
<b>prevTab</b>(<i></i>)
-
<p>
Public slot used to show the previous tab.
</p>
+
<a NAME="StackedWidget.removeWidget" ID="StackedWidget.removeWidget"></a>
<h4>StackedWidget.removeWidget</h4>
<b>removeWidget</b>(<i>widget</i>)
-
<p>
Public method to remove a widget.
</p>
+
<dl>
<dt><i>widget</i> (QWidget)</dt>
@@ -1223,10 +1220,10 @@
<a NAME="StackedWidget.setCurrentIndex" ID="StackedWidget.setCurrentIndex"></a>
<h4>StackedWidget.setCurrentIndex</h4>
<b>setCurrentIndex</b>(<i>index</i>)
-
<p>
Public method to set the current widget by its index.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -1237,10 +1234,10 @@
<a NAME="StackedWidget.setCurrentWidget" ID="StackedWidget.setCurrentWidget"></a>
<h4>StackedWidget.setCurrentWidget</h4>
<b>setCurrentWidget</b>(<i>widget</i>)
-
<p>
Public method to set the current widget.
</p>
+
<dl>
<dt><i>widget</i> (QWidget)</dt>
@@ -1250,4 +1247,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
