eric: comparison ViewManager/ViewManager.py

-:84b65fb9e780
+:d133c7edd88a
 def canCascade(self):
 """
 Public method to signal if cascading of managed windows is available.
-@return flag indicating cascading of windows is available
+@ireturn flag indicating cascading of windows is available
 @exception RuntimeError Not implemented
 """
 raise RuntimeError('Not implemented')
 def canTile(self):
 """
 Public method to signal if tiling of managed windows is available.
-@return flag indicating tiling of windows is available
+@ireturn flag indicating tiling of windows is available
 @exception RuntimeError Not implemented
 """
 raise RuntimeError('Not implemented')
 def tile(self):
 def activeWindow(self):
 """
 Public method to return the active (i.e. current) window.
-@return reference to the active editor
+@ireturn reference to the active editor
 @exception RuntimeError Not implemented
 """
 raise RuntimeError('Not implemented')
 def _removeAllViews(self):
 """
-Protected method to remove all views (i.e. windows)
+Protected method to remove all views (i.e. windows).
 @exception RuntimeError Not implemented
 """
 raise RuntimeError('Not implemented')
 def _removeView(self, win):
 """
-Protected method to remove a view (i.e. window)
+Protected method to remove a view (i.e. window).
 @param win editor window to be removed
 @exception RuntimeError Not implemented
 """
 raise RuntimeError('Not implemented')
 def _addView(self, win, fn=None, noName=""):
 """
-Protected method to add a view (i.e. window)
+Protected method to add a view (i.e. window).
 @param win editor assembly to be added
 @param fn filename of this editor
 @param noName name to be used for an unnamed editor (string)
 @exception RuntimeError Not implemented
 """
 raise RuntimeError('Not implemented')
 def _showView(self, win, fn=None):
 """
-Protected method to show a view (i.e. window)
+Protected method to show a view (i.e. window).
 @param win editor assembly to be shown
 @param fn filename of this editor
 @exception RuntimeError Not implemented
 """
 return tb
 def __initContextMenuExporters(self):
 """
 Private method used to setup the Exporters sub menu.
+@return reference to the generated menu (QMenu)
 """
 menu = QMenu(QApplication.translate('ViewManager', "Export as"))
 import QScintilla.Exporters
 supportedExporters = QScintilla.Exporters.getSupportedFormats()
 self.editUpperCaseAct.triggered[()].connect(self.esm.map)
 self.editActions.append(self.editUpperCaseAct)
 def initEditMenu(self):
 """
-Public method to create the Edit menu
+Public method to create the Edit menu.
 @return the generated menu
 """
 autocompletionMenu = \
 QMenu(QApplication.translate('ViewManager', '&Autocomplete'), self.ui)
 return menu
 def initEditToolbar(self, toolbarManager):
 """
-Public method to create the Edit toolbar
+Public method to create the Edit toolbar.
 @param toolbarManager reference to a toolbar manager object (E5ToolBarManager)
 @return the generated toolbar
 """
 tb = QToolBar(QApplication.translate('ViewManager', 'Edit'), self.ui)
 self.replaceOpenFilesAct.triggered[()].connect(self.__replaceOpenFiles)
 self.searchActions.append(self.replaceOpenFilesAct)
 def initSearchToolbars(self, toolbarManager):
 """
-Public method to create the Search toolbars
+Public method to create the Search toolbars.
 @param toolbarManager reference to a toolbar manager object (E5ToolBarManager)
 @return a tuple of the generated toolbar (search, quicksearch)
 """
 qtb = QToolBar(QApplication.translate('ViewManager', 'Quicksearch'), self.ui)
 self.prevSplitAct.setEnabled(False)
 self.previewAct.setEnabled(True)
 def initViewMenu(self):
 """
-Public method to create the View menu
+Public method to create the View menu.
 @return the generated menu
 """
 menu = QMenu(QApplication.translate('ViewManager', '&View'), self.ui)
 menu.setTearOffEnabled(True)
 return menu
 def initViewToolbar(self, toolbarManager):
 """
-Public method to create the View toolbar
+Public method to create the View toolbar.
 @param toolbarManager reference to a toolbar manager object (E5ToolBarManager)
 @return the generated toolbar
 """
 tb = QToolBar(QApplication.translate('ViewManager', 'View'), self.ui)
 self.macroActGrp.setEnabled(False)
 def initMacroMenu(self):
 """
-Public method to create the Macro menu
+Public method to create the Macro menu.
 @return the generated menu
 """
 menu = QMenu(QApplication.translate('ViewManager', "&Macros"), self.ui)
 menu.setTearOffEnabled(True)
 self.bookmarkActGrp.setEnabled(False)
 def initBookmarkMenu(self):
 """
-Public method to create the Bookmark menu
+Public method to create the Bookmark menu.
 @return the generated menu
 """
 menu = QMenu(QApplication.translate('ViewManager', '&Bookmarks'), self.ui)
 self.bookmarksMenu = QMenu(QApplication.translate('ViewManager', '&Bookmarks'),
 return menu
 def initBookmarkToolbar(self, toolbarManager):
 """
-Public method to create the Bookmark toolbar
+Public method to create the Bookmark toolbar.
 @param toolbarManager reference to a toolbar manager object (E5ToolBarManager)
 @return the generated toolbar
 """
 tb = QToolBar(QApplication.translate('ViewManager', 'Bookmarks'), self.ui)
 self.autoSpellCheckAct.setEnabled(spellingAvailable)
 def addToExtrasMenu(self, menu):
 """
 Public method to add some actions to the extras menu.
+@param menu reference to the menu to add actions to (QMenu)
 """
 self.__editSpellingMenu = QMenu(QApplication.translate('ViewManager',
 "Edit Dictionary"))
 self.__editProjectPwlAct = self.__editSpellingMenu.addAction(
 QApplication.translate('ViewManager', "Project Word List"),
 menu.addMenu(self.__editSpellingMenu)
 menu.addSeparator()
 def initSpellingToolbar(self, toolbarManager):
 """
-Public method to create the Spelling toolbar
+Public method to create the Spelling toolbar.
 @param toolbarManager reference to a toolbar manager object (E5ToolBarManager)
 @return the generated toolbar
 """
 tb = QToolBar(QApplication.translate('ViewManager', 'Spelling'), self.ui)
 @param fn name of file to be opened (string)
 @param lineno line number to place the cursor at (integer)
 @param filetype type of the source file (string)
 @param selStart start of an area to be selected (integer)
 @param selEnd end of an area to be selected (integer)
+@param pos position within the line to place the cursor at (integer)
 """
 try:
 newWin, editor = self.getEditor(fn, filetype=filetype)
 except (IOError, UnicodeDecodeError):
 return
 """
 self.activeWindow().unindentLineOrSelection()
 def __editSmartIndent(self):
 """
-Private method to handle the smart indent action
+Private method to handle the smart indent action.
 """
 self.activeWindow().smartIndentLineOrSelection()
 def __editToggleComment(self):
 """
 self.activeWindow().autoCompleteFromAll()
 def __editorAutoCompletionAPIsAvailable(self, available):
 """
 Private method to handle the availability of API autocompletion signal.
+@param available flag indicating the availability of API
+autocompletion (boolean)
 """
 self.autoCompleteFromAPIsAct.setEnabled(available)
 def __editShowCallTips(self):
 """
 ## Below are the action and utility methods for the search menu
 ##################################################################
 def textForFind(self, getCurrentWord=True):
 """
-Public method to determine the selection or the current word for the next
+Public method to determine the selection or the current word for the
-find operation.
+next find operation.
-@param getCurrentWord flag indicating to return the current word, if no selected
+@param getCurrentWord flag indicating to return the current word, if
-text was found (boolean)
+no selected text was found (boolean)
 @return selection or current word (string)
 """
 aw = self.activeWindow()
 if aw is None:
 return ""
 self.quickFindtextCombo.lastActive = self.activeWindow()
 def __quickSearchEnter(self):
 """
 Private slot to handle the incremental quick search return pressed
-(jump back to text)
+(jump back to text).
 """
 if self.quickFindtextCombo.lastActive:
 self.quickFindtextCombo.lastActive.setFocus()
 if self.__quickSearchToolbarVisibility is not None:
 self.__quickSearchToolbar.setVisible(self.__quickSearchToolbarVisibility)
 self.__quickSearchToolbarVisibility = None
 def __quickSearchEscape(self):
 """
 Private slot to handle the incremental quick search escape pressed
-(jump back to text)
+(jump back to text).
 """
 if self.quickFindtextCombo.lastActive:
 self.quickFindtextCombo.lastActive.setFocus()
 aw = self.activeWindow()
 if aw and self.quickFindtextCombo.lastCursorPos:
 self.addSplit()
 def __splitOrientation(self, checked):
 """
 Private method to handle the split orientation action.
+@param checked flag indicating the checked state of the action
+(boolean). True means splitting horizontally.
 """
 if checked:
 self.setSplitOrientation(Qt.Horizontal)
 self.splitViewAct.setIcon(
 UI.PixmapCache.getIcon("splitHorizontal.png"))
 self.__editSpellingDictionary(pel)
 def __editSpellingDictionary(self, dictionaryFile):
 """
 Private slot to edit the given spelling dictionary.
+@param dictionaryFile file name of the dictionary to edit (string)
 """
 if os.path.exists(dictionaryFile):
 try:
 f = open(dictionaryFile, "r", encoding="utf-8")
 data = f.read()
 ##################################################################
 def getAPIsManager(self):
 """
 Public method to get a reference to the APIs manager.
 @return the APIs manager object (eric5.QScintilla.APIsManager)
 """
 return self.apisManager
 #######################################################################

Mercurial Repositories > eric / file comparison

comparison: ViewManager/ViewManager.py

ViewManager/ViewManager.py