--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.ViewManagerPlugins.Listspace.Listspace.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,589 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Plugins.ViewManagerPlugins.Listspace.Listspace</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.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> +</tr><tr> +<td><a href="#StackedWidget">StackedWidget</a></td> +<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><h4>Signals</h4> +<dl> +<dt>changeCaption(string)</dt> +<dd> +emitted if a change of the caption is necessary +</dd><dt>editorChanged(string)</dt> +<dd> +emitted when the current editor has changed +</dd> +</dl> +<h3>Derived from</h3> +QSplitter, ViewManager +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Listspace.__init__">Listspace</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Listspace.__captionChange">__captionChange</a></td> +<td>Private method to handle caption change signals from the editor.</td> +</tr><tr> +<td><a href="#Listspace.__contextMenuClose">__contextMenuClose</a></td> +<td>Private method to close the selected tab.</td> +</tr><tr> +<td><a href="#Listspace.__contextMenuCloseAll">__contextMenuCloseAll</a></td> +<td>Private method to close all tabs.</td> +</tr><tr> +<td><a href="#Listspace.__contextMenuPrintFile">__contextMenuPrintFile</a></td> +<td>Private method to print the selected tab.</td> +</tr><tr> +<td><a href="#Listspace.__contextMenuSave">__contextMenuSave</a></td> +<td>Private method to save the selected tab.</td> +</tr><tr> +<td><a href="#Listspace.__contextMenuSaveAll">__contextMenuSaveAll</a></td> +<td>Private method to save all tabs.</td> +</tr><tr> +<td><a href="#Listspace.__contextMenuSaveAs">__contextMenuSaveAs</a></td> +<td>Private method to save the selected tab to a new file.</td> +</tr><tr> +<td><a href="#Listspace.__contextMenuSaveToProject">__contextMenuSaveToProject</a></td> +<td>Private method to save the selected tab to the current project.</td> +</tr><tr> +<td><a href="#Listspace.__currentChanged">__currentChanged</a></td> +<td>Private slot to handle the currentChanged signal.</td> +</tr><tr> +<td><a href="#Listspace.__initMenu">__initMenu</a></td> +<td>Private method to initialize the viewlist context menu.</td> +</tr><tr> +<td><a href="#Listspace.__showMenu">__showMenu</a></td> +<td>Private slot to handle the customContextMenuRequested signal of the viewlist.</td> +</tr><tr> +<td><a href="#Listspace.__showSelectedView">__showSelectedView</a></td> +<td>Private slot called to show a view selected in the list by a mouse click.</td> +</tr><tr> +<td><a href="#Listspace._addView">_addView</a></td> +<td>Protected method to add a view (i.e.</td> +</tr><tr> +<td><a href="#Listspace._initWindowActions">_initWindowActions</a></td> +<td>Protected method to define the user interface actions for window handling.</td> +</tr><tr> +<td><a href="#Listspace._modificationStatusChanged">_modificationStatusChanged</a></td> +<td>Protected slot to handle the modificationStatusChanged signal.</td> +</tr><tr> +<td><a href="#Listspace._removeAllViews">_removeAllViews</a></td> +<td>Protected method to remove all views (i.e.</td> +</tr><tr> +<td><a href="#Listspace._removeView">_removeView</a></td> +<td>Protected method to remove a view (i.e.</td> +</tr><tr> +<td><a href="#Listspace._showView">_showView</a></td> +<td>Protected method to show a view (i.e.</td> +</tr><tr> +<td><a href="#Listspace._syntaxErrorToggled">_syntaxErrorToggled</a></td> +<td>Protected slot to handle the syntaxerrorToggled signal.</td> +</tr><tr> +<td><a href="#Listspace.activeWindow">activeWindow</a></td> +<td>Public method to return the active (i.e.</td> +</tr><tr> +<td><a href="#Listspace.addSplit">addSplit</a></td> +<td>Public method used to split the current view.</td> +</tr><tr> +<td><a href="#Listspace.canCascade">canCascade</a></td> +<td>Public method to signal if cascading of managed windows is available.</td> +</tr><tr> +<td><a href="#Listspace.canSplit">canSplit</a></td> +<td>public method to signal if splitting of the view is available.</td> +</tr><tr> +<td><a href="#Listspace.canTile">canTile</a></td> +<td>Public method to signal if tiling of managed windows is available.</td> +</tr><tr> +<td><a href="#Listspace.cascade">cascade</a></td> +<td>Public method to cascade the managed windows.</td> +</tr><tr> +<td><a href="#Listspace.eventFilter">eventFilter</a></td> +<td>Method called to filter the event queue.</td> +</tr><tr> +<td><a href="#Listspace.nextSplit">nextSplit</a></td> +<td>Public slot used to move to the next split.</td> +</tr><tr> +<td><a href="#Listspace.prevSplit">prevSplit</a></td> +<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> +</tr><tr> +<td><a href="#Listspace.setEditorName">setEditorName</a></td> +<td>Change the displayed name of the editor.</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.tile">tile</a></td> +<td>Public method to tile the managed windows.</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></dt> +<dd> +parent widget (QWidget) +</dd><dt><i>ui</i></dt> +<dd> +reference to the main user interface +</dd><dt><i>dbs</i></dt> +<dd> +reference to the debug server object +</dd> +</dl><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></dt> +<dd> +Caption for the editor (string) +</dd><dt><i>editor</i></dt> +<dd> +Editor to update the caption for +</dd> +</dl><a NAME="Listspace.__contextMenuClose" ID="Listspace.__contextMenuClose"></a> +<h4>Listspace.__contextMenuClose</h4> +<b>__contextMenuClose</b>(<i></i>) +<p> + Private method to close the selected tab. +</p><a NAME="Listspace.__contextMenuCloseAll" ID="Listspace.__contextMenuCloseAll"></a> +<h4>Listspace.__contextMenuCloseAll</h4> +<b>__contextMenuCloseAll</b>(<i></i>) +<p> + Private method to close all tabs. +</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 tab. +</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 tab. +</p><a NAME="Listspace.__contextMenuSaveAll" ID="Listspace.__contextMenuSaveAll"></a> +<h4>Listspace.__contextMenuSaveAll</h4> +<b>__contextMenuSaveAll</b>(<i></i>) +<p> + Private method to save all tabs. +</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 tab to a new file. +</p><a NAME="Listspace.__contextMenuSaveToProject" ID="Listspace.__contextMenuSaveToProject"></a> +<h4>Listspace.__contextMenuSaveToProject</h4> +<b>__contextMenuSaveToProject</b>(<i></i>) +<p> + Private method to save the selected tab to the current project. +</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></dt> +<dd> +index of the current editor +</dd> +</dl><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.__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><a NAME="Listspace.__showSelectedView" ID="Listspace.__showSelectedView"></a> +<h4>Listspace.__showSelectedView</h4> +<b>__showSelectedView</b>(<i>itm</i>) +<p> + Private slot called to show a view selected in the list by a mouse click. +</p><dl> +<dt><i>itm</i></dt> +<dd> +item clicked on (QListWidgetItem) +</dd> +</dl><a NAME="Listspace._addView" ID="Listspace._addView"></a> +<h4>Listspace._addView</h4> +<b>_addView</b>(<i>win, fn = None, noName = ""</i>) +<p> + Protected method to add a view (i.e. window) +</p><dl> +<dt><i>win</i></dt> +<dd> +editor window to be added +</dd><dt><i>fn</i></dt> +<dd> +filename of this editor (string) +</dd><dt><i>noName</i></dt> +<dd> +name to be used for an unnamed editor (string) +</dd> +</dl><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>m, editor</i>) +<p> + Protected slot to handle the modificationStatusChanged signal. +</p><dl> +<dt><i>m</i></dt> +<dd> +flag indicating the modification status (boolean) +</dd><dt><i>editor</i></dt> +<dd> +editor window changed +</dd> +</dl><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></dt> +<dd> +editor window to be removed +</dd> +</dl><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></dt> +<dd> +editor window to be shown +</dd><dt><i>fn</i></dt> +<dd> +filename of this editor (string) +</dd> +</dl><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></dt> +<dd> +editor that sent the signal +</dd> +</dl><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>Returns:</dt> +<dd> +reference to the active editor +</dd> +</dl><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>Returns:</dt> +<dd> +flag indicating cascading of windows is available +</dd> +</dl><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>Returns:</dt> +<dd> +flag indicating splitting of the view is available. +</dd> +</dl><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>Returns:</dt> +<dd> +flag indicating tiling of windows is available +</dd> +</dl><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> + Method called to filter the event queue. +</p><dl> +<dt><i>watched</i></dt> +<dd> +the QObject being watched +</dd><dt><i>event</i></dt> +<dd> +the event that occurred +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating, if we handled the event +</dd> +</dl><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></i>) +<p> + Public method used to remove the current split view. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating successfull removal +</dd> +</dl><a NAME="Listspace.setEditorName" ID="Listspace.setEditorName"></a> +<h4>Listspace.setEditorName</h4> +<b>setEditorName</b>(<i>editor, newName</i>) +<p> + Change the displayed name of the editor. +</p><dl> +<dt><i>editor</i></dt> +<dd> +editor window to be changed +</dd><dt><i>newName</i></dt> +<dd> +new name to be shown (string) +</dd> +</dl><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></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> +<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></dt> +<dd> +reference to the window menu +</dd> +</dl><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>Methods</h3> +<table> +<tr> +<td><a href="#StackedWidget.__init__">StackedWidget</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#StackedWidget.addWidget">addWidget</a></td> +<td>Overwritten method to add a new widget.</td> +</tr><tr> +<td><a href="#StackedWidget.firstEditor">firstEditor</a></td> +<td>Public method to retrieve the first editor in the list of managed editors.</td> +</tr><tr> +<td><a href="#StackedWidget.hasEditor">hasEditor</a></td> +<td>Public method to check for an editor.</td> +</tr><tr> +<td><a href="#StackedWidget.nextTab">nextTab</a></td> +<td>Public slot used to show the next tab.</td> +</tr><tr> +<td><a href="#StackedWidget.prevTab">prevTab</a></td> +<td>Public slot used to show the previous tab.</td> +</tr><tr> +<td><a href="#StackedWidget.removeWidget">removeWidget</a></td> +<td>Overwritten method to remove a widget.</td> +</tr><tr> +<td><a href="#StackedWidget.setCurrentIndex">setCurrentIndex</a></td> +<td>Overwritten method to set the current widget by it's index.</td> +</tr><tr> +<td><a href="#StackedWidget.setCurrentWidget">setCurrentWidget</a></td> +<td>Overwritten method to set the current widget.</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></dt> +<dd> +parent widget (QWidget) +</dd> +</dl><a NAME="StackedWidget.addWidget" ID="StackedWidget.addWidget"></a> +<h4>StackedWidget.addWidget</h4> +<b>addWidget</b>(<i>editor</i>) +<p> + Overwritten method to add a new widget. +</p><dl> +<dt><i>editor</i></dt> +<dd> +the editor object to be added (QScintilla.Editor.Editor) +</dd> +</dl><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>Returns:</dt> +<dd> +first editor in list (QScintilla.Editor.Editor) +</dd> +</dl><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></dt> +<dd> +editor object to check for +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating, whether the editor to be checked belongs + to the list of editors managed by this stacked widget. +</dd> +</dl><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> + Overwritten method to remove a widget. +</p><dl> +<dt><i>widget</i></dt> +<dd> +widget to be removed (QWidget) +</dd> +</dl><a NAME="StackedWidget.setCurrentIndex" ID="StackedWidget.setCurrentIndex"></a> +<h4>StackedWidget.setCurrentIndex</h4> +<b>setCurrentIndex</b>(<i>index</i>) +<p> + Overwritten method to set the current widget by it's index. +</p><dl> +<dt><i>index</i></dt> +<dd> +index of widget to be made current (integer) +</dd> +</dl><a NAME="StackedWidget.setCurrentWidget" ID="StackedWidget.setCurrentWidget"></a> +<h4>StackedWidget.setCurrentWidget</h4> +<b>setCurrentWidget</b>(<i>widget</i>) +<p> + Overwritten method to set the current widget. +</p><dl> +<dt><i>widget</i></dt> +<dd> +widget to be made current (QWidget) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file