tenscripts.tenscripts.TenScriptsExtension Class Reference

Inheritance diagram for tenscripts.tenscripts.TenScriptsExtension:

Public Member Functions
	__init__ (self, parent)
	createActions (self, window)
	initialize (self)
	loadActions (self, window)
	readSettings (self)
	setup (self)
	writeSettings (self)

Public Attributes
	actionToIndex
	indexToAction
	initialize
	scripts
	uitenscripts

Protected Member Functions
	_executeScript (self)

Protected Attributes
	_executeScript

Detailed Description

Definition at line 14 of file tenscripts.py.

Constructor & Destructor Documentation

__init__()

tenscripts.tenscripts.TenScriptsExtension.__init__	(		self,
			parent )

Definition at line 16 of file tenscripts.py.

    def __init__(self, parent):
        super(TenScriptsExtension, self).__init__(parent)
 
        self.scripts = []
        self.actionToIndex = {}
        self.indexToAction = {}
 

References tenscripts.tenscripts.TenScriptsExtension.__init__().

Member Function Documentation

_executeScript()

tenscripts.tenscripts.TenScriptsExtension._executeScript ( self )

protected

Definition at line 60 of file tenscripts.py.

    def _executeScript(self):
        scriptIndex = self.actionToIndex[self.sender().objectName()]
        script = self.scripts[scriptIndex] if len(self.scripts) > scriptIndex else ""
        window = Application.activeWindow()
 
        if script != "":
            try:
                spec = importlib.util.spec_from_file_location(
                    "users_script", script)
                users_module = importlib.util.module_from_spec(spec)
                spec.loader.exec_module(users_module)
 
                if (hasattr(users_module, 'main')
                        and callable(users_module.main)):
                    users_module.main()
 
                window.activeView().showFloatingMessage(
                    str(i18n("Script {0} executed")).format(script), QIcon(), 1500, 2)
 
            except Exception as e:
                window.activeView().showFloatingMessage(str(e), QIcon(), 2000, 1)
        else:
            window.activeView().showFloatingMessage(
                str(i18n(("You did not assign a script to that action"))), QIcon(), 1500, 2)

References tenbrushes.tenbrushes.TenBrushesExtension.actionToIndex, tenscripts.tenscripts.TenScriptsExtension.actionToIndex, KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, and tenscripts.tenscripts.TenScriptsExtension.scripts.

createActions()

tenscripts.tenscripts.TenScriptsExtension.createActions	(		self,
			window )

Definition at line 26 of file tenscripts.py.

    def createActions(self, window):
        action = window.createAction("ten_scripts", i18n("Ten Scripts"))
        action.setToolTip(i18n("Assign ten scripts to ten shortcuts."))
        action.triggered.connect(self.initialize)
        self.loadActions(window)
 

initialize()

tenscripts.tenscripts.TenScriptsExtension.initialize

(

self

)

Definition at line 32 of file tenscripts.py.

    def initialize(self):
        self.uitenscripts = uitenscripts.UITenScripts()
        self.uitenscripts.initialize(self)
 

loadActions()

tenscripts.tenscripts.TenScriptsExtension.loadActions	(		self,
			window )

Definition at line 49 of file tenscripts.py.

    def loadActions(self, window):
        for index, item in enumerate(['1', '2', '3', '4', '5',
                                      '6', '7', '8', '9', '10']):
            action = window.createAction(
                "execute_script_" + item,
                str(i18n("Execute Script {num}")).format(num=item),
                "")
            action.triggered.connect(self._executeScript)
            self.actionToIndex[action.objectName()] = index
            self.indexToAction[index] = action.objectName()
 

readSettings()

tenscripts.tenscripts.TenScriptsExtension.readSettings

(

self

)

Definition at line 36 of file tenscripts.py.

    def readSettings(self):
        for item in range(1, 11):
            self.scripts.append(
                Application.readSetting("tenscripts", f"script_{item}", "")
            )
 

References tenscripts.tenscripts.TenScriptsExtension.scripts.

setup()

tenscripts.tenscripts.TenScriptsExtension.setup

(

self

)

Definition at line 23 of file tenscripts.py.

    def setup(self):
        self.readSettings()
 

References KisKActionCollection.readSettings(), KDcrawIface::RExpanderBox.readSettings(), KDcrawIface::DcrawSettingsWidget.readSettings(), scriptdocker.scriptdocker.ScriptDocker.readSettings(), scripter.ui_scripter.actions.settingsaction.settingsaction.SettingsAction.readSettings(), tenbrushes.tenbrushes.TenBrushesExtension.readSettings(), tenscripts.tenscripts.TenScriptsExtension.readSettings(), workflow_buttons.workflow_buttons.WorkflowButtons.readSettings(), scripter.ui_scripter.actions.settingsaction.fontscombobox.FontsComboBox.readSettings(), scripter.ui_scripter.actions.settingsaction.settingsdialog.SettingsDialog.readSettings(), and scripter.ui_scripter.actions.settingsaction.syntaxstylescombobox.SyntaxStylesComboBox.readSettings().

writeSettings()

tenscripts.tenscripts.TenScriptsExtension.writeSettings

(

self

)

Definition at line 42 of file tenscripts.py.

    def writeSettings(self):
 
        saved_scripts = self.uitenscripts.saved_scripts()
        self.scripts = saved_scripts
        for index in range(10):
            Application.writeSetting("tenscripts", f"script_{index + 1}", saved_scripts[index])
 

References tenscripts.tenscripts.TenScriptsExtension.scripts, tenscripts.tenscripts.TenScriptsExtension.uitenscripts, and tenscripts.tenscriptsdialog.TenScriptsDialog.uitenscripts.

Member Data Documentation

_executeScript

tenscripts.tenscripts.TenScriptsExtension._executeScript

protected

Definition at line 56 of file tenscripts.py.

actionToIndex

tenscripts.tenscripts.TenScriptsExtension.actionToIndex

Definition at line 20 of file tenscripts.py.

indexToAction

tenscripts.tenscripts.TenScriptsExtension.indexToAction

Definition at line 21 of file tenscripts.py.

initialize

tenscripts.tenscripts.TenScriptsExtension.initialize

Definition at line 29 of file tenscripts.py.

scripts

tenscripts.tenscripts.TenScriptsExtension.scripts

Definition at line 19 of file tenscripts.py.

uitenscripts

tenscripts.tenscripts.TenScriptsExtension.uitenscripts

Definition at line 33 of file tenscripts.py.

---

The documentation for this class was generated from the following file:

• plugins/python/tenscripts/tenscripts.py