eric: comparison ViewManager/ViewManager.py

-:e9bda9b4260b
+:bf18415da0c7
 from __future__ import unicode_literals
 import os
-from PyQt5.QtCore import pyqtSignal, QSignalMapper, QTimer, \
+from PyQt5.QtCore import pyqtSignal, pyqtSlot, QSignalMapper, QTimer, \
 QFileInfo, QRegExp, Qt, QCoreApplication
 from PyQt5.QtGui import QColor, QKeySequence, QPalette, QPixmap
 from PyQt5.QtWidgets import QLineEdit, QToolBar, QWidgetAction, QDialog, \
 QApplication, QMenu, QComboBox, QWidget
 from PyQt5.Qsci import QsciScintilla
 @param win editor window to be removed
 @exception RuntimeError Not implemented
 """
 raise RuntimeError('Not implemented')
-def _addView(self, win, fn=None, noName="", addNext=False):
+def _addView(self, win, fn=None, noName="", addNext=False, indexes=None):
 """
 Protected method to add a view (i.e. window).
 @param win editor assembly to be added
+@type EditorAssembly
 @param fn filename of this editor
-@param noName name to be used for an unnamed editor (string)
+@type str
+@param noName name to be used for an unnamed editor
+@type str
 @param addNext flag indicating to add the view next to the current
-view (bool)
+view
+@type bool
+@param indexes of the editor, first the split view index, second the
+index within the view
+@type tuple of two int
 @exception RuntimeError Not implemented
 """
 raise RuntimeError('Not implemented')
 def _showView(self, win, fn=None):
 """
 Public method used to split the current view.
 """
 pass
-def removeSplit(self):
+@pyqtSlot()
-"""
+def removeSplit(self, index=-1):
-Public method used to remove the current split view.
+"""
+Public method used to remove the current split view or a split view
-@return Flag indicating successful deletion
+by index.
+@param index index of the split to be removed (-1 means to
+delete the current split)
+@type int
+@return flag indicating successful deletion
+@rtype bool
 """
 return False
+def splitCount(self):
+"""
+Public method to get the number of split views.
+@return number of split views
+@rtype int
+"""
+return 0
+def setSplitCount(self, count):
+"""
+Public method to set the number of split views.
+@param count number of split views
+@type int
+"""
+pass
 def getSplitOrientation(self):
 """
 Public method to get the orientation of the split view.
 editor.refreshCoverageAnnotations()
 self.__setSbFile()
 def openSourceFile(self, fn, lineno=-1, filetype="",
-selStart=0, selEnd=0, pos=0, addNext=False):
+selStart=0, selEnd=0, pos=0, addNext=False,
+indexes=None):
 """
 Public slot to display a file in an editor.
-@param fn name of file to be opened (string)
+@param fn name of file to be opened
-@param lineno line number to place the cursor at (integer) or
+@type str
-list of line numbers (list of integers) (cursor will be
+@param lineno line number to place the cursor at or list of line
-placed at the next line greater than the current one)
+numbers (cursor will be placed at the next line greater than
-@param filetype type of the source file (string)
+the current one)
-@param selStart start of an area to be selected (integer)
+@type int or list of int
-@param selEnd end of an area to be selected (integer)
+@param filetype type of the source file
-@param pos position within the line to place the cursor at (integer)
+@type str
+@param selStart start of an area to be selected
+@type int
+@param selEnd end of an area to be selected
+@type int
+@param pos position within the line to place the cursor at
+@type int
 @param addNext flag indicating to add the file next to the current
-editor (bool)
+editor
+@type bool
+@param indexes of the editor, first the split view index, second the
+index within the view
+@type tuple of two int
+@return reference to the opened editor
+@rtype Editor
 """
 try:
 newWin, editor = self.getEditor(fn, filetype=filetype,
-addNext=addNext)
+addNext=addNext, indexes=indexes)
 except (IOError, UnicodeDecodeError):
 return
 if newWin:
 self._modificationStatusChanged(editor.isModified(), editor)
 if selStart != selEnd:
 editor.setSelection(line - 1, selStart, line - 1, selEnd)
 # insert filename into list of recently opened files
 self.addToRecentList(fn)
+return editor
 def __connectEditor(self, editor):
 """
 Private method to establish all editor connections.
 editor.languageChanged.connect(
 lambda: self.editorLanguageChanged.emit(editor))
 editor.textChanged.connect(lambda: self.editorTextChanged.emit(editor))
-def newEditorView(self, fn, caller, filetype=""):
+def newEditorView(self, fn, caller, filetype="", indexes=None):
 """
 Public method to create a new editor displaying the given document.
 @param fn filename of this view
+@type str
 @param caller reference to the editor calling this method
-@param filetype type of the source file (string)
+@type Editor
+@param filetype type of the source file
+@type str
+@param indexes of the editor, first the split view index, second the
+index within the view
+@type tuple of two int
+@return reference to the new editor object
+@rtype Editor
 """
 editor, assembly = self.cloneEditor(caller, filetype, fn)
-self._addView(assembly, fn, caller.getNoName())
+self._addView(assembly, fn, caller.getNoName(), indexes=indexes)
 self._modificationStatusChanged(editor.isModified(), editor)
 self._checkActions(editor)
+return editor
 def cloneEditor(self, caller, filetype, fn):
 """
 Public method to clone an editor displaying the given document.
 # only return names of existing files
 filenames.append(fn)
 return filenames
-def getEditor(self, fn, filetype="", addNext=False):
+def getEditor(self, fn, filetype="", addNext=False, indexes=None):
 """
 Public method to return the editor displaying the given file.
 If there is no editor with the given file, a new editor window is
 created.
 @param fn filename to look for
-@param filetype type of the source file (string)
+@type str
+@param filetype type of the source file
+@type str
 @param addNext flag indicating that if a new editor needs to be
-created, it should be added next to the current editor (bool)
+created, it should be added next to the current editor
+@type bool
+@param indexes of the editor, first the split view index, second the
+index within the view
+@type tuple of two int
 @return tuple of two values giving a flag indicating a new window
 creation and a reference to the editor displaying this file
+@rtype tuple of (bool, Editor)
 """
 newWin = False
 editor = self.activeWindow()
 if editor is None or not Utilities.samepath(fn, editor.getFileName()):
 for editor in self.editors:
 self.editorOpened.emit(fn)
 self.editorOpenedEd.emit(editor)
 newWin = True
 if newWin:
-self._addView(assembly, fn, addNext=addNext)
+self._addView(assembly, fn, addNext=addNext, indexes=indexes)
 else:
 self._showView(editor.parent(), fn)
 return (newWin, editor)
 count = 0
 for editor in self.editors:
 if Utilities.samepath(fn, editor.getFileName()):
 count += 1
 return count
+def getOpenEditorsForSession(self):
+"""
+Public method to get a lists of all open editors.
+The returned list contains one list per split view. If the view manager
+cannot split the view, only one list of editors is returned.
+Note: This method should be implemented by subclasses.
+@return list of list of editor references
+@rtype list of list of Editor
+"""
+return [self.editors]
 def getActiveName(self):
 """
 Public method to retrieve the filename of the active window.

Mercurial Repositories > eric / file comparison

comparison: ViewManager/ViewManager.py

ViewManager/ViewManager.py