eric6.ViewManager.ViewManager

Module implementing the viewmanager base class.

Global Attributes

None

Classes

QuickSearchLineEdit Class implementing a line edit that reacts to newline and cancel commands.
ViewManager Base class inherited by all specific viewmanager classes.

Functions

None


QuickSearchLineEdit

Class implementing a line edit that reacts to newline and cancel commands.

Signals

escPressed()
emitted after the cancel command was activated
gotFocus()
emitted when the focus is changed to this widget

Derived from

QLineEdit

Class Attributes

None

Class Methods

None

Methods

editorCommand Public method to perform an editor command.
focusInEvent Protected method to record the current editor widget.
keyPressEvent Protected method to handle the press of the ESC key.

Static Methods

None

QuickSearchLineEdit.editorCommand

editorCommand(cmd)

Public method to perform an editor command.

cmd
the scintilla command to be performed

QuickSearchLineEdit.focusInEvent

focusInEvent(evt)

Protected method to record the current editor widget.

evt
focus event (QFocusEvent)

QuickSearchLineEdit.keyPressEvent

keyPressEvent(evt)

Protected method to handle the press of the ESC key.

evt
key event (QKeyPressEvent)
Up


ViewManager

Base class inherited by all specific viewmanager classes.

It defines the interface to be implemented by specific viewmanager classes and all common methods.

Signals

astViewerStateChanged(bool)
emitted to signal a change in the AST viewer state
bookmarkToggled(Editor)
emitted when a bookmark is toggled
breakpointToggled(Editor)
emitted when a breakpoint is toggled
changeCaption(str)
emitted if a change of the caption is necessary
checkActions(Editor)
emitted when some actions should be checked for their status
cursorChanged(Editor)
emitted after the cursor position of the active window has changed
editorChanged(str)
emitted when the current editor has changed
editorChangedEd(Editor)
emitted when the current editor has changed
editorClosed(str)
emitted just before an editor window gets closed
editorClosedEd(Editor)
emitted just before an editor window gets closed
editorDoubleClickedEd(Editor, position, buttons)
emitted to signal a mouse double click in an editor
editorLanguageChanged(Editor)
emitted to signal a change of an editor's language
editorLineChanged(str,int)
emitted to signal a change of an editor's current line (line is given one based)
editorOpened(str)
emitted after an editor window was opened
editorOpenedEd(Editor)
emitted after an editor window was opened
editorRenamed(str)
emitted after an editor was renamed
editorRenamedEd(Editor)
emitted after an editor was renamed
editorSaved(str)
emitted after an editor window was saved
editorSavedEd(Editor)
emitted after an editor window was saved
editorTextChanged(Editor)
emitted to signal a change of an editor's text
lastEditorClosed()
emitted after the last editor window was closed
previewStateChanged(bool)
emitted to signal a change in the preview state
syntaxerrorToggled(Editor)
emitted when a syntax error is toggled

Derived from

QWidget

Class Attributes

None

Class Methods

None

Methods

ViewManager Constructor
__addBookmarked Private method to add the current file to the list of bookmarked files.
__astViewer Private slot to handle a change of the AST Viewer selection state.
__autosave Private slot to save the contents of all editors automatically.
__bookmarkSelected Private method to handle the bookmark selected signal.
__bookmarkToggled Private slot to handle the bookmarkToggled signal.
__breakpointToggled Private slot to handle the breakpointToggled signal.
__changeMarkersUpdated Private slot to handle the changeMarkersUpdated signal.
__clearAllBookmarks Private method to handle the clear all bookmarks action.
__clearAllFolds Private method to handle the clear all folds action.
__clearAllSyntaxErrors Private method to handle the clear all syntax errors action.
__clearAllWarnings Private method to handle the clear all warnings action.
__clearBookmarked Private method to clear the bookmarked files menu.
__connectEditor Private method to establish all editor connections.
__convertEOL Private method to handle the convert line end characters action.
__coverageMarkersShown Private slot to handle the coverageMarkersShown signal.
__cursorChanged Private slot to handle the cursorChanged signal.
__editAutoComplete Private method to handle the autocomplete action.
__editAutoCompleteFromAPIs Private method to handle the autocomplete from APIs action.
__editAutoCompleteFromAll Private method to handle the autocomplete from All action.
__editAutoCompleteFromDoc Private method to handle the autocomplete from document action.
__editBookmarked Private method to edit the list of bookmarked files.
__editBoxComment Private method to handle the box comment action.
__editComment Private method to handle the comment action.
__editCopy Private method to handle the copy action.
__editCut Private method to handle the cut action.
__editDelete Private method to handle the delete action.
__editDeselectAll Private method to handle the select all action.
__editIndent Private method to handle the indent action.
__editJoin Private method to handle the join action.
__editPaste Private method to handle the paste action.
__editProjectPEL Private slot to edit the project exception list.
__editProjectPWL Private slot to edit the project word list.
__editRedo Private method to handle the redo action.
__editRevert Private method to handle the revert action.
__editSelectAll Private method to handle the select all action.
__editSelectBrace Private method to handle the select to brace action.
__editShowCallTips Private method to handle the calltips action.
__editShowCodeInfo Private method to handle the code info action.
__editSmartIndent Private method to handle the smart indent action.
__editSortSelectedLines Private slot to sort the selected lines.
__editSpellingDictionary Private slot to edit the given spelling dictionary.
__editStreamComment Private method to handle the stream comment action.
__editToggleComment Private method to handle the toggle comment action.
__editUncomment Private method to handle the uncomment action.
__editUndo Private method to handle the undo action.
__editUnindent Private method to handle the unindent action.
__editUserPEL Private slot to edit the user exception list.
__editUserPWL Private slot to edit the user word list.
__editorAutoCompletionAPIsAvailable Private method to handle the availability of API autocompletion signal.
__editorCommand Private method to send an editor command to the active window.
__editorConfigChanged Private slot to handle changes of an editor's configuration.
__editorDoubleClicked Private slot handling mouse double clicks of an editor.
__editorOpened Private slot to handle the editorOpened signal.
__editorRenamed Private slot to handle the editorRenamed signal.
__editorSaved Private slot to handle the editorSaved signal.
__editorSelectionChanged Private slot to handle changes of the current editors selection.
__enableSpellingActions Private method to set the enabled state of the spelling actions.
__eolPixmap Private method to get an EOL pixmap for an EOL string.
__exportMenuTriggered Private method to handle the selection of an export format.
__findFileName Private method to handle the search for file action.
__findNextWord Private slot to find the next occurrence of the current word of the current editor.
__findPrevWord Private slot to find the previous occurrence of the current word of the current editor.
__goto Private method to handle the goto action.
__gotoBrace Private method to handle the goto brace action.
__gotoLastEditPosition Private method to move the cursor to the last edit position.
__gotoNextMethodClass Private slot to go to the next Python/Ruby method or class definition.
__gotoPreviousMethodClass Private slot to go to the previous Python/Ruby method or class definition.
__gotoSyntaxError Private method to handle the goto syntax error action.
__initBookmarkActions Private method defining the user interface actions for the bookmarks commands.
__initContextMenuExporters Private method used to setup the Exporters sub menu.
__initEditActions Private method defining the user interface actions for the edit commands.
__initFileActions Private method defining the user interface actions for file handling.
__initMacroActions Private method defining the user interface actions for the macro commands.
__initSearchActions Private method defining the user interface actions for the search commands.
__initSpellingActions Private method to initialize the spell checking actions.
__initViewActions Private method defining the user interface actions for the view commands.
__isEditorInfoSupportedEd Private method to check, if an editor is supported by the documentation viewer.
__lastEditPositionAvailable Private slot to handle the lastEditPositionAvailable signal of an editor.
__lastEditorClosed Private slot to handle the lastEditorClosed signal.
__loadRecent Private method to load the recently opened filenames.
__macroDelete Private method to handle the delete macro action.
__macroLoad Private method to handle the load macro action.
__macroRun Private method to handle the run macro action.
__macroSave Private method to handle the save macro action.
__macroStartRecording Private method to handle the start macro recording action.
__macroStopRecording Private method to handle the stop macro recording action.
__newDocumentSplitView Private method to open a new view of the current editor in a new split.
__newDocumentView Private method to open a new view of the current editor.
__newLineBelow Private method to insert a new line below the current one even if cursor is not at the end of the line.
__nextBookmark Private method to handle the next bookmark action.
__nextChange Private method to handle the next change action.
__nextTask Private method to handle the next task action.
__nextUncovered Private method to handle the next uncovered action.
__nextWarning Private method to handle the next warning action.
__openFiles Private slot to open some files.
__openSourceFile Private method to open a file from the list of recently opened files.
__previewEditor Private slot to handle a change of the preview selection state.
__previousBookmark Private method to handle the previous bookmark action.
__previousChange Private method to handle the previous change action.
__previousTask Private method to handle the previous task action.
__previousUncovered Private method to handle the previous uncovered action.
__previousWarning Private method to handle the previous warning action.
__quickSearch Private slot to handle the incremental quick search.
__quickSearchEnter Private slot to handle the incremental quick search return pressed (jump back to text).
__quickSearchEscape Private slot to handle the incremental quick search escape pressed (jump back to text).
__quickSearchExtend Private method to handle the quicksearch extend action.
__quickSearchFocusIn Private method to handle a focus in signal of the quicksearch lineedit.
__quickSearchInEditor Private slot to perform a quick search.
__quickSearchMarkOccurrences Private method to mark all occurrences of the search text.
__quickSearchPrev Private slot to handle the quickFindPrev toolbutton action.
__quickSearchSetEditColors Private method to set the quick search edit colors.
__quickSearchText Private slot to handle the textChanged signal of the quicksearch edit.
__replaceFiles Private method to handle the replace in files action.
__replaceOpenFiles Private method to handle the replace in open files action.
__saveRecent Private method to save the list of recently opened filenames.
__searchClearMarkers Private method to clear the search markers of the active window.
__searchFiles Private method to handle the search in files action.
__searchNext Private slot to handle the search next action.
__searchOpenFiles Private method to handle the search in open files action.
__searchPrev Private slot to handle the search previous action.
__setAutoSpellChecking Private slot to set the automatic spell checking of all editors.
__setSbFile Private method to set the file info in the status bar.
__shortenEmptyLines Private method to handle the shorten empty lines action.
__showBookmarkMenu Private method to set up the bookmark menu.
__showBookmarkedMenu Private method to set up bookmarked files menu.
__showBookmarksMenu Private method to handle the show bookmarks menu signal.
__showEditSpellingMenu Private method to set up the edit dictionaries menu.
__showEncodingsMenu Private slot to show the Encodings menu of the current editor.
__showEolMenu Private slot to show the EOL menu of the current editor.
__showFileMenu Private method to set up the file menu.
__showLanguagesMenu Private slot to show the Languages menu of the current editor.
__showRecentMenu Private method to set up recent files menu.
__spellCheck Private slot to perform a spell check of the current editor.
__splitOrientation Private method to handle the split orientation action.
__splitView Private method to handle the split view action.
__taskMarkersUpdated Private slot to handle the taskMarkersUpdated signal.
__toggleAll Private method to handle the toggle all folds action.
__toggleAllChildren Private method to handle the toggle all folds (including children) action.
__toggleBookmark Private method to handle the toggle bookmark action.
__toggleCurrent Private method to handle the toggle current fold action.
__unhighlight Private slot to switch of all highlights.
__zoom Private method to handle the zoom action.
__zoomIn Private method to handle the zoom in action.
__zoomOut Private method to handle the zoom out action.
__zoomReset Private method to reset the zoom factor.
__zoomTo Private slot to zoom to a given value.
_addView Protected method to add a view (i.e.
_checkActions Protected slot to check some actions for their enable/disable status and set the statusbar info.
_getOpenFileFilter Protected method to return the active filename filter for a file open dialog.
_getOpenStartDir Protected method to return the starting directory for a file open dialog.
_initWindowActions Protected method to define the user interface actions for window handling.
_modificationStatusChanged Protected slot to handle the modificationStatusChanged signal.
_removeAllViews Protected method to remove all views (i.e.
_removeView Protected method to remove a view (i.e.
_showView Protected method to show a view (i.e.
_syntaxErrorToggled Protected slot to handle the syntaxerrorToggled signal.
activeWindow Public method to return the active (i.e.
addSplit Public method used to split the current view.
addToExtrasMenu Public method to add some actions to the Extras menu.
addToRecentList Public slot to add a filename to the list of recently opened files.
appFocusChanged Public method to handle the global change of focus.
canCascade Public method to signal if cascading of managed windows is available.
canSplit Public method to signal if splitting of the view is available.
canTile Public method to signal if tiling of managed windows is available.
cancelSharedEdit Public slot to cancel a shared edit session for the current editor.
cascade Public method to cascade the managed windows.
checkAllDirty Public method to check the dirty status of all editors.
checkDirty Public method to check the dirty status and open a message window.
checkFileDirty Public method to check the dirty status of an editor given its file name and open a message window.
clearRecent Public method to clear the recent files menu.
cloneEditor Public method to clone an editor displaying the given document.
closeAllWindows Public method to close all editor windows via file menu.
closeCurrentWindow Public method to close the current window.
closeEditor Public method to close an editor window.
closeEditorWindow Public method to close an arbitrary source editor.
closeViewManager Public method to shutdown the viewmanager.
closeWindow Public method to close an arbitrary source editor.
editorsCheckFocusInEnabled Public method returning the flag indicating editors should perform focus in checks.
enableEditorsCheckFocusIn Public method to set a flag enabling the editors to perform focus in checks.
eventFilter Public method called to filter an event.
exit Public method to handle the debugged program terminating.
getAPIsManager Public method to get a reference to the APIs manager.
getActions Public method to get a list of all actions.
getActiveName Public method to retrieve the filename of the active window.
getEditor Public method to return the editor displaying the given file.
getMostRecent Public method to get the most recently opened file.
getNumber Public method to get a number from the active window.
getOpenEditor Public method to return the editor displaying the given file.
getOpenEditorCount Public method to return the count of editors displaying the given file.
getOpenEditors Public method to get references to all open editors.
getOpenEditorsCount Public method to get the number of open editors.
getOpenEditorsForSession Public method to get a lists of all open editors.
getOpenFilenames Public method returning a list of the filenames of all editors.
getSRHistory Public method to get the search or replace history list.
getSplitOrientation Public method to get the orientation of the split view.
handleResetUI Public slot to handle the resetUI signal.
initActions Public method defining the user interface actions.
initBookmarkMenu Public method to create the Bookmark menu.
initBookmarkToolbar Public method to create the Bookmark toolbar.
initEditMenu Public method to create the Edit menu.
initEditToolbar Public method to create the Edit toolbar.
initFileMenu Public method to create the File menu.
initFileToolbar Public method to create the File toolbar.
initMacroMenu Public method to create the Macro menu.
initSearchMenu Public method to create the Search menu.
initSearchToolbars Public method to create the Search toolbars.
initSpellingToolbar Public method to create the Spelling toolbar.
initViewMenu Public method to create the View menu.
initViewToolbar Public method to create the View toolbar.
insertNumber Public slot to insert a number text into the active window.
insertSymbol Public slot to insert a symbol text into the active window.
isConnected Public method to check the connection status of the IDE.
isEditorInfoSupported Public method to check, if a language is supported by the documentation viewer.
mainWidget Public method to return a reference to the main Widget of a specific view manager subclass.
newEditor Public slot to generate a new empty editor.
newEditorView Public method to create a new editor displaying the given document.
nextSplit Public slot used to move to the next split.
openFiles Public slot to open some files.
openSourceFile Public slot to display a file in an editor.
preferencesChanged Public slot to handle the preferencesChanged signal.
prevSplit Public slot used to move to the previous split.
printCurrentEditor Public slot to print the contents of the current editor.
printEditor Public slot to print an editor.
printPreviewCurrentEditor Public slot to show a print preview of the current editor.
projectClosed Public slot to handle the projectClosed signal.
projectFileRenamed Public slot to handle the projectFileRenamed signal.
projectLexerAssociationsChanged Public slot to handle changes of the project lexer associations.
projectOpened Public slot to handle the projectOpened signal.
receive Public slot to handle received editor commands.
removeSplit Public method used to remove the current split view or a split view by index.
replaceWidget Public method to get a reference to the replace widget.
saveAllEditors Public slot to save the contents of all editors.
saveAsCurrentEditor Public slot to save the contents of the current editor to a new file.
saveAsEditorEd Public slot to save the contents of an editor to a new file.
saveCopyCurrentEditor Public slot to save the contents of the current editor to a new copy of the file.
saveCopyEditorEd Public slot to save the contents of an editor to a new copy of the file.
saveCurrentEditor Public slot to save the contents of the current editor.
saveEditor Public method to save a named editor file.
saveEditorEd Public slot to save the contents of an editor.
saveEditorsList Public slot to save a list of editors.
searchWidget Public method to get a reference to the search widget.
send Public method to send an editor command to remote editors.
sendSharedEdit Public slot to end a shared edit session for the current editor and send the changes.
setCooperationClient Public method to set a reference to the cooperation client.
setEditorName Public method to change the displayed name of the editor.
setFileLine Public method to update the user interface when the current program or line changes.
setReferences Public method to set some references needed later on.
setSbInfo Public method to transfer statusbar info from the user interface to viewmanager.
setSplitCount Public method to set the number of split views.
setSplitOrientation Public method used to set the orientation of the split view.
shareConnected Public slot to handle a change of the connected state.
shareEditor Public slot to set the shared status of the current editor.
showDebugSource Public method to open the given file and highlight the given line in it.
showEditorInfo Public method to show some information for a given editor.
showReplaceWidget Public method to show the replace widget.
showSearchWidget Public method to show the search widget.
showWindowMenu Public method to set up the viewmanager part of the Window menu.
splitCount Public method to get the number of split views.
startSharedEdit Public slot to start a shared edit session for the current editor.
textForFind Public method to determine the selection or the current word for the next find operation.
tile Public method to tile the managed windows.
unhighlight Public method to switch off all highlights or the highlight of the current editor.
zoomValueChanged Public slot to handle changes of the zoom value.

Static Methods

None

ViewManager (Constructor)

ViewManager()

Constructor

ViewManager.__addBookmarked

__addBookmarked()

Private method to add the current file to the list of bookmarked files.

ViewManager.__astViewer

__astViewer(checked)

Private slot to handle a change of the AST Viewer selection state.

checked
state of the action (boolean)

ViewManager.__autosave

__autosave()

Private slot to save the contents of all editors automatically.

Only named editors will be saved by the autosave timer.

ViewManager.__bookmarkSelected

__bookmarkSelected(act)

Private method to handle the bookmark selected signal.

act
reference to the action that triggered (QAction)

ViewManager.__bookmarkToggled

__bookmarkToggled(editor)

Private slot to handle the bookmarkToggled signal.

It checks some bookmark actions and reemits the signal.

editor
editor that sent the signal

ViewManager.__breakpointToggled

__breakpointToggled(editor)

Private slot to handle the breakpointToggled signal.

It simply reemits the signal.

editor
editor that sent the signal

ViewManager.__changeMarkersUpdated

__changeMarkersUpdated(editor)

Private slot to handle the changeMarkersUpdated signal.

editor
editor that sent the signal

ViewManager.__clearAllBookmarks

__clearAllBookmarks()

Private method to handle the clear all bookmarks action.

ViewManager.__clearAllFolds

__clearAllFolds()

Private method to handle the clear all folds action.

ViewManager.__clearAllSyntaxErrors

__clearAllSyntaxErrors()

Private method to handle the clear all syntax errors action.

ViewManager.__clearAllWarnings

__clearAllWarnings()

Private method to handle the clear all warnings action.

ViewManager.__clearBookmarked

__clearBookmarked()

Private method to clear the bookmarked files menu.

ViewManager.__connectEditor

__connectEditor(editor)

Private method to establish all editor connections.

editor
reference to the editor object to be connected

ViewManager.__convertEOL

__convertEOL()

Private method to handle the convert line end characters action.

ViewManager.__coverageMarkersShown

__coverageMarkersShown(shown)

Private slot to handle the coverageMarkersShown signal.

shown
flag indicating whether the markers were shown or cleared

ViewManager.__cursorChanged

__cursorChanged(fn, line, pos, editor)

Private slot to handle the cursorChanged signal.

It emits the signal cursorChanged with parameter editor.

fn (str)
filename
line (int)
line number of the cursor
pos (int)
position in line of the cursor
editor (Editor)
reference to the editor

ViewManager.__editAutoComplete

__editAutoComplete()

Private method to handle the autocomplete action.

ViewManager.__editAutoCompleteFromAPIs

__editAutoCompleteFromAPIs()

Private method to handle the autocomplete from APIs action.

ViewManager.__editAutoCompleteFromAll

__editAutoCompleteFromAll()

Private method to handle the autocomplete from All action.

ViewManager.__editAutoCompleteFromDoc

__editAutoCompleteFromDoc()

Private method to handle the autocomplete from document action.

ViewManager.__editBookmarked

__editBookmarked()

Private method to edit the list of bookmarked files.

ViewManager.__editBoxComment

__editBoxComment()

Private method to handle the box comment action.

ViewManager.__editComment

__editComment()

Private method to handle the comment action.

ViewManager.__editCopy

__editCopy()

Private method to handle the copy action.

ViewManager.__editCut

__editCut()

Private method to handle the cut action.

ViewManager.__editDelete

__editDelete()

Private method to handle the delete action.

ViewManager.__editDeselectAll

__editDeselectAll()

Private method to handle the select all action.

ViewManager.__editIndent

__editIndent()

Private method to handle the indent action.

ViewManager.__editJoin

__editJoin()

Private method to handle the join action.

ViewManager.__editPaste

__editPaste()

Private method to handle the paste action.

ViewManager.__editProjectPEL

__editProjectPEL()

Private slot to edit the project exception list.

ViewManager.__editProjectPWL

__editProjectPWL()

Private slot to edit the project word list.

ViewManager.__editRedo

__editRedo()

Private method to handle the redo action.

ViewManager.__editRevert

__editRevert()

Private method to handle the revert action.

ViewManager.__editSelectAll

__editSelectAll()

Private method to handle the select all action.

ViewManager.__editSelectBrace

__editSelectBrace()

Private method to handle the select to brace action.

ViewManager.__editShowCallTips

__editShowCallTips()

Private method to handle the calltips action.

ViewManager.__editShowCodeInfo

__editShowCodeInfo()

Private method to handle the code info action.

ViewManager.__editSmartIndent

__editSmartIndent()

Private method to handle the smart indent action.

ViewManager.__editSortSelectedLines

__editSortSelectedLines()

Private slot to sort the selected lines.

ViewManager.__editSpellingDictionary

__editSpellingDictionary(dictionaryFile)

Private slot to edit the given spelling dictionary.

dictionaryFile
file name of the dictionary to edit (string)

ViewManager.__editStreamComment

__editStreamComment()

Private method to handle the stream comment action.

ViewManager.__editToggleComment

__editToggleComment()

Private method to handle the toggle comment action.

ViewManager.__editUncomment

__editUncomment()

Private method to handle the uncomment action.

ViewManager.__editUndo

__editUndo()

Private method to handle the undo action.

ViewManager.__editUnindent

__editUnindent()

Private method to handle the unindent action.

ViewManager.__editUserPEL

__editUserPEL()

Private slot to edit the user exception list.

ViewManager.__editUserPWL

__editUserPWL()

Private slot to edit the user word list.

ViewManager.__editorAutoCompletionAPIsAvailable

__editorAutoCompletionAPIsAvailable(available, editor)

Private method to handle the availability of API autocompletion signal.

available (bool)
flag indicating the availability of API autocompletion
editor (Editor)
reference to the editor

ViewManager.__editorCommand

__editorCommand(cmd)

Private method to send an editor command to the active window.

cmd
the scintilla command to be sent

ViewManager.__editorConfigChanged

__editorConfigChanged(editor)

Private slot to handle changes of an editor's configuration.

editor (Editor)
reference to the editor

ViewManager.__editorDoubleClicked

__editorDoubleClicked(editor, pos, buttons)

Private slot handling mouse double clicks of an editor.

Note: This method is simply a multiplexer to re-emit the signal with the editor prepended.

editor (Editor)
reference to the editor, that emitted the signal
pos (QPoint)
position of the double click
buttons (Qt.MouseButtons)
mouse buttons that were double clicked

ViewManager.__editorOpened

__editorOpened()

Private slot to handle the editorOpened signal.

ViewManager.__editorRenamed

__editorRenamed(fn, editor)

Private slot to handle the editorRenamed signal.

It simply re-emits the signal.

fn (str)
filename of the renamed editor
editor (Editor)
reference to the editor

ViewManager.__editorSaved

__editorSaved(fn, editor)

Private slot to handle the editorSaved signal.

It simply re-emits the signal.

fn (str)
filename of the saved editor
editor (Editor)
reference to the editor

ViewManager.__editorSelectionChanged

__editorSelectionChanged(editor)

Private slot to handle changes of the current editors selection.

editor (Editor)
reference to the editor

ViewManager.__enableSpellingActions

__enableSpellingActions()

Private method to set the enabled state of the spelling actions.

ViewManager.__eolPixmap

__eolPixmap(eolIndicator)

Private method to get an EOL pixmap for an EOL string.

eolIndicator
eol indicator string (string)
Returns:
pixmap for the eol indicator (QPixmap)

ViewManager.__exportMenuTriggered

__exportMenuTriggered(act)

Private method to handle the selection of an export format.

act
reference to the action that was triggered (QAction)

ViewManager.__findFileName

__findFileName()

Private method to handle the search for file action.

ViewManager.__findNextWord

__findNextWord()

Private slot to find the next occurrence of the current word of the current editor.

ViewManager.__findPrevWord

__findPrevWord()

Private slot to find the previous occurrence of the current word of the current editor.

ViewManager.__goto

__goto()

Private method to handle the goto action.

ViewManager.__gotoBrace

__gotoBrace()

Private method to handle the goto brace action.

ViewManager.__gotoLastEditPosition

__gotoLastEditPosition()

Private method to move the cursor to the last edit position.

ViewManager.__gotoNextMethodClass

__gotoNextMethodClass()

Private slot to go to the next Python/Ruby method or class definition.

ViewManager.__gotoPreviousMethodClass

__gotoPreviousMethodClass()

Private slot to go to the previous Python/Ruby method or class definition.

ViewManager.__gotoSyntaxError

__gotoSyntaxError()

Private method to handle the goto syntax error action.

ViewManager.__initBookmarkActions

__initBookmarkActions()

Private method defining the user interface actions for the bookmarks commands.

ViewManager.__initContextMenuExporters

__initContextMenuExporters()

Private method used to setup the Exporters sub menu.

Returns:
reference to the generated menu (QMenu)

ViewManager.__initEditActions

__initEditActions()

Private method defining the user interface actions for the edit commands.

ViewManager.__initFileActions

__initFileActions()

Private method defining the user interface actions for file handling.

ViewManager.__initMacroActions

__initMacroActions()

Private method defining the user interface actions for the macro commands.

ViewManager.__initSearchActions

__initSearchActions()

Private method defining the user interface actions for the search commands.

ViewManager.__initSpellingActions

__initSpellingActions()

Private method to initialize the spell checking actions.

ViewManager.__initViewActions

__initViewActions()

Private method defining the user interface actions for the view commands.

ViewManager.__isEditorInfoSupportedEd

__isEditorInfoSupportedEd(editor)

Private method to check, if an editor is supported by the documentation viewer.

editor (Editor)
reference to the editor to check for
Returns:
flag indicating the support status
Return Type:
bool

ViewManager.__lastEditPositionAvailable

__lastEditPositionAvailable()

Private slot to handle the lastEditPositionAvailable signal of an editor.

ViewManager.__lastEditorClosed

__lastEditorClosed()

Private slot to handle the lastEditorClosed signal.

ViewManager.__loadRecent

__loadRecent()

Private method to load the recently opened filenames.

ViewManager.__macroDelete

__macroDelete()

Private method to handle the delete macro action.

ViewManager.__macroLoad

__macroLoad()

Private method to handle the load macro action.

ViewManager.__macroRun

__macroRun()

Private method to handle the run macro action.

ViewManager.__macroSave

__macroSave()

Private method to handle the save macro action.

ViewManager.__macroStartRecording

__macroStartRecording()

Private method to handle the start macro recording action.

ViewManager.__macroStopRecording

__macroStopRecording()

Private method to handle the stop macro recording action.

ViewManager.__newDocumentSplitView

__newDocumentSplitView()

Private method to open a new view of the current editor in a new split.

ViewManager.__newDocumentView

__newDocumentView()

Private method to open a new view of the current editor.

ViewManager.__newLineBelow

__newLineBelow()

Private method to insert a new line below the current one even if cursor is not at the end of the line.

ViewManager.__nextBookmark

__nextBookmark()

Private method to handle the next bookmark action.

ViewManager.__nextChange

__nextChange()

Private method to handle the next change action.

ViewManager.__nextTask

__nextTask()

Private method to handle the next task action.

ViewManager.__nextUncovered

__nextUncovered()

Private method to handle the next uncovered action.

ViewManager.__nextWarning

__nextWarning()

Private method to handle the next warning action.

ViewManager.__openFiles

__openFiles()

Private slot to open some files.

ViewManager.__openSourceFile

__openSourceFile(act)

Private method to open a file from the list of recently opened files.

act
reference to the action that triggered (QAction)

ViewManager.__previewEditor

__previewEditor(checked)

Private slot to handle a change of the preview selection state.

checked
state of the action (boolean)

ViewManager.__previousBookmark

__previousBookmark()

Private method to handle the previous bookmark action.

ViewManager.__previousChange

__previousChange()

Private method to handle the previous change action.

ViewManager.__previousTask

__previousTask()

Private method to handle the previous task action.

ViewManager.__previousUncovered

__previousUncovered()

Private method to handle the previous uncovered action.

ViewManager.__previousWarning

__previousWarning()

Private method to handle the previous warning action.

ViewManager.__quickSearch

__quickSearch()

Private slot to handle the incremental quick search.

ViewManager.__quickSearchEnter

__quickSearchEnter()

Private slot to handle the incremental quick search return pressed (jump back to text).

ViewManager.__quickSearchEscape

__quickSearchEscape()

Private slot to handle the incremental quick search escape pressed (jump back to text).

ViewManager.__quickSearchExtend

__quickSearchExtend()

Private method to handle the quicksearch extend action.

ViewManager.__quickSearchFocusIn

__quickSearchFocusIn()

Private method to handle a focus in signal of the quicksearch lineedit.

ViewManager.__quickSearchInEditor

__quickSearchInEditor(again, back)

Private slot to perform a quick search.

again
flag indicating a repeat of the last search (boolean)
back
flag indicating a backwards search operation (boolean)

ViewManager.__quickSearchMarkOccurrences

__quickSearchMarkOccurrences(txt)

Private method to mark all occurrences of the search text.

txt
text to search for (string)

ViewManager.__quickSearchPrev

__quickSearchPrev()

Private slot to handle the quickFindPrev toolbutton action.

ViewManager.__quickSearchSetEditColors

__quickSearchSetEditColors(error)

Private method to set the quick search edit colors.

error
flag indicating an error (boolean)

ViewManager.__quickSearchText

__quickSearchText()

Private slot to handle the textChanged signal of the quicksearch edit.

ViewManager.__replaceFiles

__replaceFiles()

Private method to handle the replace in files action.

ViewManager.__replaceOpenFiles

__replaceOpenFiles()

Private method to handle the replace in open files action.

ViewManager.__saveRecent

__saveRecent()

Private method to save the list of recently opened filenames.

ViewManager.__searchClearMarkers

__searchClearMarkers()

Private method to clear the search markers of the active window.

ViewManager.__searchFiles

__searchFiles()

Private method to handle the search in files action.

ViewManager.__searchNext

__searchNext()

Private slot to handle the search next action.

ViewManager.__searchOpenFiles

__searchOpenFiles()

Private method to handle the search in open files action.

ViewManager.__searchPrev

__searchPrev()

Private slot to handle the search previous action.

ViewManager.__setAutoSpellChecking

__setAutoSpellChecking()

Private slot to set the automatic spell checking of all editors.

ViewManager.__setSbFile

__setSbFile(fn=None, line=None, pos=None, encoding=None, language=None, eol=None, zoom=None)

Private method to set the file info in the status bar.

fn
filename to display (string)
line
line number to display (int)
pos
character position to display (int)
encoding
encoding name to display (string)
language
language to display (string)
eol
eol indicator to display (string)
zoom
zoom value (integer)

ViewManager.__shortenEmptyLines

__shortenEmptyLines()

Private method to handle the shorten empty lines action.

ViewManager.__showBookmarkMenu

__showBookmarkMenu()

Private method to set up the bookmark menu.

ViewManager.__showBookmarkedMenu

__showBookmarkedMenu()

Private method to set up bookmarked files menu.

ViewManager.__showBookmarksMenu

__showBookmarksMenu()

Private method to handle the show bookmarks menu signal.

ViewManager.__showEditSpellingMenu

__showEditSpellingMenu()

Private method to set up the edit dictionaries menu.

ViewManager.__showEncodingsMenu

__showEncodingsMenu(pos)

Private slot to show the Encodings menu of the current editor.

pos
position the menu should be shown at (QPoint)

ViewManager.__showEolMenu

__showEolMenu(pos)

Private slot to show the EOL menu of the current editor.

pos
position the menu should be shown at (QPoint)

ViewManager.__showFileMenu

__showFileMenu()

Private method to set up the file menu.

ViewManager.__showLanguagesMenu

__showLanguagesMenu(pos)

Private slot to show the Languages menu of the current editor.

pos
position the menu should be shown at (QPoint)

ViewManager.__showRecentMenu

__showRecentMenu()

Private method to set up recent files menu.

ViewManager.__spellCheck

__spellCheck()

Private slot to perform a spell check of the current editor.

ViewManager.__splitOrientation

__splitOrientation(checked)

Private method to handle the split orientation action.

checked
flag indicating the checked state of the action (boolean). True means splitting horizontally.

ViewManager.__splitView

__splitView()

Private method to handle the split view action.

ViewManager.__taskMarkersUpdated

__taskMarkersUpdated(editor)

Private slot to handle the taskMarkersUpdated signal.

editor
editor that sent the signal

ViewManager.__toggleAll

__toggleAll()

Private method to handle the toggle all folds action.

ViewManager.__toggleAllChildren

__toggleAllChildren()

Private method to handle the toggle all folds (including children) action.

ViewManager.__toggleBookmark

__toggleBookmark()

Private method to handle the toggle bookmark action.

ViewManager.__toggleCurrent

__toggleCurrent()

Private method to handle the toggle current fold action.

ViewManager.__unhighlight

__unhighlight()

Private slot to switch of all highlights.

ViewManager.__zoom

__zoom()

Private method to handle the zoom action.

ViewManager.__zoomIn

__zoomIn()

Private method to handle the zoom in action.

ViewManager.__zoomOut

__zoomOut()

Private method to handle the zoom out action.

ViewManager.__zoomReset

__zoomReset()

Private method to reset the zoom factor.

ViewManager.__zoomTo

__zoomTo(value)

Private slot to zoom to a given value.

value
zoom value to be set (integer)

ViewManager._addView

_addView(win, fn=None, noName="", addNext=False, indexes=None)

Protected method to add a view (i.e. window).

win (EditorAssembly)
editor assembly to be added
fn (str)
filename of this editor
noName (str)
name to be used for an unnamed editor
addNext (bool)
flag indicating to add the view next to the current view
indexes (tuple of two int)
of the editor, first the split view index, second the index within the view
Raises RuntimeError:
Not implemented

ViewManager._checkActions

_checkActions(editor, setSb=True)

Protected slot to check some actions for their enable/disable status and set the statusbar info.

editor
editor window
setSb
flag indicating an update of the status bar is wanted (boolean)

ViewManager._getOpenFileFilter

_getOpenFileFilter()

Protected method to return the active filename filter for a file open dialog.

The appropriate filename filter is determined by file extension of the currently active editor.

Returns:
name of the filename filter (string) or None

ViewManager._getOpenStartDir

_getOpenStartDir()

Protected method to return the starting directory for a file open dialog.

The appropriate starting directory is calculated using the following search order, until a match is found:
1: Directory of currently active editor
2: Directory of currently active Project
3: CWD

Returns:
name of directory to start (string)

ViewManager._initWindowActions

_initWindowActions()

Protected method to define the user interface actions for window handling.

Raises RuntimeError:
Not implemented

ViewManager._modificationStatusChanged

_modificationStatusChanged(m, editor)

Protected slot to handle the modificationStatusChanged signal.

m
flag indicating the modification status (boolean)
editor
editor window changed
Raises RuntimeError:
Not implemented

ViewManager._removeAllViews

_removeAllViews()

Protected method to remove all views (i.e. windows).

Raises RuntimeError:
Not implemented

ViewManager._removeView

_removeView(win)

Protected method to remove a view (i.e. window).

win
editor window to be removed
Raises RuntimeError:
Not implemented

ViewManager._showView

_showView(win, fn=None)

Protected method to show a view (i.e. window).

win
editor assembly to be shown
fn
filename of this editor
Raises RuntimeError:
Not implemented

ViewManager._syntaxErrorToggled

_syntaxErrorToggled(editor)

Protected slot to handle the syntaxerrorToggled signal.

It checks some syntax error actions and reemits the signal.

editor
editor that sent the signal

ViewManager.activeWindow

activeWindow()

Public method to return the active (i.e. current) window.

Returns:
reference to the active editor
Raises RuntimeError:
Not implemented

ViewManager.addSplit

addSplit()

Public method used to split the current view.

ViewManager.addToExtrasMenu

addToExtrasMenu(menu)

Public method to add some actions to the Extras menu.

menu
reference to the menu to add actions to (QMenu)

ViewManager.addToRecentList

addToRecentList(fn)

Public slot to add a filename to the list of recently opened files.

fn
name of the file to be added

ViewManager.appFocusChanged

appFocusChanged(old, now)

Public method to handle the global change of focus.

old (QWidget)
reference to the widget loosing focus
now (QWidget)
reference to the widget gaining focus

ViewManager.canCascade

canCascade()

Public method to signal if cascading of managed windows is available.

Returns:
flag indicating cascading of windows is available
Raises RuntimeError:
Not implemented

ViewManager.canSplit

canSplit()

Public method to signal if splitting of the view is available.

Returns:
flag indicating splitting of the view is available.

ViewManager.canTile

canTile()

Public method to signal if tiling of managed windows is available.

Returns:
flag indicating tiling of windows is available
Raises RuntimeError:
Not implemented

ViewManager.cancelSharedEdit

cancelSharedEdit()

Public slot to cancel a shared edit session for the current editor.

ViewManager.cascade

cascade()

Public method to cascade the managed windows.

Raises RuntimeError:
Not implemented

ViewManager.checkAllDirty

checkAllDirty()

Public method to check the dirty status of all editors.

Returns:
flag indicating successful reset of all dirty flags
Return Type:
bool

ViewManager.checkDirty

checkDirty(editor, autosave=False)

Public method to check the dirty status and open a message window.

editor (Editor)
editor window to check
autosave (bool)
flag indicating that the file should be saved automatically
Returns:
flag indicating successful reset of the dirty flag
Return Type:
bool

ViewManager.checkFileDirty

checkFileDirty(fn)

Public method to check the dirty status of an editor given its file name and open a message window.

fn (str)
file name of editor to be checked
Returns:
flag indicating successful reset of the dirty flag
Return Type:
bool

ViewManager.clearRecent

clearRecent()

Public method to clear the recent files menu.

ViewManager.cloneEditor

cloneEditor(caller, filetype, fn)

Public method to clone an editor displaying the given document.

caller
reference to the editor calling this method
filetype
type of the source file (string)
fn
filename of this view
Returns:
reference to the new editor object (Editor.Editor) and the new editor assembly object (EditorAssembly.EditorAssembly)

ViewManager.closeAllWindows

closeAllWindows()

Public method to close all editor windows via file menu.

ViewManager.closeCurrentWindow

closeCurrentWindow()

Public method to close the current window.

Returns:
flag indicating success (boolean)

ViewManager.closeEditor

closeEditor(editor, ignoreDirty=False)

Public method to close an editor window.

editor (Editor)
editor window to be closed
ignoreDirty (bool)
flag indicating to ignore the 'dirty' status
Returns:
flag indicating success
Return Type:
bool

ViewManager.closeEditorWindow

closeEditorWindow(editor)

Public method to close an arbitrary source editor.

editor
editor to be closed

ViewManager.closeViewManager

closeViewManager()

Public method to shutdown the viewmanager.

If it cannot close all editor windows, it aborts the shutdown process.

Returns:
flag indicating success (boolean)

ViewManager.closeWindow

closeWindow(fn, ignoreDirty=False)

Public method to close an arbitrary source editor.

fn (str)
file name of the editor to be closed
ignoreDirty (bool)
flag indicating to ignore the 'dirty' status
Returns:
flag indicating success
Return Type:
bool

ViewManager.editorsCheckFocusInEnabled

editorsCheckFocusInEnabled()

Public method returning the flag indicating editors should perform focus in checks.

Returns:
flag indicating focus in checks should be performed (boolean)

ViewManager.enableEditorsCheckFocusIn

enableEditorsCheckFocusIn(enabled)

Public method to set a flag enabling the editors to perform focus in checks.

enabled
flag indicating focus in checks should be performed (boolean)

ViewManager.eventFilter

eventFilter(qobject, event)

Public method called to filter an event.

qobject
object, that generated the event (QObject)
event
the event, that was generated by object (QEvent)
Returns:
flag indicating if event was filtered out

ViewManager.exit

exit()

Public method to handle the debugged program terminating.

ViewManager.getAPIsManager

getAPIsManager()

Public method to get a reference to the APIs manager.

Returns:
the APIs manager object (eric6.QScintilla.APIsManager)

ViewManager.getActions

getActions(actionSetType)

Public method to get a list of all actions.

actionSetType
string denoting the action set to get. It must be one of "edit", "file", "search", "view", "window", "macro", "bookmark" or "spelling".
Returns:
list of all actions (list of E5Action)

ViewManager.getActiveName

getActiveName()

Public method to retrieve the filename of the active window.

Returns:
filename of active window (string)

ViewManager.getEditor

getEditor(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.

fn (str)
filename to look for
filetype (str)
type of the source file
addNext (bool)
flag indicating that if a new editor needs to be created, it should be added next to the current editor
indexes (tuple of two int)
of the editor, first the split view index, second the index within the view
Returns:
tuple of two values giving a flag indicating a new window creation and a reference to the editor displaying this file
Return Type:
tuple of (bool, Editor)

ViewManager.getMostRecent

getMostRecent()

Public method to get the most recently opened file.

Returns:
path of the most recently opened file (string)

ViewManager.getNumber

getNumber()

Public method to get a number from the active window.

Returns:
selected text of the active window (string)

ViewManager.getOpenEditor

getOpenEditor(fn)

Public method to return the editor displaying the given file.

fn
filename to look for
Returns:
a reference to the editor displaying this file or None, if no editor was found

ViewManager.getOpenEditorCount

getOpenEditorCount(fn)

Public method to return the count of editors displaying the given file.

fn
filename to look for
Returns:
count of editors displaying this file (integer)

ViewManager.getOpenEditors

getOpenEditors()

Public method to get references to all open editors.

Returns:
list of references to all open editors (list of QScintilla.editor)

ViewManager.getOpenEditorsCount

getOpenEditorsCount()

Public method to get the number of open editors.

Returns:
number of open editors (integer)

ViewManager.getOpenEditorsForSession

getOpenEditorsForSession()

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.

Returns:
list of list of editor references
Return Type:
list of list of Editor

ViewManager.getOpenFilenames

getOpenFilenames()

Public method returning a list of the filenames of all editors.

Returns:
list of all opened filenames (list of strings)

ViewManager.getSRHistory

getSRHistory(key)

Public method to get the search or replace history list.

key
list to return (must be 'search' or 'replace')
Returns:
the requested history list (list of strings)

ViewManager.getSplitOrientation

getSplitOrientation()

Public method to get the orientation of the split view.

Returns:
orientation of the split (Qt.Horizontal or Qt.Vertical)

ViewManager.handleResetUI

handleResetUI()

Public slot to handle the resetUI signal.

ViewManager.initActions

initActions()

Public method defining the user interface actions.

ViewManager.initBookmarkMenu

initBookmarkMenu()

Public method to create the Bookmark menu.

Returns:
the generated menu

ViewManager.initBookmarkToolbar

initBookmarkToolbar(toolbarManager)

Public method to create the Bookmark toolbar.

toolbarManager
reference to a toolbar manager object (E5ToolBarManager)
Returns:
the generated toolbar

ViewManager.initEditMenu

initEditMenu()

Public method to create the Edit menu.

Returns:
the generated menu

ViewManager.initEditToolbar

initEditToolbar(toolbarManager)

Public method to create the Edit toolbar.

toolbarManager
reference to a toolbar manager object (E5ToolBarManager)
Returns:
the generated toolbar

ViewManager.initFileMenu

initFileMenu()

Public method to create the File menu.

Returns:
the generated menu

ViewManager.initFileToolbar

initFileToolbar(toolbarManager)

Public method to create the File toolbar.

toolbarManager
reference to a toolbar manager object (E5ToolBarManager)
Returns:
the generated toolbar

ViewManager.initMacroMenu

initMacroMenu()

Public method to create the Macro menu.

Returns:
the generated menu

ViewManager.initSearchMenu

initSearchMenu()

Public method to create the Search menu.

Returns:
the generated menu
Return Type:
QMenu

ViewManager.initSearchToolbars

initSearchToolbars(toolbarManager)

Public method to create the Search toolbars.

toolbarManager
reference to a toolbar manager object (E5ToolBarManager)
Returns:
a tuple of the generated toolbar (search, quicksearch)

ViewManager.initSpellingToolbar

initSpellingToolbar(toolbarManager)

Public method to create the Spelling toolbar.

toolbarManager
reference to a toolbar manager object (E5ToolBarManager)
Returns:
the generated toolbar

ViewManager.initViewMenu

initViewMenu()

Public method to create the View menu.

Returns:
the generated menu

ViewManager.initViewToolbar

initViewToolbar(toolbarManager)

Public method to create the View toolbar.

toolbarManager
reference to a toolbar manager object (E5ToolBarManager)
Returns:
the generated toolbar

ViewManager.insertNumber

insertNumber(txt)

Public slot to insert a number text into the active window.

txt
text to be inserted (string)

ViewManager.insertSymbol

insertSymbol(txt)

Public slot to insert a symbol text into the active window.

txt
text to be inserted (string)

ViewManager.isConnected

isConnected()

Public method to check the connection status of the IDE.

Returns:
flag indicating the connection status (boolean)

ViewManager.isEditorInfoSupported

isEditorInfoSupported(language)

Public method to check, if a language is supported by the documentation viewer.

language (str)
editor programming language to check
Returns:
flag indicating the support status
Return Type:
bool

ViewManager.mainWidget

mainWidget()

Public method to return a reference to the main Widget of a specific view manager subclass.

Raises RuntimeError:
Not implemented

ViewManager.newEditor

newEditor()

Public slot to generate a new empty editor.

ViewManager.newEditorView

newEditorView(fn, caller, filetype="", indexes=None)

Public method to create a new editor displaying the given document.

fn (str)
filename of this view
caller (Editor)
reference to the editor calling this method
filetype (str)
type of the source file
indexes (tuple of two int)
of the editor, first the split view index, second the index within the view
Returns:
reference to the new editor object
Return Type:
Editor

ViewManager.nextSplit

nextSplit()

Public slot used to move to the next split.

ViewManager.openFiles

openFiles(prog)

Public slot to open some files.

prog
name of file to be opened (string)

ViewManager.openSourceFile

openSourceFile(fn, lineno=-1, filetype="", selStart=0, selEnd=0, pos=0, addNext=False, indexes=None)

Public slot to display a file in an editor.

fn (str)
name of file to be opened
lineno (int or list of int)
line number to place the cursor at or list of line numbers (cursor will be placed at the next line greater than the current one)
filetype (str)
type of the source file
selStart (int)
start of an area to be selected
selEnd (int)
end of an area to be selected
pos (int)
position within the line to place the cursor at
addNext (bool)
flag indicating to add the file next to the current editor
indexes (tuple of two int)
of the editor, first the split view index, second the index within the view
Returns:
reference to the opened editor
Return Type:
Editor

ViewManager.preferencesChanged

preferencesChanged()

Public slot to handle the preferencesChanged signal.

This method performs the following actions

ViewManager.prevSplit

prevSplit()

Public slot used to move to the previous split.

ViewManager.printCurrentEditor

printCurrentEditor()

Public slot to print the contents of the current editor.

ViewManager.printEditor

printEditor(editor)

Public slot to print an editor.

editor
editor to be printed

ViewManager.printPreviewCurrentEditor

printPreviewCurrentEditor()

Public slot to show a print preview of the current editor.

ViewManager.projectClosed

projectClosed()

Public slot to handle the projectClosed signal.

ViewManager.projectFileRenamed

projectFileRenamed(oldfn, newfn)

Public slot to handle the projectFileRenamed signal.

oldfn
old filename of the file (string)
newfn
new filename of the file (string)

ViewManager.projectLexerAssociationsChanged

projectLexerAssociationsChanged()

Public slot to handle changes of the project lexer associations.

ViewManager.projectOpened

projectOpened()

Public slot to handle the projectOpened signal.

ViewManager.receive

receive(projectHash, fileName, command)

Public slot to handle received editor commands.

projectHash
hash of the project (string)
fileName
project relative file name of the editor (string)
command
command string (string)

ViewManager.removeSplit

removeSplit(index=-1)

Public method used to remove the current split view or a split view by index.

index (int)
index of the split to be removed (-1 means to delete the current split)
Returns:
flag indicating successful deletion
Return Type:
bool

ViewManager.replaceWidget

replaceWidget()

Public method to get a reference to the replace widget.

Returns:
reference to the replace widget (SearchReplaceSlidingWidget)

ViewManager.saveAllEditors

saveAllEditors()

Public slot to save the contents of all editors.

ViewManager.saveAsCurrentEditor

saveAsCurrentEditor()

Public slot to save the contents of the current editor to a new file.

ViewManager.saveAsEditorEd

saveAsEditorEd(ed)

Public slot to save the contents of an editor to a new file.

ed
editor to be saved

ViewManager.saveCopyCurrentEditor

saveCopyCurrentEditor()

Public slot to save the contents of the current editor to a new copy of the file.

ViewManager.saveCopyEditorEd

saveCopyEditorEd(ed)

Public slot to save the contents of an editor to a new copy of the file.

ed
editor to be saved

ViewManager.saveCurrentEditor

saveCurrentEditor()

Public slot to save the contents of the current editor.

ViewManager.saveEditor

saveEditor(fn)

Public method to save a named editor file.

fn
filename of editor to be saved (string)
Returns:
flag indicating success (boolean)

ViewManager.saveEditorEd

saveEditorEd(ed)

Public slot to save the contents of an editor.

ed
editor to be saved
Returns:
flag indicating success (boolean)

ViewManager.saveEditorsList

saveEditorsList(editors)

Public slot to save a list of editors.

editors
list of editors to be saved

ViewManager.searchWidget

searchWidget()

Public method to get a reference to the search widget.

Returns:
reference to the search widget (SearchReplaceSlidingWidget)

ViewManager.send

send(fileName, message)

Public method to send an editor command to remote editors.

fileName
file name of the editor (string)
message
command message to be sent (string)

ViewManager.sendSharedEdit

sendSharedEdit()

Public slot to end a shared edit session for the current editor and send the changes.

ViewManager.setCooperationClient

setCooperationClient(client)

Public method to set a reference to the cooperation client.

client
reference to the cooperation client (CooperationClient)

ViewManager.setEditorName

setEditorName(editor, newName)

Public method to change the displayed name of the editor.

editor
editor window to be changed
newName
new name to be shown (string)
Raises RuntimeError:
Not implemented

ViewManager.setFileLine

setFileLine(fn, line, error=False, syntaxError=False)

Public method to update the user interface when the current program or line changes.

fn
filename of editor to update (string)
line
line number to highlight (int)
error
flag indicating an error highlight (boolean)
syntaxError
flag indicating a syntax error

ViewManager.setReferences

setReferences(ui, dbs)

Public method to set some references needed later on.

ui
reference to the main user interface
dbs
reference to the debug server object

ViewManager.setSbInfo

setSbInfo(sbLine, sbPos, sbWritable, sbEncoding, sbLanguage, sbEol, sbZoom)

Public method to transfer statusbar info from the user interface to viewmanager.

sbLine
reference to the line number part of the statusbar (QLabel)
sbPos
reference to the character position part of the statusbar (QLabel)
sbWritable
reference to the writability indicator part of the statusbar (QLabel)
sbEncoding
reference to the encoding indicator part of the statusbar (QLabel)
sbLanguage
reference to the language indicator part of the statusbar (QLabel)
sbEol
reference to the eol indicator part of the statusbar (QLabel)
sbZoom
reference to the zoom widget (E5ZoomWidget)

ViewManager.setSplitCount

setSplitCount(count)

Public method to set the number of split views.

count (int)
number of split views

ViewManager.setSplitOrientation

setSplitOrientation(orientation)

Public method used to set the orientation of the split view.

orientation
orientation of the split (Qt.Horizontal or Qt.Vertical)

ViewManager.shareConnected

shareConnected(connected)

Public slot to handle a change of the connected state.

connected
flag indicating the connected state (boolean)

ViewManager.shareEditor

shareEditor(share)

Public slot to set the shared status of the current editor.

share
flag indicating the share status (boolean)

ViewManager.showDebugSource

showDebugSource(fn, line)

Public method to open the given file and highlight the given line in it.

fn
filename of editor to update (string)
line
line number to highlight (int)

ViewManager.showEditorInfo

showEditorInfo(editor)

Public method to show some information for a given editor.

editor (Editor)
editor to show information text for

ViewManager.showReplaceWidget

showReplaceWidget()

Public method to show the replace widget.

ViewManager.showSearchWidget

showSearchWidget()

Public method to show the search widget.

ViewManager.showWindowMenu

showWindowMenu(windowMenu)

Public method to set up the viewmanager part of the Window menu.

windowMenu
reference to the window menu
Raises RuntimeError:
Not implemented

ViewManager.splitCount

splitCount()

Public method to get the number of split views.

Returns:
number of split views
Return Type:
int

ViewManager.startSharedEdit

startSharedEdit()

Public slot to start a shared edit session for the current editor.

ViewManager.textForFind

textForFind(getCurrentWord=True)

Public method to determine the selection or the current word for the next find operation.

getCurrentWord
flag indicating to return the current word, if no selected text was found (boolean)
Returns:
selection or current word (string)

ViewManager.tile

tile()

Public method to tile the managed windows.

Raises RuntimeError:
Not implemented

ViewManager.unhighlight

unhighlight(current=False)

Public method to switch off all highlights or the highlight of the current editor.

current
flag indicating only the current editor should be unhighlighted (boolean)

ViewManager.zoomValueChanged

zoomValueChanged(value, zoomingWidget)

Public slot to handle changes of the zoom value.

value (int)
new zoom value
zoomingWidget (Editor or Shell)
reference to the widget triggering the slot
Up