Plugin_Refactoring_Rope.PluginRefactoringRope

Module implementing the Rope refactoring plugin.

Classes

RefactoringRopePlugin Class implementing the Rope refactoring plugin.

Functions

createAutoCompletionPage Module function to create the autocompletion configuration page.
createCallTipsPage Module function to create the calltips configuration page.
getConfigData Module function returning data as required by the configuration dialog.
prepareUninstall Module function to prepare for an uninstallation.


RefactoringRopePlugin

Class implementing the Rope refactoring plugin.

Derived from

QObject

Methods

RefactoringRopePlugin Constructor
__checkVersions Private function to check that the eric4 and Python versions are ok.
__codeAssist Private slot to show a list with completion proposals.
__completionListSelected Private slot to handle the selection from the completion list.
__connectEditorSignals Private method to connect to some signals of an editor.
__disconnectEditorSignals Private method to disconnect to some signals of an editor.
__editorAboutToBeSaved Private slot to get the old contents of the named file.
__editorClosed Private slot called, when an editor was closed.
__editorLanguageChanged Private slot to handle the language change of an editor.
__editorOpened Private slot called, when a new editor was opened.
__editorSaved Private slot to activate SOA.
__initialize Private slot to (re)initialize the plugin.
__loadTranslator Private method to load the translation file.
__projectClosed Public slot to handle the projectClosed signal.
__projectOpened Public slot to handle the projectOpened signal.
__setAutoCompletionHook Private method to set the autocompletion hook.
__setCalltipsHook Private method to set the calltip hook.
__unsetAutoCompletionHook Private method to unset the autocompletion hook.
__unsetCalltipsHook Private method to unset the calltip hook.
activate Public method to activate this plugin.
codeAssist Public method to determine the autocompletion proposals.
codeAssistCallTip Public method to return a list of calltips.
deactivate Public method to deactivate this plugin.
getPreferences Public method to retrieve the various refactoring settings.
prepareUninstall Public method to prepare for an uninstallation.
setPreferences Public method to store the various refactoring settings.

RefactoringRopePlugin (Constructor)

RefactoringRopePlugin(ui)

Constructor

ui
reference to the user interface object (UI.UserInterface)

RefactoringRopePlugin.__checkVersions

__checkVersions()

Private function to check that the eric4 and Python versions are ok.

Returns:
flag indicating version is ok (boolean)

RefactoringRopePlugin.__codeAssist

__codeAssist()

Private slot to show a list with completion proposals.

RefactoringRopePlugin.__completionListSelected

__completionListSelected(id, txt)

Private slot to handle the selection from the completion list.

id
the ID of the user list (should be 1) (integer)
txt
the selected text (QString)

RefactoringRopePlugin.__connectEditorSignals

__connectEditorSignals(editor)

Private method to connect to some signals of an editor.

editor
reference to the editor (QScintilla.Editor)

RefactoringRopePlugin.__disconnectEditorSignals

__disconnectEditorSignals(editor)

Private method to disconnect to some signals of an editor.

editor
reference to the editor (QScintilla.Editor)

RefactoringRopePlugin.__editorAboutToBeSaved

__editorAboutToBeSaved(filename)

Private slot to get the old contents of the named file.

filename
name of the file about to be saved (string)

RefactoringRopePlugin.__editorClosed

__editorClosed(editor)

Private slot called, when an editor was closed.

editor
reference to the editor (QScintilla.Editor)

RefactoringRopePlugin.__editorLanguageChanged

__editorLanguageChanged(language)

Private slot to handle the language change of an editor.

RefactoringRopePlugin.__editorOpened

__editorOpened(editor)

Private slot called, when a new editor was opened.

editor
reference to the new editor (QScintilla.Editor)

RefactoringRopePlugin.__editorSaved

__editorSaved(filename)

Private slot to activate SOA.

filename
name of the file that was saved (string)

RefactoringRopePlugin.__initialize

__initialize()

Private slot to (re)initialize the plugin.

RefactoringRopePlugin.__loadTranslator

__loadTranslator()

Private method to load the translation file.

RefactoringRopePlugin.__projectClosed

__projectClosed()

Public slot to handle the projectClosed signal.

RefactoringRopePlugin.__projectOpened

__projectOpened()

Public slot to handle the projectOpened signal.

RefactoringRopePlugin.__setAutoCompletionHook

__setAutoCompletionHook(editor)

Private method to set the autocompletion hook.

editor
reference to the editor (QScintilla.Editor)

RefactoringRopePlugin.__setCalltipsHook

__setCalltipsHook(editor)

Private method to set the calltip hook.

editor
reference to the editor (QScintilla.Editor)

RefactoringRopePlugin.__unsetAutoCompletionHook

__unsetAutoCompletionHook(editor)

Private method to unset the autocompletion hook.

editor
reference to the editor (QScintilla.Editor)

RefactoringRopePlugin.__unsetCalltipsHook

__unsetCalltipsHook(editor)

Private method to unset the calltip hook.

editor
reference to the editor (QScintilla.Editor)

RefactoringRopePlugin.activate

activate()

Public method to activate this plugin.

Returns:
tuple of None and activation status (boolean)

RefactoringRopePlugin.codeAssist

codeAssist(editor, context = False)

Public method to determine the autocompletion proposals.

editor
reference to the editor object, that called this method QScintilla.Editor)
context
flag indicating to autocomplete a context (boolean)

RefactoringRopePlugin.codeAssistCallTip

codeAssistCallTip(editor, pos, commas)

Public method to return a list of calltips.

editor
reference to the editor (QScintilla.Editor)
pos
position in the text for the calltip (integer)
commas
minimum number of commas contained in the calltip (integer)
Returns:
list of possible calltips (list of strings)

RefactoringRopePlugin.deactivate

deactivate()

Public method to deactivate this plugin.

RefactoringRopePlugin.getPreferences

getPreferences(key)

Public method to retrieve the various refactoring settings.

key
the key of the value to get
prefClass
preferences class used as the storage area
Returns:
the requested refactoring setting

RefactoringRopePlugin.prepareUninstall

prepareUninstall()

Public method to prepare for an uninstallation.

RefactoringRopePlugin.setPreferences

setPreferences(key, value)

Public method to store the various refactoring settings.

key
the key of the setting to be set (string)
value
the value to be set
prefClass
preferences class used as the storage area
Up


createAutoCompletionPage

createAutoCompletionPage(configDlg)

Module function to create the autocompletion configuration page.

Returns:
reference to the configuration page
Up


createCallTipsPage

createCallTipsPage(configDlg)

Module function to create the calltips configuration page.

Returns:
reference to the configuration page
Up


getConfigData

getConfigData()

Module function returning data as required by the configuration dialog.

Returns:
dictionary containing the relevant data
Up


prepareUninstall

prepareUninstall()

Module function to prepare for an uninstallation.

Up