Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric6.Plugins.ViewManagerPlugins.Listspace.Listspace.html

Documentation/Source/eric6.Plugins.ViewManagerPlugins.Listspace.Listspace.html

changeset 6052
8b49d3e0b4c8
parent 5606
da305d172769
child 6123
39cd368143db
--- a/Documentation/Source/eric6.Plugins.ViewManagerPlugins.Listspace.Listspace.html	Sun Dec 31 18:54:06 2017 +0100
+++ b/Documentation/Source/eric6.Plugins.ViewManagerPlugins.Listspace.Listspace.html	Mon Jan 01 19:06:33 2018 +0100
@@ -223,6 +223,9 @@
 <td><a href="#Listspace.eventFilter">eventFilter</a></td>
 <td>Public method called to filter the event queue.</td>
 </tr><tr>
+<td><a href="#Listspace.getOpenEditorsForSession">getOpenEditorsForSession</a></td>
+<td>Public method to get a lists of all open editors.</td>
+</tr><tr>
 <td><a href="#Listspace.getSplitOrientation">getSplitOrientation</a></td>
 <td>Public method to get the orientation of the split view.</td>
 </tr><tr>
@@ -236,17 +239,23 @@
 <td>Public slot used to move to the previous split.</td>
 </tr><tr>
 <td><a href="#Listspace.removeSplit">removeSplit</a></td>
-<td>Public method used to remove the current split view.</td>
+<td>Public method used to remove the current split view or a split view by index.</td>
 </tr><tr>
 <td><a href="#Listspace.setEditorName">setEditorName</a></td>
 <td>Public method to change the displayed name of the editor.</td>
 </tr><tr>
+<td><a href="#Listspace.setSplitCount">setSplitCount</a></td>
+<td>Public method to set the number of split views.</td>
+</tr><tr>
 <td><a href="#Listspace.setSplitOrientation">setSplitOrientation</a></td>
 <td>Public method used to set the orientation of the split view.</td>
 </tr><tr>
 <td><a href="#Listspace.showWindowMenu">showWindowMenu</a></td>
 <td>Public method to set up the viewmanager part of the Window menu.</td>
 </tr><tr>
+<td><a href="#Listspace.splitCount">splitCount</a></td>
+<td>Public method to get the number of splitted views.</td>
+</tr><tr>
 <td><a href="#Listspace.tile">tile</a></td>
 <td>Public method to tile the managed windows.</td>
 </tr>
@@ -261,9 +270,9 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl><a NAME="Listspace.__captionChange" ID="Listspace.__captionChange"></a>
 <h4>Listspace.__captionChange</h4>
@@ -273,10 +282,10 @@
 </p><p>
         Updates the listwidget text to reflect the new caption information.
 </p><dl>
-<dt><i>cap</i></dt>
+<dt><i>cap</i> (str)</dt>
 <dd>
-Caption for the editor (string)
-</dd><dt><i>editor</i></dt>
+Caption for the editor
+</dd><dt><i>editor</i> (Editor)</dt>
 <dd>
 Editor to update the caption for
 </dd>
@@ -333,7 +342,7 @@
 <p>
         Private slot to handle the currentChanged signal.
 </p><dl>
-<dt><i>index</i></dt>
+<dt><i>index</i> (int)</dt>
 <dd>
 index of the current editor
 </dd>
@@ -343,7 +352,7 @@
 <p>
         Private slot to handle a change of the current editor's cursor line.
 </p><dl>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
 line number of the current editor's cursor (zero based)
 </dd>
@@ -359,9 +368,9 @@
         Private slot to handle the customContextMenuRequested signal of
         the viewlist.
 </p><dl>
-<dt><i>point</i></dt>
+<dt><i>point</i> (QPoint)</dt>
 <dd>
-position to open the menu at (QPoint)
+position to open the menu at
 </dd>
 </dl><a NAME="Listspace.__showSelectedView" ID="Listspace.__showSelectedView"></a>
 <h4>Listspace.__showSelectedView</h4>
@@ -369,29 +378,33 @@
 <p>
         Private slot called to show a view selected in the list.
 </p><dl>
-<dt><i>row</i></dt>
+<dt><i>row</i> (int)</dt>
 <dd>
-row number of the item clicked on (integer)
+row number of the item clicked on
 </dd>
 </dl><a NAME="Listspace._addView" ID="Listspace._addView"></a>
 <h4>Listspace._addView</h4>
-<b>_addView</b>(<i>win, fn=None, noName="", addNext=False</i>)
+<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></dt>
+<dt><i>win</i> (EditorAssembly)</dt>
 <dd>
 editor assembly to be added
-</dd><dt><i>fn</i></dt>
+</dd><dt><i>fn</i> (str)</dt>
 <dd>
-filename of this editor (string)
-</dd><dt><i>noName</i></dt>
+filename of this editor
+</dd><dt><i>noName</i> (str)</dt>
 <dd>
-name to be used for an unnamed editor (string)
-</dd><dt><i>addNext</i></dt>
+name to be used for an unnamed editor
+</dd><dt><i>addNext</i> (bool)</dt>
 <dd>
 flag indicating to add the view next to the current
-            view (bool)
+            view
+</dd><dt><i>indexes</i> (tuple of two int)</dt>
+<dd>
+of the editor, first the split view index, second the
+            index within the view
 </dd>
 </dl><a NAME="Listspace._initWindowActions" ID="Listspace._initWindowActions"></a>
 <h4>Listspace._initWindowActions</h4>
@@ -405,10 +418,10 @@
 <p>
         Protected slot to handle the modificationStatusChanged signal.
 </p><dl>
-<dt><i>m</i></dt>
+<dt><i>m</i> (bool)</dt>
 <dd>
-flag indicating the modification status (boolean)
-</dd><dt><i>editor</i></dt>
+flag indicating the modification status
+</dd><dt><i>editor</i> (Editor)</dt>
 <dd>
 editor window changed
 </dd>
@@ -423,7 +436,7 @@
 <p>
         Protected method to remove a view (i.e. window).
 </p><dl>
-<dt><i>win</i></dt>
+<dt><i>win</i> (Editor)</dt>
 <dd>
 editor window to be removed
 </dd>
@@ -433,12 +446,12 @@
 <p>
         Protected method to show a view (i.e. window).
 </p><dl>
-<dt><i>win</i></dt>
+<dt><i>win</i> (EditorAssembly)</dt>
 <dd>
 editor assembly to be shown
-</dd><dt><i>fn</i></dt>
+</dd><dt><i>fn</i> (string)</dt>
 <dd>
-filename of this editor (string)
+filename of this editor
 </dd>
 </dl><a NAME="Listspace._syntaxErrorToggled" ID="Listspace._syntaxErrorToggled"></a>
 <h4>Listspace._syntaxErrorToggled</h4>
@@ -446,7 +459,7 @@
 <p>
         Protected slot to handle the syntaxerrorToggled signal.
 </p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 editor that sent the signal
 </dd>
@@ -460,6 +473,11 @@
 <dd>
 reference to the active editor
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+EditorAssembly
+</dd>
 </dl><a NAME="Listspace.addSplit" ID="Listspace.addSplit"></a>
 <h4>Listspace.addSplit</h4>
 <b>addSplit</b>(<i></i>)
@@ -475,6 +493,11 @@
 <dd>
 flag indicating cascading of windows is available
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="Listspace.canSplit" ID="Listspace.canSplit"></a>
 <h4>Listspace.canSplit</h4>
 <b>canSplit</b>(<i></i>)
@@ -483,7 +506,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating splitting of the view is available.
+flag indicating splitting of the view is available
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="Listspace.canTile" ID="Listspace.canTile"></a>
 <h4>Listspace.canTile</h4>
@@ -495,6 +523,11 @@
 <dd>
 flag indicating tiling of windows is available
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="Listspace.cascade" ID="Listspace.cascade"></a>
 <h4>Listspace.cascade</h4>
 <b>cascade</b>(<i></i>)
@@ -506,10 +539,10 @@
 <p>
         Public method called to filter the event queue.
 </p><dl>
-<dt><i>watched</i></dt>
+<dt><i>watched</i> (QObject)</dt>
 <dd>
 the QObject being watched
-</dd><dt><i>event</i></dt>
+</dd><dt><i>event</i> (QEvent)</dt>
 <dd>
 the event that occurred
 </dd>
@@ -518,6 +551,29 @@
 <dd>
 flag indicating, if we handled the event
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><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><p>
+        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>Returns:</dt>
+<dd>
+list of list of editor references
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of list of Editor
+</dd>
 </dl><a NAME="Listspace.getSplitOrientation" ID="Listspace.getSplitOrientation"></a>
 <h4>Listspace.getSplitOrientation</h4>
 <b>getSplitOrientation</b>(<i></i>)
@@ -526,7 +582,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-orientation of the split (Qt.Horizontal or Qt.Vertical)
+orientation of the split
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+Qt.Horizontal or Qt.Vertical
 </dd>
 </dl><a NAME="Listspace.mainWidget" ID="Listspace.mainWidget"></a>
 <h4>Listspace.mainWidget</h4>
@@ -556,13 +617,25 @@
         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></i>)
+<b>removeSplit</b>(<i>index=-1</i>)
 <p>
-        Public method used to remove the current split view.
+        Public method used to remove the current split view or a split view
+        by index.
 </p><dl>
+<dt><i>index</i> (int)</dt>
+<dd>
+index of the split to be removed (-1 means to
+            delete the current split)
+</dd>
+</dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating successfull removal
+flag indicating successful deletion
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="Listspace.setEditorName" ID="Listspace.setEditorName"></a>
 <h4>Listspace.setEditorName</h4>
@@ -570,12 +643,22 @@
 <p>
         Public method to change the displayed name of the editor.
 </p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 editor window to be changed
-</dd><dt><i>newName</i></dt>
+</dd><dt><i>newName</i> (str)</dt>
 <dd>
-new name to be shown (string)
+new name to be shown
+</dd>
+</dl><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>
+<dd>
+number of split views
 </dd>
 </dl><a NAME="Listspace.setSplitOrientation" ID="Listspace.setSplitOrientation"></a>
 <h4>Listspace.setSplitOrientation</h4>
@@ -583,10 +666,9 @@
 <p>
         Public method used to set the orientation of the split view.
 </p><dl>
-<dt><i>orientation</i></dt>
+<dt><i>orientation</i> (Qt.Horizontal or Qt.Vertical)</dt>
 <dd>
 orientation of the split
-                (Qt.Horizontal or Qt.Vertical)
 </dd>
 </dl><a NAME="Listspace.showWindowMenu" ID="Listspace.showWindowMenu"></a>
 <h4>Listspace.showWindowMenu</h4>
@@ -594,10 +676,25 @@
 <p>
         Public method to set up the viewmanager part of the Window menu.
 </p><dl>
-<dt><i>windowMenu</i></dt>
+<dt><i>windowMenu</i> (QMenu)</dt>
 <dd>
 reference to the window menu
 </dd>
+</dl><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>Returns:</dt>
+<dd>
+number of splitted views
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
 </dl><a NAME="Listspace.tile" ID="Listspace.tile"></a>
 <h4>Listspace.tile</h4>
 <b>tile</b>(<i></i>)
@@ -665,9 +762,9 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl><a NAME="StackedWidget.addWidget" ID="StackedWidget.addWidget"></a>
 <h4>StackedWidget.addWidget</h4>
@@ -675,10 +772,9 @@
 <p>
         Public method to add a new widget.
 </p><dl>
-<dt><i>assembly</i></dt>
+<dt><i>assembly</i> (QScintilla.EditorAssembly.EditorAssembly)</dt>
 <dd>
 editor assembly object to be added
-            (QScintilla.EditorAssembly.EditorAssembly)
 </dd>
 </dl><a NAME="StackedWidget.currentWidget" ID="StackedWidget.currentWidget"></a>
 <h4>StackedWidget.currentWidget</h4>
@@ -688,7 +784,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-reference to the current editor (Editor)
+reference to the current editor
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+Editor
 </dd>
 </dl><a NAME="StackedWidget.firstEditor" ID="StackedWidget.firstEditor"></a>
 <h4>StackedWidget.firstEditor</h4>
@@ -699,7 +800,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-first editor in list (QScintilla.Editor.Editor)
+first editor in list
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QScintilla.Editor.Editor
 </dd>
 </dl><a NAME="StackedWidget.hasEditor" ID="StackedWidget.hasEditor"></a>
 <h4>StackedWidget.hasEditor</h4>
@@ -707,7 +813,7 @@
 <p>
         Public method to check for an editor.
 </p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 editor object to check for
 </dd>
@@ -717,6 +823,11 @@
 flag indicating, whether the editor to be checked belongs
             to the list of editors managed by this stacked widget.
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="StackedWidget.nextTab" ID="StackedWidget.nextTab"></a>
 <h4>StackedWidget.nextTab</h4>
 <b>nextTab</b>(<i></i>)
@@ -733,9 +844,9 @@
 <p>
         Public method to remove a widget.
 </p><dl>
-<dt><i>widget</i></dt>
+<dt><i>widget</i> (QWidget)</dt>
 <dd>
-widget to be removed (QWidget)
+widget to be removed
 </dd>
 </dl><a NAME="StackedWidget.setCurrentIndex" ID="StackedWidget.setCurrentIndex"></a>
 <h4>StackedWidget.setCurrentIndex</h4>
@@ -743,9 +854,9 @@
 <p>
         Public method to set the current widget by its index.
 </p><dl>
-<dt><i>index</i></dt>
+<dt><i>index</i> (int)</dt>
 <dd>
-index of widget to be made current (integer)
+index of widget to be made current
 </dd>
 </dl><a NAME="StackedWidget.setCurrentWidget" ID="StackedWidget.setCurrentWidget"></a>
 <h4>StackedWidget.setCurrentWidget</h4>
@@ -753,9 +864,9 @@
 <p>
         Public method to set the current widget.
 </p><dl>
-<dt><i>widget</i></dt>
+<dt><i>widget</i> (QWidget)</dt>
 <dd>
-widget to be made current (QWidget)
+widget to be made current
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial