diff -r 6e09a9a73cb7 -r 8b49d3e0b4c8 Documentation/Source/eric6.Plugins.ViewManagerPlugins.Tabview.Tabview.html --- a/Documentation/Source/eric6.Plugins.ViewManagerPlugins.Tabview.Tabview.html Sun Dec 31 18:54:06 2017 +0100 +++ b/Documentation/Source/eric6.Plugins.ViewManagerPlugins.Tabview.Tabview.html Mon Jan 01 19:06:33 2018 +0100 @@ -110,9 +110,9 @@ <p> Constructor </p><dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl><a NAME="TabBar.dragEnterEvent" ID="TabBar.dragEnterEvent"></a> <h4>TabBar.dragEnterEvent</h4> @@ -120,9 +120,9 @@ <p> Protected method to handle drag enter events. </p><dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QDragEnterEvent)</dt> <dd> -reference to the drag enter event (QDragEnterEvent) +reference to the drag enter event </dd> </dl><a NAME="TabBar.dropEvent" ID="TabBar.dropEvent"></a> <h4>TabBar.dropEvent</h4> @@ -130,9 +130,9 @@ <p> Protected method to handle drop events. </p><dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QDropEvent)</dt> <dd> -reference to the drop event (QDropEvent) +reference to the drop event </dd> </dl><a NAME="TabBar.mouseMoveEvent" ID="TabBar.mouseMoveEvent"></a> <h4>TabBar.mouseMoveEvent</h4> @@ -140,9 +140,9 @@ <p> Protected method to handle mouse move events. </p><dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QMouseEvent)</dt> <dd> -reference to the mouse move event (QMouseEvent) +reference to the mouse move event </dd> </dl><a NAME="TabBar.mousePressEvent" ID="TabBar.mousePressEvent"></a> <h4>TabBar.mousePressEvent</h4> @@ -150,9 +150,9 @@ <p> Protected method to handle mouse press events. </p><dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QMouseEvent)</dt> <dd> -reference to the mouse press event (QMouseEvent) +reference to the mouse press event </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -291,9 +291,9 @@ <p> Constructor </p><dl> -<dt><i>vm</i></dt> +<dt><i>vm</i> (Tabview)</dt> <dd> -view manager widget (Tabview) +view manager widget </dd> </dl><a NAME="TabWidget.__captionChange" ID="TabWidget.__captionChange"></a> <h4>TabWidget.__captionChange</h4> @@ -304,10 +304,10 @@ Updates the tab text and tooltip 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 -</dd><dt><i>editor</i></dt> +</dd><dt><i>editor</i> (Editor)</dt> <dd> Editor to update the caption for </dd> @@ -399,12 +399,12 @@ <p> Private method to copy an editor. </p><dl> -<dt><i>sourceIndex</i></dt> +<dt><i>sourceIndex</i> (int)</dt> <dd> -index of the tab (integer) -</dd><dt><i>targetIndex</i></dt> +index of the tab +</dd><dt><i>targetIndex</i> (int)</dt> <dd> -index position to place it to (integer) +index position to place it to </dd> </dl><a NAME="TabWidget.__copyTabOther" ID="TabWidget.__copyTabOther"></a> <h4>TabWidget.__copyTabOther</h4> @@ -412,15 +412,15 @@ <p> Private method to copy an editor from another TabWidget. </p><dl> -<dt><i>sourceId</i></dt> +<dt><i>sourceId</i> (str)</dt> <dd> -id of the TabWidget to get the editor from (string) -</dd><dt><i>sourceIndex</i></dt> +id of the TabWidget to get the editor from +</dd><dt><i>sourceIndex</i> (int)</dt> <dd> -index of the tab in the old tab widget (integer) -</dd><dt><i>targetIndex</i></dt> +index of the tab in the old tab widget +</dd><dt><i>targetIndex</i> (int)</dt> <dd> -index position to place it to (integer) +index position to place it to </dd> </dl><a NAME="TabWidget.__cursorLineChanged" ID="TabWidget.__cursorLineChanged"></a> <h4>TabWidget.__cursorLineChanged</h4> @@ -428,7 +428,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> @@ -443,9 +443,9 @@ <p> Private slot called to handle the navigation button menu selection. </p><dl> -<dt><i>act</i></dt> +<dt><i>act</i> (QAction)</dt> <dd> -reference to the selected action (QAction) +reference to the selected action </dd> </dl><a NAME="TabWidget.__relocateTab" ID="TabWidget.__relocateTab"></a> <h4>TabWidget.__relocateTab</h4> @@ -453,15 +453,15 @@ <p> Private method to relocate an editor from another TabWidget. </p><dl> -<dt><i>sourceId</i></dt> +<dt><i>sourceId</i> (str)</dt> <dd> -id of the TabWidget to get the editor from (string) -</dd><dt><i>sourceIndex</i></dt> +id of the TabWidget to get the editor from +</dd><dt><i>sourceIndex</i> (int)</dt> <dd> -index of the tab in the old tab widget (integer) -</dd><dt><i>targetIndex</i></dt> +index of the tab in the old tab widget +</dd><dt><i>targetIndex</i> (int)</dt> <dd> -index position to place it to (integer) +index position to place it to </dd> </dl><a NAME="TabWidget.__showContextMenu" ID="TabWidget.__showContextMenu"></a> <h4>TabWidget.__showContextMenu</h4> @@ -469,12 +469,12 @@ <p> Private slot to show the tab context menu. </p><dl> -<dt><i>coord</i></dt> +<dt><i>coord</i> (QPoint)</dt> <dd> -the position of the mouse pointer (QPoint) -</dd><dt><i>index</i></dt> +the position of the mouse pointer +</dd><dt><i>index</i> (int)</dt> <dd> -index of the tab the menu is requested for (integer) +index of the tab the menu is requested for </dd> </dl><a NAME="TabWidget.__showNavigationMenu" ID="TabWidget.__showNavigationMenu"></a> <h4>TabWidget.__showNavigationMenu</h4> @@ -487,13 +487,12 @@ <p> Public method to add a new tab. </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><dt><i>title</i></dt> +</dd><dt><i>title</i> (str)</dt> <dd> -title for the new tab (string) +title for the new tab </dd> </dl><a NAME="TabWidget.currentWidget" ID="TabWidget.currentWidget"></a> <h4>TabWidget.currentWidget</h4> @@ -503,7 +502,12 @@ </p><dl> <dt>Returns:</dt> <dd> -reference to the current page (Editor) +reference to the current page +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +Editor </dd> </dl><a NAME="TabWidget.hasEditor" ID="TabWidget.hasEditor"></a> <h4>TabWidget.hasEditor</h4> @@ -511,7 +515,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> @@ -521,6 +525,11 @@ flag indicating, whether the editor to be checked belongs to the list of editors managed by this tab widget. </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> </dl><a NAME="TabWidget.hasEditors" ID="TabWidget.hasEditors"></a> <h4>TabWidget.hasEditors</h4> <b>hasEditors</b>(<i></i>) @@ -531,20 +540,30 @@ <dd> flag indicating editors are managed </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> </dl><a NAME="TabWidget.indexOf" ID="TabWidget.indexOf"></a> <h4>TabWidget.indexOf</h4> <b>indexOf</b>(<i>widget</i>) <p> Public method to get the tab index of the given editor. </p><dl> -<dt><i>widget</i></dt> +<dt><i>widget</i> (QLabel or Editor)</dt> <dd> -widget to get the index for (QLabel or Editor) +widget to get the index for </dd> </dl><dl> <dt>Returns:</dt> <dd> -tab index of the editor (integer) +tab index of the editor +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl><a NAME="TabWidget.insertWidget" ID="TabWidget.insertWidget"></a> <h4>TabWidget.insertWidget</h4> @@ -552,21 +571,25 @@ <p> Public method to insert a new tab. </p><dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -index position for the new tab (integer) -</dd><dt><i>assembly</i></dt> +index position for the new tab +</dd><dt><i>assembly</i> (QScintilla.EditorAssembly.EditorAssembly)</dt> <dd> editor assembly object to be added - (QScintilla.EditorAssembly.EditorAssembly) -</dd><dt><i>title</i></dt> +</dd><dt><i>title</i> (str)</dt> <dd> -title for the new tab (string) +title for the new tab </dd> </dl><dl> <dt>Returns:</dt> <dd> -index of the inserted tab (integer) +index of the inserted tab +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl><a NAME="TabWidget.mouseDoubleClickEvent" ID="TabWidget.mouseDoubleClickEvent"></a> <h4>TabWidget.mouseDoubleClickEvent</h4> @@ -584,9 +607,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="TabWidget.setCurrentWidget" ID="TabWidget.setCurrentWidget"></a> <h4>TabWidget.setCurrentWidget</h4> @@ -594,10 +617,9 @@ <p> Public method to set the current tab by the given editor assembly. </p><dl> -<dt><i>assembly</i></dt> +<dt><i>assembly</i> (EditorAssembly.EditorAssembly)</dt> <dd> editor assembly to determine current tab from - (EditorAssembly.EditorAssembly) </dd> </dl><a NAME="TabWidget.showIndicator" ID="TabWidget.showIndicator"></a> <h4>TabWidget.showIndicator</h4> @@ -605,9 +627,9 @@ <p> Public slot to set the indicator on or off. </p><dl> -<dt><i>on</i></dt> +<dt><i>on</i> (bool)</dt> <dd> -flag indicating the dtate of the indicator (boolean) +flag indicating the state of the indicator </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -751,6 +773,9 @@ <td><a href="#Tabview.eventFilter">eventFilter</a></td> <td>Public method called to filter the event queue.</td> </tr><tr> +<td><a href="#Tabview.getOpenEditorsForSession">getOpenEditorsForSession</a></td> +<td>Public method to get a lists of all open editors.</td> +</tr><tr> <td><a href="#Tabview.getSplitOrientation">getSplitOrientation</a></td> <td>Public method to get the orientation of the split view.</td> </tr><tr> @@ -773,17 +798,23 @@ <td>Public slot used to move to the previous split.</td> </tr><tr> <td><a href="#Tabview.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="#Tabview.setEditorName">setEditorName</a></td> <td>Public method to change the displayed name of the editor.</td> </tr><tr> +<td><a href="#Tabview.setSplitCount">setSplitCount</a></td> +<td>Public method to set the number of split views.</td> +</tr><tr> <td><a href="#Tabview.setSplitOrientation">setSplitOrientation</a></td> <td>Public method used to set the orientation of the split view.</td> </tr><tr> <td><a href="#Tabview.showWindowMenu">showWindowMenu</a></td> <td>Public method to set up the viewmanager part of the Window menu.</td> </tr><tr> +<td><a href="#Tabview.splitCount">splitCount</a></td> +<td>Public method to get the number of splitted views.</td> +</tr><tr> <td><a href="#Tabview.tile">tile</a></td> <td>Public method to tile the managed windows.</td> </tr> @@ -798,9 +829,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="Tabview.__currentChanged" ID="Tabview.__currentChanged"></a> <h4>Tabview.__currentChanged</h4> @@ -808,29 +839,33 @@ <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 tab (integer) +index of the current tab </dd> </dl><a NAME="Tabview._addView" ID="Tabview._addView"></a> <h4>Tabview._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="Tabview._initWindowActions" ID="Tabview._initWindowActions"></a> <h4>Tabview._initWindowActions</h4> @@ -844,10 +879,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> @@ -862,7 +897,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> @@ -872,12 +907,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> (str)</dt> <dd> -filename of this editor (string) +filename of this editor </dd> </dl><a NAME="Tabview._syntaxErrorToggled" ID="Tabview._syntaxErrorToggled"></a> <h4>Tabview._syntaxErrorToggled</h4> @@ -885,7 +920,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> @@ -899,6 +934,11 @@ <dd> reference to the active editor </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +Editor +</dd> </dl><a NAME="Tabview.addSplit" ID="Tabview.addSplit"></a> <h4>Tabview.addSplit</h4> <b>addSplit</b>(<i></i>) @@ -914,6 +954,11 @@ <dd> flag indicating cascading of windows is available </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> </dl><a NAME="Tabview.canSplit" ID="Tabview.canSplit"></a> <h4>Tabview.canSplit</h4> <b>canSplit</b>(<i></i>) @@ -924,6 +969,11 @@ <dd> flag indicating splitting of the view is available. </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> </dl><a NAME="Tabview.canTile" ID="Tabview.canTile"></a> <h4>Tabview.canTile</h4> <b>canTile</b>(<i></i>) @@ -934,6 +984,11 @@ <dd> flag indicating tiling of windows is available </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> </dl><a NAME="Tabview.cascade" ID="Tabview.cascade"></a> <h4>Tabview.cascade</h4> <b>cascade</b>(<i></i>) @@ -945,18 +1000,41 @@ <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 (QObject) -</dd><dt><i>event</i></dt> +the QObject being watched +</dd><dt><i>event</i> (QEvent)</dt> <dd> -the event that occurred (QEvent) +the event that occurred </dd> </dl><dl> <dt>Returns:</dt> <dd> always False </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl><a NAME="Tabview.getOpenEditorsForSession" ID="Tabview.getOpenEditorsForSession"></a> +<h4>Tabview.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="Tabview.getSplitOrientation" ID="Tabview.getSplitOrientation"></a> <h4>Tabview.getSplitOrientation</h4> <b>getSplitOrientation</b>(<i></i>) @@ -965,7 +1043,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="Tabview.getTabWidgetById" ID="Tabview.getTabWidgetById"></a> <h4>Tabview.getTabWidgetById</h4> @@ -973,14 +1056,19 @@ <p> Public method to get a reference to a tab widget knowing its ID. </p><dl> -<dt><i>id_</i></dt> +<dt><i>id_</i> (int)</dt> <dd> -id of the tab widget (long) +id of the tab widget </dd> </dl><dl> <dt>Returns:</dt> <dd> -reference to the tab widget (TabWidget) +reference to the tab widget +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +TabWidget </dd> </dl><a NAME="Tabview.insertView" ID="Tabview.insertView"></a> <h4>Tabview.insertView</h4> @@ -988,22 +1076,21 @@ <p> Public 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 inserted -</dd><dt><i>tabWidget</i></dt> +</dd><dt><i>tabWidget</i> (TabWidget)</dt> <dd> reference to the tab widget to insert the editor into - (TabWidget) -</dd><dt><i>index</i></dt> +</dd><dt><i>index</i> (int)</dt> +<dd> +index position to insert at +</dd><dt><i>fn</i> (str)</dt> <dd> -index position to insert at (integer) -</dd><dt><i>fn</i></dt> +filename of this editor +</dd><dt><i>noName</i> (str)</dt> <dd> -filename of this editor (string) -</dd><dt><i>noName</i></dt> -<dd> -name to be used for an unnamed editor (string) +name to be used for an unnamed editor </dd> </dl><a NAME="Tabview.mainWidget" ID="Tabview.mainWidget"></a> <h4>Tabview.mainWidget</h4> @@ -1038,13 +1125,25 @@ Public slot used to move to the previous split. </p><a NAME="Tabview.removeSplit" ID="Tabview.removeSplit"></a> <h4>Tabview.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="Tabview.setEditorName" ID="Tabview.setEditorName"></a> <h4>Tabview.setEditorName</h4> @@ -1052,12 +1151,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="Tabview.setSplitCount" ID="Tabview.setSplitCount"></a> +<h4>Tabview.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="Tabview.setSplitOrientation" ID="Tabview.setSplitOrientation"></a> <h4>Tabview.setSplitOrientation</h4> @@ -1065,10 +1174,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="Tabview.showWindowMenu" ID="Tabview.showWindowMenu"></a> <h4>Tabview.showWindowMenu</h4> @@ -1076,10 +1184,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="Tabview.splitCount" ID="Tabview.splitCount"></a> +<h4>Tabview.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="Tabview.tile" ID="Tabview.tile"></a> <h4>Tabview.tile</h4> <b>tile</b>(<i></i>)