krita_script_starter.krita_script_starter.KritaScriptStarter Class Reference

Inheritance diagram for krita_script_starter.krita_script_starter.KritaScriptStarter:

Public Member Functions
	__init__ (self, parent)
	action_triggered (self)
	calculate_edit_text (self)
	calculate_file_names (self, text)
	cancel (self)
	create (self)
	createActions (self, window)
	name_change (self, text)
	setup (self)

Public Attributes
	action_triggered
	cancel
	class_name
	create
	desktop_fn
	files
	init_name
	manual_file
	name_change
	package_file
	package_name
	script_abs_path
	target_directory
	ui
	ui_file

Detailed Description

Definition at line 187 of file krita_script_starter.py.

Constructor & Destructor Documentation

__init__()

krita_script_starter.krita_script_starter.KritaScriptStarter.__init__	(		self,
			parent )

Definition at line 189 of file krita_script_starter.py.

    def __init__(self, parent):
        super().__init__(parent)
 

References krita_script_starter.krita_script_starter.KritaScriptStarter.__init__().

Member Function Documentation

action_triggered()

krita_script_starter.krita_script_starter.KritaScriptStarter.action_triggered

(

self

)

Definition at line 216 of file krita_script_starter.py.

    def action_triggered(self):
        self.ui.show()
        self.ui.activateWindow()
 

References KisVideoExportOptionsDialog.ui, VideoHDRMetadataOptionsDialog.ui, KisDelayedSaveDialog.ui, KisDlgHLGImport.ui, Contour.ui, Texture.ui, BevelAndEmboss.ui, BlendingOptions.ui, ColorOverlay.ui, DropShadow.ui, GradientOverlay.ui, InnerGlow.ui, PatternOverlay.ui, Satin.ui, Stroke.ui, StylesSelector.ui, KisDlgChangeCloneSource::Private.ui, KisDlgCustomTabletResolution.ui, KisRecoverNamedAutosaveDialog.ui, KisEditProfilesDialog::Private.ui, KisInputConfigurationPage.ui, KisInputConfigurationPageItem.ui, KisKeyInputEditor::Private.ui, KisMouseInputEditor::Private.ui, KisWheelInputEditor::Private.ui, KisPaintopPresetIconLibrary.ui, KisDlgListPicker.ui, KisLayerStyleAngleSelector.ui, KisProofingOptionsWidget::Private.ui, KoFillConfigWidget.ui, KoStrokeConfigWidget.ui, KisShortcutsEditorPrivate.ui, KisKShortcutWidgetPrivate.ui, KisColorSelectorSettings.ui, KisOnionSkinsDocker.ui, ArrangeDockerWidget.ui, KisDlgConfigureBrushHud.ui, GridConfigWidget.ui, RecorderExport::Private.ui, RecorderProfileSettings.ui, RecorderSnapshotsManager.ui, RecorderDockerDock::Private.ui, TouchDockerWidget.ui, krita.excepthook.ExceptHookDialog.ui, krita.sceditor.mainwindow.EditorMainWindow.ui, KisWdgConvertHeightToNormalMap.ui, KisWdgEdgeDetection.ui, KisHalftoneConfigPageWidget.ui(), KisHalftoneConfigPageWidget.ui(), KisWdgIndexColors.ui, KisMaskingBrushOption::Private.ui, krita_script_starter.krita_script_starter.KritaScriptStarter.ui, mixer_slider_docker.mixer_slider_docker.MixerSliderDocker.ui, ToolReferenceImagesWidget::Private.ui, KisToolLazyBrushOptionsWidget::Private.ui, and KisToolSmartPatchOptionsWidget::Private.ui.

calculate_edit_text()

krita_script_starter.krita_script_starter.KritaScriptStarter.calculate_edit_text

(

self

)

Determine if any of the intended files will collide with existing files.

Definition at line 381 of file krita_script_starter.py.

    def calculate_edit_text(self):
        """
       Determine if any of the intended files will collide with existing files.
 
        """
        conflict_template = "%s - FILE ALREADY EXISTS<p>"
        non_conflict_template = "%s<p>"
        file_conflict = False
 
        html = ["<h3>Will create the following files:</h3>"]
        for path in self.files:
            target_file = os.path.join(self.target_directory, path)
            if os.path.exists(path):
                html.append(conflict_template % target_file)
                file_conflict = True
            else:
                html.append(non_conflict_template % target_file)
 
        if file_conflict:
            html.append("""<h2><span style="color:red;font-weight:bold">
            Warning:</span></h2><p>
            <span style="color:red;font-weight:bold">
            One or more of the files to be created already exists.
            If you click "Create Script" those files will be deleted
            and new files created in their place.</span><p>""")
 
        return "\n".join(html)
 
 

References KisDlgImportImageSequence.files(), FileSystemWatcherWrapper.files(), KoResourceBundleManifest.files(), Folder.files, krita_script_starter.krita_script_starter.KritaScriptStarter.files, and krita_script_starter.krita_script_starter.KritaScriptStarter.target_directory.

calculate_file_names()

krita_script_starter.krita_script_starter.KritaScriptStarter.calculate_file_names	(		self,
			text )

Definition at line 351 of file krita_script_starter.py.

    def calculate_file_names(self, text):
        # name of class
 
        spam = text.split(" ")
        for i, s in enumerate(spam):
            s = s.strip()
            s = s.lower()
            try:
                spam[i] = s[0].upper()+s[1:]
            except IndexError:
                continue
        self.class_name = "".join(spam)
 
        # Normalise library name
        if TESTING:
            self.package_name = "bbdsss_"+text.lower().replace(" ", "_")
        else:
            self.package_name = text.lower().replace(" ", "_")
 
        # create desktop file
        self.desktop_fn = self.package_name+'.desktop'
 
        self.init_name = os.path.join(self.package_name, "__init__.py")
        self.package_file = os.path.join(
            self.package_name, self.package_name + ".py")
        self.manual_file = os.path.join(self.package_name, "Manual.html")
        self.files = [self.desktop_fn, self.init_name,
                      self.package_name, self.package_file,
                      self.manual_file]
 

cancel()

krita_script_starter.krita_script_starter.KritaScriptStarter.cancel

(

self

)

Definition at line 220 of file krita_script_starter.py.

    def cancel(self):
        self.ui.close()
 

References KisVideoExportOptionsDialog.ui, VideoHDRMetadataOptionsDialog.ui, KisDelayedSaveDialog.ui, KisDlgHLGImport.ui, Contour.ui, Texture.ui, BevelAndEmboss.ui, BlendingOptions.ui, ColorOverlay.ui, DropShadow.ui, GradientOverlay.ui, InnerGlow.ui, PatternOverlay.ui, Satin.ui, Stroke.ui, StylesSelector.ui, KisDlgChangeCloneSource::Private.ui, KisDlgCustomTabletResolution.ui, KisRecoverNamedAutosaveDialog.ui, KisEditProfilesDialog::Private.ui, KisInputConfigurationPage.ui, KisInputConfigurationPageItem.ui, KisKeyInputEditor::Private.ui, KisMouseInputEditor::Private.ui, KisWheelInputEditor::Private.ui, KisPaintopPresetIconLibrary.ui, KisDlgListPicker.ui, KisLayerStyleAngleSelector.ui, KisProofingOptionsWidget::Private.ui, KoFillConfigWidget.ui, KoStrokeConfigWidget.ui, KisShortcutsEditorPrivate.ui, KisKShortcutWidgetPrivate.ui, KisColorSelectorSettings.ui, KisOnionSkinsDocker.ui, ArrangeDockerWidget.ui, KisDlgConfigureBrushHud.ui, GridConfigWidget.ui, RecorderExport::Private.ui, RecorderProfileSettings.ui, RecorderSnapshotsManager.ui, RecorderDockerDock::Private.ui, TouchDockerWidget.ui, krita.excepthook.ExceptHookDialog.ui, krita.sceditor.mainwindow.EditorMainWindow.ui, KisWdgConvertHeightToNormalMap.ui, KisWdgEdgeDetection.ui, KisHalftoneConfigPageWidget.ui(), KisHalftoneConfigPageWidget.ui(), KisWdgIndexColors.ui, KisMaskingBrushOption::Private.ui, krita_script_starter.krita_script_starter.KritaScriptStarter.ui, mixer_slider_docker.mixer_slider_docker.MixerSliderDocker.ui, ToolReferenceImagesWidget::Private.ui, KisToolLazyBrushOptionsWidget::Private.ui, and KisToolSmartPatchOptionsWidget::Private.ui.

create()

krita_script_starter.krita_script_starter.KritaScriptStarter.create

(

self

)

Go ahead and create the relevant files. 

Definition at line 223 of file krita_script_starter.py.

    def create(self):
        """Go ahead and create the relevant files. """
 
        if self.ui.e_name_of_script.text().strip() == "":
            # Don't create script with empty name
            return
 
        def full_dir(path):
            # convenience function
            return os.path.join(self.target_directory, path)
 
        # should already be done, but just in case:
        self.calculate_file_names(self.ui.e_name_of_script.text())
 
        menu_entry = self.ui.e_menu_entry.text()
        if menu_entry.strip() == "":
            menu_entry = self.ui.e_name_of_script.text()
 
        comment = self.ui.e_comment.text()
        if comment.strip() == "":
            comment = "Replace this text with your description"
 
        values = {
            SCRIPT_NAME: self.ui.e_name_of_script.text(),
            SCRIPT_COMMENT: comment,
            KRITA_ID: "pykrita_" + self.package_name,
            SCRIPT_TYPE: SCRIPT_DOCKER if self.ui.rb_docker.isChecked() else SCRIPT_EXTENSION,  # noqa: E501
            MENU_ENTRY: menu_entry,
            LIBRARY_NAME: self.package_name,
            CLASS_NAME: self.class_name
        }
 
        try:
            # create package directory
            package_directory = full_dir(self.package_name)
            # needs to be lowercase and no spaces
            os.mkdir(package_directory)
        except FileExistsError:
            # if package directory exists write into it, overwriting
            # existing files.
            pass
 
        # create desktop file
        fn = full_dir(self.desktop_fn)
        with open(fn, 'w+t') as f:
            f.write(DESKTOP_TEMPLATE.format(**values))
 
        fn = full_dir(self.init_name)
        with open(fn, 'w+t') as f:
            if self.ui.rb_docker.isChecked():
                f.write(INIT_TEMPLATE_DOCKER.format(**values))
            else:
                f.write(INIT_TEMPLATE_EXTENSION.format(**values))
 
 
        # create main package file
        fn = full_dir(self.package_file)
 
        if self.ui.rb_docker.isChecked():
            with open(fn, 'w+t') as f:
                f.write(DOCKER_TEMPLATE.format(**values))
        else:
            # Default to extension type
            with open(fn, 'w+t') as f:
                f.write(EXTENSION_TEMPLATE.format(**values))
 
        # create manual file.
        fn = full_dir(self.manual_file)
        with open(fn, 'w+t') as f:
            f.write(MANUAL_TEMPLATE.format(**values))
        # enable script in krita settings (!)
 
        if self.ui.cb_enable_script.isChecked():
            Application.writeSetting(SCRIPT_SETTINGS, 'enable_'+self.package_name, 'true')
 
        # notify success
        # Assemble message
        title = "Krita Script files created"
        message = []
        message.append("<h3>Directory</h3>")
        message.append("Project files were created in the directory<p>%s"
                       % self.target_directory)
        message.append(
            "<h3>Files Created</h3>The following files were created:<p>")
        for f in self.files:
            message.append("%s<p>" % f)
        message.append("%s<p>" % self.manual_file)
        message.append("<h3>Location of script</h3>")
        message.append("Open this file to edit your script:<p>")
        script_path = os.path.join(self.target_directory, self.package_file)
        message.append("%s<p>" % script_path)
        message.append("Open this file to edit your Manual:<p>")
        script_path = os.path.join(self.target_directory, self.manual_file)
        message.append("%s<p>" % script_path)
        message.append("<h3>Record these locations</h3>")
        message.append(
            "Make a note of these locations before you click ok.<p>")
        message = "\n".join(message)
 
        # Display message box
        if CONTEXT_KRITA:
            msgbox = QMessageBox()
        else:
            msgbox = QMessageBox(self)
        msgbox.setWindowTitle(title)
        msgbox.setText(message)
        msgbox.setStandardButtons(QMessageBox.StandardButton.Ok)
        msgbox.setDefaultButton(QMessageBox.StandardButton.Ok)
        msgbox.setIcon(QMessageBox.Icon.Information)
        msgbox.exec()
 
        self.ui.close()
 

References krita_script_starter.krita_script_starter.KritaScriptStarter.calculate_file_names(), krita_script_starter.krita_script_starter.KritaScriptStarter.target_directory, KisVideoExportOptionsDialog.ui, VideoHDRMetadataOptionsDialog.ui, KisDelayedSaveDialog.ui, KisDlgHLGImport.ui, Contour.ui, Texture.ui, BevelAndEmboss.ui, BlendingOptions.ui, ColorOverlay.ui, DropShadow.ui, GradientOverlay.ui, InnerGlow.ui, PatternOverlay.ui, Satin.ui, Stroke.ui, StylesSelector.ui, KisDlgChangeCloneSource::Private.ui, KisDlgCustomTabletResolution.ui, KisRecoverNamedAutosaveDialog.ui, KisEditProfilesDialog::Private.ui, KisInputConfigurationPage.ui, KisInputConfigurationPageItem.ui, KisKeyInputEditor::Private.ui, KisMouseInputEditor::Private.ui, KisWheelInputEditor::Private.ui, KisPaintopPresetIconLibrary.ui, KisDlgListPicker.ui, KisLayerStyleAngleSelector.ui, KisProofingOptionsWidget::Private.ui, KoFillConfigWidget.ui, KoStrokeConfigWidget.ui, KisShortcutsEditorPrivate.ui, KisKShortcutWidgetPrivate.ui, KisColorSelectorSettings.ui, KisOnionSkinsDocker.ui, ArrangeDockerWidget.ui, KisDlgConfigureBrushHud.ui, GridConfigWidget.ui, RecorderExport::Private.ui, RecorderProfileSettings.ui, RecorderSnapshotsManager.ui, RecorderDockerDock::Private.ui, TouchDockerWidget.ui, krita.excepthook.ExceptHookDialog.ui, krita.sceditor.mainwindow.EditorMainWindow.ui, KisWdgConvertHeightToNormalMap.ui, KisWdgEdgeDetection.ui, KisHalftoneConfigPageWidget.ui(), KisHalftoneConfigPageWidget.ui(), KisWdgIndexColors.ui, KisMaskingBrushOption::Private.ui, krita_script_starter.krita_script_starter.KritaScriptStarter.ui, mixer_slider_docker.mixer_slider_docker.MixerSliderDocker.ui, ToolReferenceImagesWidget::Private.ui, KisToolLazyBrushOptionsWidget::Private.ui, and KisToolSmartPatchOptionsWidget::Private.ui.

createActions()

krita_script_starter.krita_script_starter.KritaScriptStarter.createActions	(		self,
			window )

 Called by Krita to create actions.

Definition at line 207 of file krita_script_starter.py.

    def createActions(self, window):
        """ Called by Krita to create actions."""
        action = window.createAction(
            MAIN_KRITA_ID, MAIN_KRITA_MENU_ENTRY, "tools/scripts")
        # parameter 1 = the name that Krita uses to identify the action
        # parameter 2 = the text to be added to the menu entry for this script
        # parameter 3 = location of menu entry
        action.triggered.connect(self.action_triggered)
 

name_change()

krita_script_starter.krita_script_starter.KritaScriptStarter.name_change	(		self,
			text )

name of script has changed,
* calculate consequential names
* update the e_files_display edit

Definition at line 336 of file krita_script_starter.py.

    def name_change(self, text):
        """
        name of script has changed,
        * calculate consequential names
        * update the e_files_display edit
        """
 
        text = text.strip()
        if len(text) == 0:
            return
 
        self.calculate_file_names(text)
        edit_text = self.calculate_edit_text()
        self.ui.e_files_display.setText(edit_text)
 

References krita_script_starter.krita_script_starter.KritaScriptStarter.calculate_edit_text(), krita_script_starter.krita_script_starter.KritaScriptStarter.calculate_file_names(), KisVideoExportOptionsDialog.ui, VideoHDRMetadataOptionsDialog.ui, KisDelayedSaveDialog.ui, KisDlgHLGImport.ui, Contour.ui, Texture.ui, BevelAndEmboss.ui, BlendingOptions.ui, ColorOverlay.ui, DropShadow.ui, GradientOverlay.ui, InnerGlow.ui, PatternOverlay.ui, Satin.ui, Stroke.ui, StylesSelector.ui, KisDlgChangeCloneSource::Private.ui, KisDlgCustomTabletResolution.ui, KisRecoverNamedAutosaveDialog.ui, KisEditProfilesDialog::Private.ui, KisInputConfigurationPage.ui, KisInputConfigurationPageItem.ui, KisKeyInputEditor::Private.ui, KisMouseInputEditor::Private.ui, KisWheelInputEditor::Private.ui, KisPaintopPresetIconLibrary.ui, KisDlgListPicker.ui, KisLayerStyleAngleSelector.ui, KisProofingOptionsWidget::Private.ui, KoFillConfigWidget.ui, KoStrokeConfigWidget.ui, KisShortcutsEditorPrivate.ui, KisKShortcutWidgetPrivate.ui, KisColorSelectorSettings.ui, KisOnionSkinsDocker.ui, ArrangeDockerWidget.ui, KisDlgConfigureBrushHud.ui, GridConfigWidget.ui, RecorderExport::Private.ui, RecorderProfileSettings.ui, RecorderSnapshotsManager.ui, RecorderDockerDock::Private.ui, TouchDockerWidget.ui, krita.excepthook.ExceptHookDialog.ui, krita.sceditor.mainwindow.EditorMainWindow.ui, KisWdgConvertHeightToNormalMap.ui, KisWdgEdgeDetection.ui, KisHalftoneConfigPageWidget.ui(), KisHalftoneConfigPageWidget.ui(), KisWdgIndexColors.ui, KisMaskingBrushOption::Private.ui, krita_script_starter.krita_script_starter.KritaScriptStarter.ui, mixer_slider_docker.mixer_slider_docker.MixerSliderDocker.ui, ToolReferenceImagesWidget::Private.ui, KisToolLazyBrushOptionsWidget::Private.ui, and KisToolSmartPatchOptionsWidget::Private.ui.

setup()

krita_script_starter.krita_script_starter.KritaScriptStarter.setup

(

self

)

Definition at line 192 of file krita_script_starter.py.

    def setup(self):
        self.script_abs_path = os.path.dirname(os.path.realpath(__file__))
        self.ui_file = os.path.join(self.script_abs_path, UI_FILE)
        self.ui = load_ui(self.ui_file)
 
        self.ui.e_name_of_script.textChanged.connect(self.name_change)
        self.ui.cancel_button.clicked.connect(self.cancel)
        self.ui.create_button.clicked.connect(self.create)
 
        target_directory = Krita.instance().getAppDataLocation()
        if not CONTEXT_KRITA:
            target_directory = os.path.join(target_directory, "krita")
        target_directory = os.path.join(target_directory, "pykrita")
        self.target_directory = target_directory
 

Member Data Documentation

action_triggered

krita_script_starter.krita_script_starter.KritaScriptStarter.action_triggered

Definition at line 214 of file krita_script_starter.py.

cancel

krita_script_starter.krita_script_starter.KritaScriptStarter.cancel

Definition at line 198 of file krita_script_starter.py.

class_name

krita_script_starter.krita_script_starter.KritaScriptStarter.class_name

Definition at line 362 of file krita_script_starter.py.

create

krita_script_starter.krita_script_starter.KritaScriptStarter.create

Definition at line 199 of file krita_script_starter.py.

desktop_fn

krita_script_starter.krita_script_starter.KritaScriptStarter.desktop_fn

Definition at line 371 of file krita_script_starter.py.

files

krita_script_starter.krita_script_starter.KritaScriptStarter.files

Definition at line 377 of file krita_script_starter.py.

init_name

krita_script_starter.krita_script_starter.KritaScriptStarter.init_name

Definition at line 373 of file krita_script_starter.py.

manual_file

krita_script_starter.krita_script_starter.KritaScriptStarter.manual_file

Definition at line 309 of file krita_script_starter.py.

name_change

krita_script_starter.krita_script_starter.KritaScriptStarter.name_change

Definition at line 197 of file krita_script_starter.py.

package_file

krita_script_starter.krita_script_starter.KritaScriptStarter.package_file

Definition at line 374 of file krita_script_starter.py.

package_name

krita_script_starter.krita_script_starter.KritaScriptStarter.package_name

Definition at line 248 of file krita_script_starter.py.

script_abs_path

krita_script_starter.krita_script_starter.KritaScriptStarter.script_abs_path

Definition at line 193 of file krita_script_starter.py.

target_directory

krita_script_starter.krita_script_starter.KritaScriptStarter.target_directory

Definition at line 205 of file krita_script_starter.py.

ui

krita_script_starter.krita_script_starter.KritaScriptStarter.ui

Definition at line 195 of file krita_script_starter.py.

ui_file

krita_script_starter.krita_script_starter.KritaScriptStarter.ui_file

Definition at line 194 of file krita_script_starter.py.

---

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

• plugins/python/krita_script_starter/krita_script_starter.py