Plugin_Project_Django.PluginProjectDjango

Module implementing the Django project plugin.

Global Attributes

author
autoactivate
className
deactivateable
djangoPluginObject
error
longDescription
name
needsRestart
packageName
shortDescription
version

Classes

ProjectDjangoPlugin Class implementing the Django project plugin.

Functions

apiFiles Module function to return the API files made available by this plugin.
createDjangoPage Module function to create the Django configuration page.
getConfigData Module function returning data as required by the configuration dialog.
prepareUninstall Module function to prepare for an uninstallation.


ProjectDjangoPlugin

Class implementing the Django project plugin.

Derived from

QObject

Class Attributes

lexerAssociations

Methods

ProjectDjangoPlugin Constructor
__checkVersions Private function to check that the eric4 version is ok.
__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.
activate Public method to activate this plugin.
deactivate Public method to deactivate this plugin.
fileTypesCallback Public method to get the filetype associations of the Django project type.
getLexer Public method to instantiate a Django lexer object.
getPreferences Public method to retrieve the various refactoring settings.
lexerAssociationCallback Public method to get the lexer association of the Django project type for a file.
prepareUninstall Public method to prepare for an uninstallation.
setPreferences Public method to store the various refactoring settings.

ProjectDjangoPlugin (Constructor)

ProjectDjangoPlugin(ui)

Constructor

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

ProjectDjangoPlugin.__checkVersions

__checkVersions()

Private function to check that the eric4 version is ok.

Returns:
flag indicating version is ok (boolean)

ProjectDjangoPlugin.__initialize

__initialize()

Private slot to (re)initialize the plugin.

ProjectDjangoPlugin.__loadTranslator

__loadTranslator()

Private method to load the translation file.

ProjectDjangoPlugin.__projectClosed

__projectClosed()

Public slot to handle the projectClosed signal.

ProjectDjangoPlugin.__projectOpened

__projectOpened()

Public slot to handle the projectOpened signal.

ProjectDjangoPlugin.activate

activate()

Public method to activate this plugin.

Returns:
tuple of None and activation status (boolean)

ProjectDjangoPlugin.deactivate

deactivate()

Public method to deactivate this plugin.

ProjectDjangoPlugin.fileTypesCallback

fileTypesCallback()

Public method to get the filetype associations of the Django project type.

Returns:
dictionary with file type associations

ProjectDjangoPlugin.getLexer

getLexer(parent = None)

Public method to instantiate a Django lexer object.

parent
reference to the parent object (QObject)
Returns:
reference to the instanciated lexer object (QsciLexer)

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

ProjectDjangoPlugin.lexerAssociationCallback

lexerAssociationCallback(filename)

Public method to get the lexer association of the Django project type for a file.

filename
name of the file (string or QString)
Returns:
name of the lexer (string) (Pygments lexers are prefixed with 'Pygments|')

ProjectDjangoPlugin.prepareUninstall

prepareUninstall()

Public method to prepare for an uninstallation.

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


apiFiles

apiFiles(language)

Module function to return the API files made available by this plugin.

Returns:
list of API filenames (list of string)
Up


createDjangoPage

createDjangoPage(configDlg)

Module function to create the Django 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