Plugin_Refactoring_BRM.PluginRefactoringBRM

Module implementing the Bicycle Repair Man refactoring plugin.

Classes

Class implementing the Bicycle Repair Man refactoring plugin.

Functions

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

RefactoringBRMPlugin

Class implementing the Bicycle Repair Man refactoring plugin.

Derived from

QObject

Methods

RefactoringBRMPlugin	Constructor
__editorClosed	Private slot called, when an editor was closed.
__editorOpened	Private slot called, when a new editor was opened.
__editorShowMenu	Private slot called, when the the editor context menu or a submenu is about to be shown.
__initEditorMenu	Private method used to setup the editor context menu.
__initialize	Private slot to (re)initialize the plugin.
__lastEditorClosed	Private slot to handle the lastEditorClosed signal.
__loadTranslator	Private method to load the translation file.
activate	Public method to activate this plugin.
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.

RefactoringBRMPlugin (Constructor)

RefactoringBRMPlugin(ui)

Constructor

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

RefactoringBRMPlugin.__editorClosed

__editorClosed(editor)

Private slot called, when an editor was closed.

editor: reference to the editor (QScintilla.Editor)

RefactoringBRMPlugin.__editorOpened

__editorOpened(editor)

Private slot called, when a new editor was opened.

editor: reference to the new editor (QScintilla.Editor)

RefactoringBRMPlugin.__editorShowMenu

__editorShowMenu(menuName, menu, editor)

Private slot called, when the the editor context menu or a submenu is about to be shown.

menuName: name of the menu to be shown (string)
menu: reference to the menu (QMenu)
editor: reference to the editor

RefactoringBRMPlugin.__initEditorMenu

__initEditorMenu()

Private method used to setup the editor context menu.

RefactoringBRMPlugin.__initialize

__initialize()

Private slot to (re)initialize the plugin.

RefactoringBRMPlugin.__lastEditorClosed

__lastEditorClosed()

Private slot to handle the lastEditorClosed signal.

RefactoringBRMPlugin.__loadTranslator

__loadTranslator()

Private method to load the translation file.

RefactoringBRMPlugin.activate

activate()

Public method to activate this plugin.

Returns:: tuple of None and activation status (boolean)

RefactoringBRMPlugin.deactivate

deactivate()

Public method to deactivate this plugin.

RefactoringBRMPlugin.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

RefactoringBRMPlugin.prepareUninstall

prepareUninstall()

Public method to prepare for an uninstallation.

RefactoringBRMPlugin.setPreferences

setPreferences(key, value)

Public method to store the various refactoring settings.

key: the key of the setting to be set
value: the value to be set
prefClass: preferences class used as the storage area

createConfigurationPage

createConfigurationPage(configDlg)

Module function to create the configuration page.

Returns:: reference to the configuration page

getConfigData

getConfigData()

Module function returning data as required by the configuration dialog.

Returns:: dictionary with key "refactoringBRMPage" containing the relevant data

prepareUninstall

prepareUninstall()

Module function to prepare for an uninstallation.