eric7.Plugins.PluginVcsGit

This plugin provides the Git version control interface.

Global Attributes

__header__
error
gitCfgPluginObject

Classes

VcsGitPlugin Class implementing the Git version control plugin.

Functions

clearPrivateData Module function to clear the private data of the plug-in.
createConfigurationPage Module function to create the configuration page.
displayString Public function to get the display string.
exeDisplayData Public method to support the display of some executable info.
getConfigData Module function returning data as required by the configuration dialog.
getVcsSystemIndicator Public function to get the indicators for this version control system.
prepareUninstall Module function to prepare for an uninstallation.


VcsGitPlugin

Class implementing the Git version control plugin.

Derived from

QObject

Class Attributes

GitDefaults

Class Methods

getPreferences Class method to retrieve the various settings.
setPreferences Class method to store the various settings.

Methods

VcsGitPlugin Constructor
activate Public method to activate this plugin.
deactivate Public method to deactivate this plugin.
getConfigPath Public method to get the filename of the config file.
getProjectHelper Public method to get a reference to the project helper object.
initToolbar Public slot to initialize the VCS toolbar.
prepareUninstall Public method to prepare for an uninstallation.
prepareUnload Public method to prepare for an unload.

Static Methods

None

VcsGitPlugin.getPreferences (class method)

getPreferences(key)

Class method to retrieve the various settings.

key (str)
the key of the value to get
Return:
the requested setting
Return Type:
Any

VcsGitPlugin.setPreferences (class method)

setPreferences(key, value)

Class method to store the various settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set

VcsGitPlugin (Constructor)

VcsGitPlugin(ui)

Constructor

ui (UserInterface)
reference to the user interface object

VcsGitPlugin.activate

activate()

Public method to activate this plugin.

Return:
tuple of reference to instantiated version control and activation status
Return Type:
tuple of (Git, bool)

VcsGitPlugin.deactivate

deactivate()

Public method to deactivate this plugin.

VcsGitPlugin.getConfigPath

getConfigPath()

Public method to get the filename of the config file.

Return:
filename of the config file
Return Type:
str

VcsGitPlugin.getProjectHelper

getProjectHelper()

Public method to get a reference to the project helper object.

Return:
reference to the project helper object
Return Type:
GitProjectHelper

VcsGitPlugin.initToolbar

initToolbar(ui, toolbarManager)

Public slot to initialize the VCS toolbar.

ui (UserInterface)
reference to the main window
toolbarManager (EricToolBarManager)
reference to a toolbar manager object

VcsGitPlugin.prepareUninstall

prepareUninstall()

Public method to prepare for an uninstallation.

VcsGitPlugin.prepareUnload

prepareUnload()

Public method to prepare for an unload.

Up


clearPrivateData

clearPrivateData()

Module function to clear the private data of the plug-in.

Up


createConfigurationPage

createConfigurationPage(_configDlg)

Module function to create the configuration page.

_configDlg (QDialog)
reference to the configuration dialog (unused)
Return:
reference to the configuration page
Return Type:
GitPage
Up


displayString

displayString()

Public function to get the display string.

Return:
display string
Return Type:
str
Up


exeDisplayData

exeDisplayData()

Public method to support the display of some executable info.

Return:
dictionary containing the data to query the presence of the executable
Return Type:
dict
Up


getConfigData

getConfigData()

Module function returning data as required by the configuration dialog.

Return:
dictionary with key "zzz_gitPage" containing the relevant data
Return Type:
dict
Up


getVcsSystemIndicator

getVcsSystemIndicator()

Public function to get the indicators for this version control system.

Return:
dictionary with indicator as key and a tuple with the vcs name and vcs display string
Return Type:
dict
Up


prepareUninstall

prepareUninstall()

Module function to prepare for an uninstallation.

Up