Inheritance diagram for scripter.uicontroller.UIController:

Public Member Functions
	__init__ (self)

	addMenu (self, menuName, parentName)

	clearEditor (self)

	closeScripter (self)

	findTabWidget (self, widgetName, childName='')

	initialize (self, scripter)

	invokeAction (self, actionName)

	loadActions (self)

	loadMenus (self)

	loadWidgets (self)

	repaintDebugArea (self)

	setActiveWidget (self, widgetName)

	setDocumentEditor (self, document)

	setStatusBar (self, value='untitled')

	setStatusModified (self)

	setStepped (self, status)

	showException (self, exception)

Public Attributes
	actions

	actionToolbar

	documentModifiedText

	documentStatusBarText

	editor

	highlight

	mainWidget

	menu_bar

	newMenu

	scripter

	setStatusModified

	splitter

	statusBar

	tabWidget

Static Public Attributes
str	documentModifiedText = ""

str	documentStatusBarText = "untitled"

Protected Member Functions
	_readSettings (self)

	_saveSettings (self)

	_writeSettings (self)

Detailed Description

Definition at line 52 of file uicontroller.py.

Constructor & Destructor Documentation

◆ init()

scripter.uicontroller.UIController.__init__ ( self )

Definition at line 56 of file uicontroller.py.

    def __init__(self):
        self.mainWidget = scripterdialog.ScripterDialog(self)
        self.actionToolbar = QToolBar('toolBar', self.mainWidget)
        self.menu_bar = QMenuBar(self.mainWidget)
 
        self.actionToolbar.setObjectName('toolBar')
        self.menu_bar.setObjectName('menuBar')
 
        self.actions = []
 
        self.mainWidget.setWindowModality(Qt.WindowModality.NonModal)
 

Member Function Documentation

◆ _readSettings()

scripter.uicontroller.UIController._readSettings ( self )

protected

 It's similar to _writeSettings, but reading the settings when the ScripterDialog is closed.

Definition at line 239 of file uicontroller.py.

    def _readSettings(self):
        """ It's similar to _writeSettings, but reading the settings when the ScripterDialog is closed. """
 
        self.scripter.settings.beginGroup('scripter')
 
        activeDocumentPath = self.scripter.settings.value('activeDocumentPath', '')
 
        if activeDocumentPath:
            if QFileInfo(activeDocumentPath).exists():
                document = self.scripter.documentcontroller.openDocument(activeDocumentPath)
                self.setStatusBar(document.filePath)
                self.setDocumentEditor(document)
 
        for action in self.actions:
            readSettings = getattr(action['action'], "readSettings", None)
            if callable(readSettings):
                readSettings()
 
        pointSize = self.scripter.settings.value('editorFontSize', str(self.editor.fontInfo().pointSize()))
        self.editor.setFontSize(int(pointSize))
 
        # Window Geometry
        rect = self.scripter.settings.value(KEY_GEOMETRY, DEFAULT_GEOMETRY)
        self.mainWidget.setGeometry(rect)
 
        self.scripter.settings.endGroup()
 

◆ _saveSettings()

scripter.uicontroller.UIController._saveSettings ( self )

protected

Definition at line 266 of file uicontroller.py.

266 def _saveSettings(self):

267 self.scripter.settings.sync()

◆ _writeSettings()

scripter.uicontroller.UIController._writeSettings ( self )

protected

 _writeSettings is a method invoked when the scripter starts, making
    control inversion. Actions can implement a writeSettings method to
    save your own settings without this method to know about it.

Definition at line 213 of file uicontroller.py.

    def _writeSettings(self):
        """ _writeSettings is a method invoked when the scripter starts, making
            control inversion. Actions can implement a writeSettings method to
            save your own settings without this method to know about it. """
 
        self.scripter.settings.beginGroup('scripter')
 
        document = self.scripter.documentcontroller.activeDocument
        if document:
            self.scripter.settings.setValue('activeDocumentPath', document.filePath)
        else:
            self.scripter.settings.setValue('activeDocumentPath', '')
 
        self.scripter.settings.setValue('editorFontSize', self.editor.fontInfo().pointSize())
 
        for action in self.actions:
            writeSettings = getattr(action['action'], "writeSettings", None)
            if callable(writeSettings):
                writeSettings()
 
        #  Window Geometry
        rect = self.mainWidget.geometry()
        self.scripter.settings.setValue(KEY_GEOMETRY, rect)
 
        self.scripter.settings.endGroup()
 

◆ addMenu()

scripter.uicontroller.UIController.addMenu	(	self,
		menuName,
		parentName )

Definition at line 107 of file uicontroller.py.

    def addMenu(self, menuName, parentName):
        parent = self.menu_bar.findChild(QObject, parentName)
        self.newMenu = None
 
        if parent:
            self.newMenu = parent.addMenu(menuName)
        else:
            self.newMenu = self.menu_bar.addMenu(menuName)
 
        self.newMenu.setObjectName(menuName)
 
        return self.newMenu
 

References scripter.uicontroller.UIController.menu_bar.

◆ clearEditor()

scripter.uicontroller.UIController.clearEditor ( self )

Definition at line 204 of file uicontroller.py.

    def clearEditor(self):
        self.editor.clear()
 

References krita.sceditor.indenter.TextIndenter.editor, krita.sceditor.widget.EditorSidebar.editor, scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.editor, scripter.ui_scripter.actions.runaction.runaction.RunAction.editor, scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.editor, scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.editor, scripter.ui_scripter.actions.settingsaction.fontscombobox.FontsComboBox.editor, scripter.ui_scripter.actions.settingsaction.syntaxstylescombobox.SyntaxStylesComboBox.editor, and scripter.uicontroller.UIController.editor.

◆ closeScripter()

scripter.uicontroller.UIController.closeScripter ( self )

Definition at line 210 of file uicontroller.py.

    def closeScripter(self):
        self.mainWidget.close()
 

References KoDialog.mainWidget(), krita.sceditor.dockwidget.DockWidget.mainWidget, photobash_images.photobash_images_docker.PhotobashDocker.mainWidget, and scripter.uicontroller.UIController.mainWidget.

◆ findTabWidget()

scripter.uicontroller.UIController.findTabWidget	(	self,
		widgetName,
		childName = '' )

Definition at line 167 of file uicontroller.py.

    def findTabWidget(self, widgetName, childName=''):
        for index in range(self.tabWidget.count()):
            widget = self.tabWidget.widget(index)
            if widget.objectName() == widgetName:
                if childName:
                    widget = widget.findChild(QObject, childName)
                return widget
 

References scripter.uicontroller.UIController.tabWidget.

◆ initialize()

scripter.uicontroller.UIController.initialize	(		self,
			scripter )

Definition at line 68 of file uicontroller.py.

    def initialize(self, scripter):
        self.editor = pythoneditor.CodeEditor(scripter)
        self.tabWidget = QTabWidget()
        self.statusBar = Elided_Text_Label()
        self.statusBar.setMainText('untitled')
        self.splitter = QSplitter()
        self.splitter.setOrientation(Qt.Orientation.Vertical)
        self.highlight = syntax.PythonHighlighter(self.editor.document(), syntaxstyles.DefaultSyntaxStyle())
        p = self.editor.palette()
        p.setColor(QPalette.ColorRole.Base, syntaxstyles.DefaultSyntaxStyle()['background'].foreground().color())
        p.setColor(QPalette.ColorRole.Text, syntaxstyles.DefaultSyntaxStyle()['foreground'].foreground().color())
        self.editor.setPalette(p)
 
        utils.setNeedDarkIcon(self.mainWidget.palette().window().color())
        self.scripter = scripter
 
        self.loadMenus()
        self.loadWidgets()
        self.loadActions()
        self._readSettings()  # sets window size
 
        vbox = QVBoxLayout(self.mainWidget)
        vbox.addWidget(self.menu_bar)
        vbox.addWidget(self.actionToolbar)
        self.splitter.addWidget(self.editor)
        self.splitter.addWidget(self.tabWidget)
        vbox.addWidget(self.splitter)
        vbox.addWidget(self.statusBar)
 
        self.mainWidget.setWindowTitle(i18n("Scripter"))
        self.mainWidget.setSizeGripEnabled(True)
        self.mainWidget.show()
        self.mainWidget.activateWindow()
 
        self.editor.undoAvailable.connect(self.setStatusModified)
 

◆ invokeAction()

scripter.uicontroller.UIController.invokeAction	(		self,
			actionName )

Definition at line 160 of file uicontroller.py.

    def invokeAction(self, actionName):
        for action in self.actions:
            if action['action'].objectName() == actionName:
                method = getattr(action['action'], actionName)
                if method:
                    return method()
 

References Krita.actions(), KisInputProfileManager.actions, KisInputProfileManager.actions(), KisActionManager.actions, KisKActionCategoryPrivate.actions, KisKActionCollectionPrivate.actions, KisKMainWindowInterface.actions(), KDEPrivate::ToolBarHandler::Private.actions, KisKXMLGUI::ContainerClient.actions, TasksetModel.actions(), KisKActionCategory.actions(), KisKActionCollection.actions(), scriptdocker.scriptdocker.ScriptDocker.actions, scripter.uicontroller.UIController.actions, and SvgTextCursor.actions.

◆ loadActions()

scripter.uicontroller.UIController.loadActions ( self )

Definition at line 120 of file uicontroller.py.

    def loadActions(self):
        module_path = 'scripter.ui_scripter.actions'
        actions_module = importlib.import_module(module_path)
        modules = []
 
        for class_path in actions_module.action_classes:
            _module = class_path[:class_path.rfind(".")]
            _klass = class_path[class_path.rfind(".") + 1:]
            modules.append(dict(module='{0}.{1}'.format(module_path, _module),
                                klass=_klass))
 
        for module in modules:
            m = importlib.import_module(module['module'])
            action_class = getattr(m, module['klass'])
            obj = action_class(self.scripter)
            obj_parent = obj.parent
            for name in obj_parent:
                parent = self.mainWidget.findChild(QObject, i18n(name))
                self.actions.append(dict(action=obj, parent=parent))
 
        for action in self.actions:
            action['parent'].addAction(action['action'])
 

◆ loadMenus()

scripter.uicontroller.UIController.loadMenus ( self )

Definition at line 104 of file uicontroller.py.

    def loadMenus(self):
        self.addMenu(i18n('File'), i18n('File'))
 

References scripter.uicontroller.UIController.addMenu().

◆ loadWidgets()

scripter.uicontroller.UIController.loadWidgets ( self )

Definition at line 143 of file uicontroller.py.

    def loadWidgets(self):
        modulePath = 'scripter.ui_scripter.tabwidgets'
        widgetsModule = importlib.import_module(modulePath)
        modules = []
 
        for class_path in widgetsModule.widgetClasses:
            _module = class_path[:class_path.rfind(".")]
            _klass = class_path[class_path.rfind(".") + 1:]
            modules.append(dict(module='{0}.{1}'.format(modulePath, _module),
                                klass=_klass))
 
        for module in modules:
            m = importlib.import_module(module['module'])
            widgetClass = getattr(m, module['klass'])
            obj = widgetClass(self.scripter)
            self.tabWidget.addTab(obj, obj.objectName())
 

◆ repaintDebugArea()

scripter.uicontroller.UIController.repaintDebugArea ( self )

Definition at line 207 of file uicontroller.py.

    def repaintDebugArea(self):
        self.editor.repaintDebugArea()
 

References krita.sceditor.indenter.TextIndenter.editor, krita.sceditor.widget.EditorSidebar.editor, scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.editor, scripter.ui_scripter.actions.runaction.runaction.RunAction.editor, scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.editor, scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.editor, scripter.ui_scripter.actions.settingsaction.fontscombobox.FontsComboBox.editor, scripter.ui_scripter.actions.settingsaction.syntaxstylescombobox.SyntaxStylesComboBox.editor, scripter.uicontroller.UIController.editor, and scripter.uicontroller.UIController.repaintDebugArea().

◆ setActiveWidget()

scripter.uicontroller.UIController.setActiveWidget	(		self,
			widgetName )

Definition at line 195 of file uicontroller.py.

    def setActiveWidget(self, widgetName):
        widget = self.findTabWidget(widgetName)
 
        if widget:
            self.tabWidget.setCurrentWidget(widget)
 

References scripter.uicontroller.UIController.findTabWidget(), and scripter.uicontroller.UIController.tabWidget.

◆ setDocumentEditor()

scripter.uicontroller.UIController.setDocumentEditor	(		self,
			document )

Definition at line 178 of file uicontroller.py.

    def setDocumentEditor(self, document):
        self.editor.clear()
        self.editor.moveCursor(QTextCursor.MoveOperation.Start)
        self.editor._documentModified = False
        self.editor.setPlainText(document.data)
        self.editor.moveCursor(QTextCursor.MoveOperation.End)
 

References krita.sceditor.indenter.TextIndenter.editor, krita.sceditor.widget.EditorSidebar.editor, scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.editor, scripter.ui_scripter.actions.runaction.runaction.RunAction.editor, scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.editor, scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.editor, scripter.ui_scripter.actions.settingsaction.fontscombobox.FontsComboBox.editor, scripter.ui_scripter.actions.settingsaction.syntaxstylescombobox.SyntaxStylesComboBox.editor, and scripter.uicontroller.UIController.editor.

◆ setStatusBar()

scripter.uicontroller.UIController.setStatusBar	(		self,
			value = 'untitled' )

Definition at line 185 of file uicontroller.py.

    def setStatusBar(self, value='untitled'):
        self.documentStatusBarText = value
        self.statusBar.setMainText(self.documentStatusBarText + self.documentModifiedText)
 

◆ setStatusModified()

scripter.uicontroller.UIController.setStatusModified ( self )

Definition at line 189 of file uicontroller.py.

    def setStatusModified(self):
        self.documentModifiedText = ""
        if (self.editor._documentModified is True):
            self.documentModifiedText = " [Modified]"
        self.statusBar.setMainText(self.documentStatusBarText + self.documentModifiedText)
 

References scripter.uicontroller.UIController.documentModifiedText, scripter.uicontroller.UIController.documentStatusBarText, krita.sceditor.indenter.TextIndenter.editor, krita.sceditor.widget.EditorSidebar.editor, scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.editor, scripter.ui_scripter.actions.runaction.runaction.RunAction.editor, scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.editor, scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.editor, scripter.ui_scripter.actions.settingsaction.fontscombobox.FontsComboBox.editor, scripter.ui_scripter.actions.settingsaction.syntaxstylescombobox.SyntaxStylesComboBox.editor, scripter.uicontroller.UIController.editor, KisView.statusBar(), KisViewManager::KisViewManagerPrivate.statusBar, KisViewManager.statusBar(), and scripter.uicontroller.UIController.statusBar.

◆ setStepped()

scripter.uicontroller.UIController.setStepped	(		self,
			status )

Definition at line 201 of file uicontroller.py.

    def setStepped(self, status):
        self.editor.setStepped(status)
 

References krita.sceditor.indenter.TextIndenter.editor, krita.sceditor.widget.EditorSidebar.editor, scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.editor, scripter.ui_scripter.actions.runaction.runaction.RunAction.editor, scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.editor, scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.editor, scripter.ui_scripter.actions.settingsaction.fontscombobox.FontsComboBox.editor, scripter.ui_scripter.actions.settingsaction.syntaxstylescombobox.SyntaxStylesComboBox.editor, scripter.uicontroller.UIController.editor, and scripter.uicontroller.UIController.setStepped().

◆ showException()

scripter.uicontroller.UIController.showException	(		self,
			exception )

Definition at line 175 of file uicontroller.py.

    def showException(self, exception):
        QMessageBox.critical(self.editor, i18n("Error Running Script"), str(exception))
 

References krita.sceditor.indenter.TextIndenter.editor, krita.sceditor.widget.EditorSidebar.editor, scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.editor, scripter.ui_scripter.actions.runaction.runaction.RunAction.editor, scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.editor, scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.editor, scripter.ui_scripter.actions.settingsaction.fontscombobox.FontsComboBox.editor, scripter.ui_scripter.actions.settingsaction.syntaxstylescombobox.SyntaxStylesComboBox.editor, and scripter.uicontroller.UIController.editor.

Member Data Documentation

◆ actions

scripter.uicontroller.UIController.actions

Definition at line 64 of file uicontroller.py.

◆ actionToolbar

scripter.uicontroller.UIController.actionToolbar

Definition at line 58 of file uicontroller.py.

◆ documentModifiedText [1/2]

str scripter.uicontroller.UIController.documentModifiedText = ""

static

Definition at line 53 of file uicontroller.py.

◆ documentModifiedText [2/2]

scripter.uicontroller.UIController.documentModifiedText

Definition at line 187 of file uicontroller.py.

◆ documentStatusBarText [1/2]

str scripter.uicontroller.UIController.documentStatusBarText = "untitled"

static

Definition at line 54 of file uicontroller.py.

◆ documentStatusBarText [2/2]

scripter.uicontroller.UIController.documentStatusBarText

Definition at line 186 of file uicontroller.py.

◆ editor

scripter.uicontroller.UIController.editor

Definition at line 69 of file uicontroller.py.

◆ highlight

scripter.uicontroller.UIController.highlight

Definition at line 75 of file uicontroller.py.

◆ mainWidget

scripter.uicontroller.UIController.mainWidget

Definition at line 57 of file uicontroller.py.

◆ menu_bar

scripter.uicontroller.UIController.menu_bar

Definition at line 59 of file uicontroller.py.

◆ newMenu

scripter.uicontroller.UIController.newMenu

Definition at line 109 of file uicontroller.py.

◆ scripter

scripter.uicontroller.UIController.scripter

Definition at line 82 of file uicontroller.py.

◆ setStatusModified

scripter.uicontroller.UIController.setStatusModified

Definition at line 102 of file uicontroller.py.

◆ splitter

scripter.uicontroller.UIController.splitter

Definition at line 73 of file uicontroller.py.

◆ statusBar

scripter.uicontroller.UIController.statusBar

Definition at line 71 of file uicontroller.py.

◆ tabWidget

scripter.uicontroller.UIController.tabWidget

Definition at line 70 of file uicontroller.py.

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

plugins/python/scripter/uicontroller.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _readSettings()

◆ _saveSettings()

◆ _writeSettings()

◆ addMenu()

◆ clearEditor()

◆ closeScripter()

◆ findTabWidget()

◆ initialize()

◆ invokeAction()

◆ loadActions()

◆ loadMenus()

◆ loadWidgets()

◆ repaintDebugArea()

◆ setActiveWidget()

◆ setDocumentEditor()

◆ setStatusBar()

◆ setStatusModified()

◆ setStepped()

◆ showException()

Member Data Documentation

◆ actions

◆ actionToolbar

◆ documentModifiedText [1/2]

◆ documentModifiedText [2/2]

◆ documentStatusBarText [1/2]

◆ documentStatusBarText [2/2]

◆ editor

◆ highlight

◆ mainWidget

◆ menu_bar

◆ newMenu

◆ scripter

◆ setStatusModified

◆ splitter

◆ statusBar

◆ tabWidget

◆ init()