Public Member Functions
	__init__ (self)

	showDialog (self)

	slot_edit_meta_data (self)

	slot_generate (self)

	slot_update_countries (self)

	writeConfig (self)

Static Public Attributes
str	projectDirectory = ""

dict	setupDictionary = {}

Detailed Description

Definition at line 32 of file comics_project_setup_wizard.py.

Constructor & Destructor Documentation

◆ init()

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.__init__ ( self )

Definition at line 36 of file comics_project_setup_wizard.py.

    def __init__(self):
        # super().__init__(parent)
        # Search the location of the script for the two lists that are used with the projectname generator.
        mainP = Path(__file__).parent
        self.generateListA = []
        self.generateListB = []
        if Path(mainP / "projectGenLists" / "listA.txt").exists():
            for l in open(str(mainP / "projectGenLists" / "listA.txt"), "r"):
                if l.isspace() == False:
                    self.generateListA.append(l.strip("\n"))
        if Path(mainP / "projectGenLists" / "listB.txt").exists():
            for l in open(str(mainP / "projectGenLists" / "listB.txt"), "r"):
                if l.isspace() == False:
                    self.generateListB.append(l.strip("\n"))
 

Member Function Documentation

◆ showDialog()

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.showDialog ( self )

Definition at line 51 of file comics_project_setup_wizard.py.

    def showDialog(self):
        # Initialise the setup directory empty toavoid exceptions.
        self.setupDictionary = {}
 
        # ask for a project directory.
        self.projectDirectory = None
        
        while self.projectDirectory == None:
            self.projectDirectory = FileDialog.getExistingDirectory(caption=i18n("Where should the comic project go?"))
            if os.path.exists(self.projectDirectory) is False:
                return
            if os.access(self.projectDirectory, os.W_OK) is False:
                QMessageBox.warning(None, i18n("Folder cannot be used"), i18n("Krita doesn't have write access to this folder, so files cannot be made. Please choose a different folder."), QMessageBox.StandardButton.Ok)
                self.projectDirectory = None
        self.pagesDirectory = os.path.relpath(self.projectDirectory, self.projectDirectory)
        self.exportDirectory = os.path.relpath(self.projectDirectory, self.projectDirectory)
 
        wizard = QWizard()
        wizard.setWindowTitle(i18n("Comic Project Setup"))
        wizard.setOption(QWizard.WizardOption.IndependentPages, True)
        wizard.setWizardStyle(QWizard.WizardStyle.ClassicStyle)
 
        # Set up the UI for the wizard
        basicsPage = QWizardPage()
        basicsPage.setTitle(i18n("Basic Comic Project Settings"))
        formLayout = QFormLayout()
        basicsPage.setLayout(formLayout)
        projectLayout = QHBoxLayout()
        self.lnProjectName = QLineEdit()
        basicsPage.registerField("Project Name*", self.lnProjectName)
        self.lnProjectName.setToolTip(i18n("A Project name. This can be different from the eventual title"))
        btnRandom = QPushButton()
        btnRandom.setText(i18n("Generate"))
        btnRandom.setToolTip(i18n("If you cannot come up with a project name, our highly sophisticated project name generator will serve to give a classy yet down to earth name."))
        btnRandom.clicked.connect(self.slot_generate)
        projectLayout.addWidget(self.lnProjectName)
        projectLayout.addWidget(btnRandom)
        lnConcept = QLineEdit()
        lnConcept.setToolTip(i18n("What is your comic about? This is mostly for your own convenience so do not worry about what it says too much."))
        self.cmbLanguage = comics_metadata_dialog.language_combo_box()
        self.cmbLanguage.setToolTip(i18n("The main language the comic is in"))
        self.cmbLanguage.setEntryToCode(str(QLocale.system().name()).split("_")[0])
        self.cmbCountry = comics_metadata_dialog.country_combo_box()
        if QLocale.system() != QLocale.c():
            self.slot_update_countries()
            self.cmbCountry.setEntryToCode(str(QLocale.system().name()).split("_")[-1])
        else:
            self.cmbLanguage.setEntryToCode("en")
            self.slot_update_countries()
            self.cmbCountry.setEntryToCode("US")
        self.cmbLanguage.currentIndexChanged.connect(self.slot_update_countries)
        self.lnProjectDirectory = QLabel(self.projectDirectory)
        self.chkMakeProjectDirectory = QCheckBox()
        labelDirectory = QLabel(i18n("Make a new directory with the project name."))
        labelDirectory.setWordWrap(True)
        stringDirectoryTooltip = i18n("This allows you to select a generic comics project directory, in which a new folder will be made for the project using the given project name.")
        self.chkMakeProjectDirectory.setToolTip(stringDirectoryTooltip)
        labelDirectory.setToolTip(stringDirectoryTooltip)
        self.chkMakeProjectDirectory.setChecked(True)
        self.lnPagesDirectory = QLineEdit()
        self.lnPagesDirectory.setText(i18n("pages"))
        self.lnPagesDirectory.setToolTip(i18n("The name for the folder where the pages are contained. If it does not exist, it will be created."))
        self.lnExportDirectory = QLineEdit()
        self.lnExportDirectory.setText(i18n("export"))
        self.lnExportDirectory.setToolTip(i18n("The name for the folder where the export is put. If it does not exist, it will be created."))
        self.lnTemplateLocation = QLineEdit()
        self.lnTemplateLocation.setText(i18n("templates"))
        self.lnTemplateLocation.setToolTip(i18n("The name for the folder where the page templates are sought in."))
 
        self.lnTranslationLocation = QLineEdit()
        self.lnTranslationLocation.setText(i18n("translations"))
        self.lnTranslationLocation.setToolTip("This is the location that POT files will be stored to and PO files will be read from.")
        formLayout.addRow(i18n("Comic concept:"), lnConcept)
        formLayout.addRow(i18n("Project name:"), projectLayout)
        formLayout.addRow(i18n("Main language:"), self.cmbLanguage)
        formLayout.addRow("", self.cmbCountry)
 
        buttonMetaData = QPushButton(i18n("Meta Data"))
        buttonMetaData.clicked.connect(self.slot_edit_meta_data)
 
        wizard.addPage(basicsPage)
 
        foldersPage = QWizardPage()
        foldersPage.setTitle(i18n("Folder names and other."))
        folderFormLayout = QFormLayout()
        foldersPage.setLayout(folderFormLayout)
        folderFormLayout.addRow(i18n("Project directory:"), self.lnProjectDirectory)
        folderFormLayout.addRow(self.chkMakeProjectDirectory, labelDirectory)
        folderFormLayout.addRow(i18n("Pages directory"), self.lnPagesDirectory)
        folderFormLayout.addRow(i18n("Export directory"), self.lnExportDirectory)
        folderFormLayout.addRow(i18n("Template directory"), self.lnTemplateLocation)
        folderFormLayout.addRow(i18n("Translation directory"), self.lnTranslationLocation)
        folderFormLayout.addRow("", buttonMetaData)
        wizard.addPage(foldersPage)
 
        # Execute the wizard, and after wards...
        if (wizard.exec()):
 
            # First get the directories, check if the directories exist, and otherwise make them.
            self.pagesDirectory = self.lnPagesDirectory.text()
            self.exportDirectory = self.lnExportDirectory.text()
            self.templateLocation = self.lnTemplateLocation.text()
            self.translationLocation = self.lnTranslationLocation.text()
            projectPath = Path(self.projectDirectory)
            
            # Only make a project directory if the checkbox for that has been checked.
            if self.chkMakeProjectDirectory.isChecked():
                projectPath = projectPath / self.lnProjectName.text()
                if projectPath.exists() is False:
                    projectPath.mkdir()
                self.projectDirectory = str(projectPath)
            if Path(projectPath / self.pagesDirectory).exists() is False:
                Path(projectPath / self.pagesDirectory).mkdir()
            if Path(projectPath / self.exportDirectory).exists() is False:
                Path(projectPath / self.exportDirectory).mkdir()
            if Path(projectPath / self.templateLocation).exists() is False:
                Path(projectPath / self.templateLocation).mkdir()
            if Path(projectPath / self.translationLocation).exists() is False:
                Path(projectPath / self.translationLocation).mkdir()
 
            # Then store the information into the setup diactionary.
            self.setupDictionary["projectName"] = self.lnProjectName.text()
            self.setupDictionary["concept"] = lnConcept.text()
            self.setupDictionary["language"] = str(self.cmbLanguage.codeForCurrentEntry())
            self.setupDictionary["pagesLocation"] = self.pagesDirectory
            self.setupDictionary["exportLocation"] = self.exportDirectory
            self.setupDictionary["templateLocation"] = self.templateLocation
            self.setupDictionary["translationLocation"] = self.translationLocation
            self.setupDictionary["uuid"] = QUuid.createUuid().toString()
 
            # Finally, write the dictionary into the json file.
            self.writeConfig()

◆ slot_edit_meta_data()

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.slot_edit_meta_data ( self )

Definition at line 189 of file comics_project_setup_wizard.py.

    def slot_edit_meta_data(self):
        dialog = comics_metadata_dialog.comic_meta_data_editor()
        self.setupDictionary["language"] = str(self.cmbLanguage.codeForCurrentEntry())
        dialog.setConfig(self.setupDictionary)
        dialog.setConfig(self.setupDictionary)
        if (dialog.exec() == QDialog.DialogCode.Accepted):
            self.setupDictionary = dialog.getConfig(self.setupDictionary)
            self.cmbLanguage.setEntryToCode(self.setupDictionary["language"])
            

References comics_project_management_tools.comics_metadata_dialog.comic_meta_data_editor.cmbLanguage, comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.cmbLanguage, comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.setupDictionary, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary, and comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary.

◆ slot_generate()

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.slot_generate ( self )

Definition at line 224 of file comics_project_setup_wizard.py.

    def slot_generate(self):
        if len(self.generateListA) > 0 and len(self.generateListB) > 0:
            nameA = self.generateListA[random.randint(0, len(self.generateListA) - 1)]
            nameB = self.generateListB[random.randint(0, len(self.generateListB) - 1)]
            self.lnProjectName.setText(str(nameA.title() + nameB.title()))

References comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.generateListA, comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.generateListB, comics_project_management_tools.comics_project_settings_dialog.comics_project_details_editor.lnProjectName, and comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.lnProjectName.

◆ slot_update_countries()

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.slot_update_countries ( self )

Definition at line 202 of file comics_project_setup_wizard.py.

    def slot_update_countries(self):
        code = self.cmbLanguage.codeForCurrentEntry()
        self.cmbCountry.set_country_for_locale(code)
        

References comics_project_management_tools.comics_metadata_dialog.comic_meta_data_editor.cmbCountry, comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.cmbCountry, comics_project_management_tools.comics_metadata_dialog.comic_meta_data_editor.cmbLanguage, and comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.cmbLanguage.

◆ writeConfig()

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.writeConfig ( self )

Definition at line 210 of file comics_project_setup_wizard.py.

    def writeConfig(self):
        print("CPMT: writing comic configuration...")
        print(self.projectDirectory)
        configFile = open(os.path.join(self.projectDirectory, "comicConfig.json"), "w", newline="", encoding="utf-16")
        json.dump(self.setupDictionary, configFile, indent=4, sort_keys=True, ensure_ascii=False)
        configFile.close()
        print("CPMT: done")

References comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.projectDirectory, comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.setupDictionary, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary, and comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary.

Member Data Documentation

◆ chkMakeProjectDirectory

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.chkMakeProjectDirectory

Definition at line 103 of file comics_project_setup_wizard.py.

◆ cmbCountry

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.cmbCountry

Definition at line 93 of file comics_project_setup_wizard.py.

◆ cmbLanguage

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.cmbLanguage

Definition at line 90 of file comics_project_setup_wizard.py.

◆ exportDirectory

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.exportDirectory

Definition at line 66 of file comics_project_setup_wizard.py.

◆ generateListA

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.generateListA

Definition at line 40 of file comics_project_setup_wizard.py.

◆ generateListB

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.generateListB

Definition at line 41 of file comics_project_setup_wizard.py.

◆ lnExportDirectory

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.lnExportDirectory

Definition at line 113 of file comics_project_setup_wizard.py.

◆ lnPagesDirectory

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.lnPagesDirectory

Definition at line 110 of file comics_project_setup_wizard.py.

◆ lnProjectDirectory

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.lnProjectDirectory

Definition at line 102 of file comics_project_setup_wizard.py.

◆ lnProjectName

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.lnProjectName

Definition at line 79 of file comics_project_setup_wizard.py.

◆ lnTemplateLocation

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.lnTemplateLocation

Definition at line 116 of file comics_project_setup_wizard.py.

◆ lnTranslationLocation

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.lnTranslationLocation

Definition at line 120 of file comics_project_setup_wizard.py.

◆ pagesDirectory

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.pagesDirectory

Definition at line 65 of file comics_project_setup_wizard.py.

◆ projectDirectory [1/2]

str comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.projectDirectory = ""

static

Definition at line 34 of file comics_project_setup_wizard.py.

◆ projectDirectory [2/2]

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.projectDirectory

Definition at line 56 of file comics_project_setup_wizard.py.

◆ setupDictionary [1/2]

dict comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary = {}

static

Definition at line 33 of file comics_project_setup_wizard.py.

◆ setupDictionary [2/2]

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary

Definition at line 53 of file comics_project_setup_wizard.py.

◆ slot_edit_meta_data

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.slot_edit_meta_data

Definition at line 129 of file comics_project_setup_wizard.py.

◆ slot_generate

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.slot_generate

Definition at line 85 of file comics_project_setup_wizard.py.

◆ slot_update_countries

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.slot_update_countries

Definition at line 101 of file comics_project_setup_wizard.py.

◆ templateLocation

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.templateLocation

Definition at line 152 of file comics_project_setup_wizard.py.

◆ translationLocation

comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.translationLocation

Definition at line 153 of file comics_project_setup_wizard.py.

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

plugins/python/comics_project_management_tools/comics_project_setup_wizard.py

Public Attributes
	chkMakeProjectDirectory

	cmbCountry

	cmbLanguage

	exportDirectory

	generateListA

	generateListB

	lnExportDirectory

	lnPagesDirectory

	lnProjectDirectory

	lnProjectName

	lnTemplateLocation

	lnTranslationLocation

	pagesDirectory

	projectDirectory

	setupDictionary

	slot_edit_meta_data

	slot_generate

	slot_update_countries

	templateLocation

	translationLocation

Public Member Functions

Public Attributes

Static Public Attributes