--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Plugins/WizardPlugins/EricPluginWizard/Templates.py Sun Dec 10 13:55:30 2017 +0100
@@ -0,0 +1,236 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2014 - 2017 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing the various plug-in templates.
+"""
+
+from __future__ import unicode_literals
+
+mainTemplate = '''# -*- coding: utf-8 -*-
+
+# Copyright (c) {year} {author} <{email}>
+#
+
+"""
+Module documentation goes here.
+"""
+
+from __future__ import unicode_literals
+
+from PyQt5.QtCore import QObject
+
+{config0}\
+# Start-Of-Header
+name = "{name}"
+author = "{author} <{email}>"
+autoactivate = {autoactivate}
+deactivateable = {deactivateable}
+version = "{version}"
+{onDemand}\
+className = "{className}"
+packageName = "{packageName}"
+shortDescription = "{shortDescription}"
+longDescription = (
+ """{longDescription}"""
+)
+needsRestart = {needsRestart}
+pyqtApi = 2
+python2Compatible = {python2Compatible}
+# End-Of-Header
+
+error = ""
+
+
+{modulesetup}\
+{exeData}\
+{exeDataList}\
+{apiFiles}\
+{preview}\
+{config1}\
+class {className}(QObject):
+ """
+ Class documentation goes here.
+ """
+{config2}\
+ def __init__(self, ui):
+ """
+ Constructor
+
+ @param ui reference to the user interface object (UI.UserInterface)
+ """
+ super({className}, self).__init__(ui)
+ self.__ui = ui
+
+ def activate(self):
+ """
+ Public method to activate this plugin.
+
+ @return tuple of None and activation status (boolean)
+ """
+ global error
+ error = "" # clear previous error
+
+ return None, True
+
+ def deactivate(self):
+ """
+ Public method to deactivate this plugin.
+ """
+ pass
+{config3}'''
+
+configTemplate0 = '''import Preferences
+
+'''
+
+configTemplate1 = '''def getConfigData():
+ """
+ Module function returning data as required by the configuration dialog.
+
+ @return dictionary containing the relevant data
+ """
+ return {{
+ "<unique key>": ["<display string>", "<pixmap filename>",
+ pageCreationFunction, None, None],
+ }}
+
+
+def prepareUninstall():
+ """
+ Module function to prepare for an uninstallation.
+ """
+ Preferences.Prefs.settings.remove({className}.PreferencesKey)
+
+
+'''
+
+configTemplate2 = ''' PreferencesKey = "{preferencesKey}"
+
+'''
+
+configTemplate3 = '''\
+
+ def getPreferences(self, key):
+ """
+ Public method to retrieve the various refactoring settings.
+
+ @param key the key of the value to get
+ @return the requested refactoring setting
+ """
+ return None
+
+ def setPreferences(self, key, value):
+ """
+ Public method to store the various refactoring settings.
+
+ @param key the key of the setting to be set (string)
+ @param value the value to be set
+ """
+ pass
+'''
+
+onDemandTemplate = '''pluginType = "{pluginType}"
+pluginTypename = "{pluginTypename}"
+'''
+
+previewPixmapTemplate = '''def previewPix():
+ """
+ Module function to return a preview pixmap.
+
+ @return preview pixmap (QPixmap)
+ """
+ from PyQt5.QtGui import QPixmap
+
+ fname = "preview.png"
+ return QPixmap(fname)
+
+
+'''
+
+exeDisplayDataListTemplate = '''def exeDisplayDataList():
+ """
+ Module function to support the display of some executable info.
+
+ @return list of dictionaries containing the data to query the presence of
+ the executable
+ """
+ dataList = []
+ data = {
+ "programEntry": True,
+ "header": "<translated header string>",
+ "exe": "dummyExe",
+ "versionCommand": "--version",
+ "versionStartsWith": "dummyExe",
+ "versionPosition": -1,
+ "version": "",
+ "versionCleanup": None,
+ }
+ for exePath in ["exe1", "exe2"]:
+ data["exe"] = exePath
+ data["versionStartsWith"] = "<identifier>"
+ dataList.append(data.copy())
+ return dataList
+
+
+'''
+
+exeDisplayDataTemplate = '''def exeDisplayData():
+ """
+ Module function to support the display of some executable info.
+
+ @return dictionary containing the data to query the presence of
+ the executable
+ """
+ data = {
+ "programEntry": True,
+ "header": "<translated header string>",
+ "exe": exe,
+ "versionCommand": "--version",
+ "versionStartsWith": "<identifier>",
+ "versionPosition": -1,
+ "version": "",
+ "versionCleanup": None,
+ }
+
+ return data
+
+
+'''
+
+moduleSetupTemplate = '''def moduleSetup():
+ """
+ Module function to perform module level setup.
+ """
+ pass
+
+
+'''
+
+apiFilesTemplate = '''def apiFiles(language):
+ """
+ Module function to return the API files made available by this plugin.
+
+ @param language language to get APIs for (string)
+ @return list of API filenames (list of string)
+ """
+ if language in ["Python3", "Python2", "Python"]:
+ apisDir = \\
+ os.path.join(os.path.dirname(__file__), "APIs", "Python")
+ apis = glob.glob(os.path.join(apisDir, '*.api'))
+ if language == "Python3":
+ apisDir = \\
+ os.path.join(os.path.dirname(__file__), "APIs", "Python3")
+ apis.extend(glob.glob(os.path.join(apisDir, '*.api')))
+ else:
+ apisDir = \\
+ os.path.join(os.path.dirname(__file__), "APIs", "Python2")
+ apis.extend(glob.glob(os.path.join(apisDir, '*.api')))
+ else:
+ apis = []
+ return apis
+
+
+'''
