Inheritance diagram for exportlayers.uiexportlayers.UIExportLayers:

Public Member Functions
	__init__ (self)

	confirmButton (self)

	export (self, document)

	initialize (self)

	loadDocuments (self)

	mkdir (self, directory)

	refreshButtonClicked (self)

Protected Member Functions
	_exportLayers (self, parentNode, fileFormat, parentDir)

	_selectDir (self)

	_setResolution (self, index)

	_toggleCropSize (self)

Protected Attributes
	_selectDir

	_setResolution

	_toggleCropSize

Detailed Description

Definition at line 23 of file uiexportlayers.py.

Constructor & Destructor Documentation

◆ init()

exportlayers.uiexportlayers.UIExportLayers.__init__ ( self )

Definition at line 25 of file uiexportlayers.py.

    def __init__(self):
        self.mainDialog = exportlayersdialog.ExportLayersDialog()
        self.mainLayout = QVBoxLayout(self.mainDialog)
        self.formLayout = QFormLayout()
        self.resSpinBoxLayout = QFormLayout()
        self.documentLayout = QVBoxLayout()
        self.directorySelectorLayout = QHBoxLayout()
        self.optionsLayout = QVBoxLayout()
        self.rectSizeLayout = QHBoxLayout()
 
        self.refreshButton = QPushButton(i18n("Refresh"))
        self.widgetDocuments = QListWidget()
        self.directoryTextField = QLineEdit()
        self.directoryDialogButton = QPushButton(i18n("..."))
        self.exportFilterLayersCheckBox = QCheckBox(
            i18n("Export filter layers"))
        self.batchmodeCheckBox = QCheckBox(i18n("Export in batchmode"))
        self.groupAsLayer = QCheckBox(i18n("Group as layer"))
        self.ignoreInvisibleLayersCheckBox = QCheckBox(
            i18n("Ignore invisible layers"))
        self.cropToImageBounds = QCheckBox(
                i18n("Adjust export size to layer content"))
        self.addIncrementPrefixCheckBox = QCheckBox(
            i18n("Add incrementing prefix"))
 
        self.rectWidthSpinBox = QSpinBox()
        self.rectHeightSpinBox = QSpinBox()
        self.formatsComboBox = QComboBox()
        self.resSpinBox = QSpinBox()
 
        self.buttonBox = QDialogButtonBox(
            QDialogButtonBox.StandardButton.Ok | QDialogButtonBox.StandardButton.Cancel)
 
        self.kritaInstance = Krita.instance()
        self.documentsList = []
 
        self.directoryTextField.setReadOnly(True)
        self.batchmodeCheckBox.setChecked(True)
        self.directoryDialogButton.clicked.connect(self._selectDir)
        self.widgetDocuments.currentRowChanged.connect(self._setResolution)
        self.widgetDocuments.setSelectionMode(QListWidget.SelectionMode.MultiSelection)
        self.widgetDocuments.setMouseTracking(True) #enable ToolTips to show the paths
        self.refreshButton.clicked.connect(self.refreshButtonClicked)
        self.buttonBox.accepted.connect(self.confirmButton)
        self.buttonBox.rejected.connect(self.mainDialog.close)
        self.cropToImageBounds.stateChanged.connect(self._toggleCropSize)
 
        self.mainDialog.setWindowModality(Qt.WindowModality.NonModal)
        self.widgetDocuments.setSizeAdjustPolicy(
            QAbstractScrollArea.SizeAdjustPolicy.AdjustToContents)
 

Member Function Documentation

◆ _exportLayers()

exportlayers.uiexportlayers.UIExportLayers._exportLayers	(	self,
		parentNode,
		fileFormat,
		parentDir )

protected

 This method get all sub-nodes from the current node and export then in
    the defined format.

Definition at line 201 of file uiexportlayers.py.

    def _exportLayers(self, parentNode, fileFormat, parentDir):
        """ This method get all sub-nodes from the current node and export then in
            the defined format."""
        prefixNum = 0
        for node in parentNode.childNodes():
            newDir = ''
            nodeName = node.name()
            if self.addIncrementPrefixCheckBox.isChecked():
                nodeName = str(prefixNum) + "-" + nodeName
 
            if node.type() == 'grouplayer' and not self.groupAsLayer.isChecked():
                newDir = os.path.join(parentDir, nodeName)
                self.mkdir(newDir)
            elif (not self.exportFilterLayersCheckBox.isChecked()
                  and 'filter' in node.type()):
                continue
            elif (self.ignoreInvisibleLayersCheckBox.isChecked()
                  and not node.visible()):
                continue
            else:
                _fileFormat = self.formatsComboBox.currentText()
                if '[jpeg]' in nodeName:
                    _fileFormat = 'jpeg'
                elif '[png]' in nodeName:
                    _fileFormat = 'png'
 
                if self.cropToImageBounds.isChecked():
                    bounds = QRect()
                else:
                    bounds = QRect(0, 0, self.rectWidthSpinBox.value(), self.rectHeightSpinBox.value())
 
                layerFileName = '{0}{1}/{2}.{3}'.format(
                    self.directoryTextField.text(),
                    parentDir, nodeName, _fileFormat)
                node.save(layerFileName, self.resSpinBox.value() / 72.,
                          self.resSpinBox.value() / 72., InfoObject(), bounds)
            prefixNum += 1
            if node.childNodes() and not self.groupAsLayer.isChecked():
                self._exportLayers(node, fileFormat, newDir)
 

◆ _selectDir()

exportlayers.uiexportlayers.UIExportLayers._selectDir ( self )

protected

Definition at line 241 of file uiexportlayers.py.

    def _selectDir(self):
        directory = FileDialog.getExistingDirectory(
            self.mainDialog,
            i18n("Select a Folder"),
            os.path.expanduser("~"))
        if directory:
            self.directoryTextField.setText(directory)
 

References exportlayers.uiexportlayers.UIExportLayers.directoryTextField, FileDialog.getExistingDirectory(), colorspace.uicolorspace.UIColorSpace.mainDialog, documenttools.uidocumenttools.UIDocumentTools.mainDialog, exportlayers.uiexportlayers.UIExportLayers.mainDialog, filtermanager.uifiltermanager.UIFilterManager.mainDialog, tenbrushes.uitenbrushes.UITenBrushes.mainDialog, and tenscripts.uitenscripts.UITenScripts.mainDialog.

◆ _setResolution()

exportlayers.uiexportlayers.UIExportLayers._setResolution	(		self,
			index )

protected

Definition at line 249 of file uiexportlayers.py.

    def _setResolution(self, index):
        document = self.documentsList[index]
        self.rectWidthSpinBox.setValue(document.width())
        self.rectHeightSpinBox.setValue(document.height())
        self.resSpinBox.setValue(document.resolution())
 

References colorspace.uicolorspace.UIColorSpace.documentsList, documenttools.uidocumenttools.UIDocumentTools.documentsList, exportlayers.uiexportlayers.UIExportLayers.documentsList, exportlayers.uiexportlayers.UIExportLayers.rectHeightSpinBox, exportlayers.uiexportlayers.UIExportLayers.rectWidthSpinBox, and exportlayers.uiexportlayers.UIExportLayers.resSpinBox.

◆ _toggleCropSize()

exportlayers.uiexportlayers.UIExportLayers._toggleCropSize ( self )

protected

Definition at line 255 of file uiexportlayers.py.

    def _toggleCropSize(self):
        cropToLayer = self.cropToImageBounds.isChecked()
        self.rectWidthSpinBox.setDisabled(cropToLayer)
        self.rectHeightSpinBox.setDisabled(cropToLayer)

References exportlayers.uiexportlayers.UIExportLayers.cropToImageBounds, exportlayers.uiexportlayers.UIExportLayers.rectHeightSpinBox, and exportlayers.uiexportlayers.UIExportLayers.rectWidthSpinBox.

◆ confirmButton()

exportlayers.uiexportlayers.UIExportLayers.confirmButton ( self )

Definition at line 158 of file uiexportlayers.py.

    def confirmButton(self):
        selectedPaths = [
            item.toolTip() for item in self.widgetDocuments.selectedItems()]
        selectedDocuments = [
            document for document in self.documentsList
            for path in selectedPaths if path == document.fileName()
        ]
        self.msgBox = QMessageBox(self.mainDialog)
 
        if not selectedDocuments:
            self.msgBox.setText(i18n("Select one document."))
        elif not self.directoryTextField.text():
            self.msgBox.setText(i18n("Select the initial directory."))
        else:
            for doc in selectedDocuments:
                self.export(doc)
            self.msgBox.setText(i18n("All layers have been exported."))
        self.msgBox.exec()
 

References colorspace.uicolorspace.UIColorSpace.documentsList, documenttools.uidocumenttools.UIDocumentTools.documentsList, exportlayers.uiexportlayers.UIExportLayers.documentsList, colorspace.uicolorspace.UIColorSpace.widgetDocuments, documenttools.uidocumenttools.UIDocumentTools.widgetDocuments, and exportlayers.uiexportlayers.UIExportLayers.widgetDocuments.

◆ export()

exportlayers.uiexportlayers.UIExportLayers.export	(		self,
			document )

Definition at line 188 of file uiexportlayers.py.

    def export(self, document):
        Application.setBatchmode(self.batchmodeCheckBox.isChecked())
 
        documentName = document.fileName() if document.fileName() else 'Untitled'  # noqa: E501
        fileName, extension = os.path.splitext(os.path.basename(documentName))
        self.mkdir('/' + fileName)
 
        self._exportLayers(
            document.rootNode(),
            self.formatsComboBox.currentText(),
            '/' + fileName)
        Application.setBatchmode(True)
 

References exportlayers.uiexportlayers.UIExportLayers._exportLayers(), exportlayers.uiexportlayers.UIExportLayers.batchmodeCheckBox, exportlayers.uiexportlayers.UIExportLayers.formatsComboBox, and exportlayers.uiexportlayers.UIExportLayers.mkdir().

◆ initialize()

exportlayers.uiexportlayers.UIExportLayers.initialize ( self )

Definition at line 76 of file uiexportlayers.py.

    def initialize(self):
        self.loadDocuments()
 
        self.rectWidthSpinBox.setRange(1, 10000)
        self.rectHeightSpinBox.setRange(1, 10000)
        self.resSpinBox.setRange(20, 1200)
 
        self.formatsComboBox.addItem(i18n("JPEG"))
        self.formatsComboBox.addItem(i18n("PNG"))
 
        self.documentLayout.addWidget(self.widgetDocuments)
        self.documentLayout.addWidget(self.refreshButton)
 
        self.directorySelectorLayout.addWidget(self.directoryTextField)
        self.directorySelectorLayout.addWidget(self.directoryDialogButton)
 
        self.optionsLayout.addWidget(self.exportFilterLayersCheckBox)
        self.optionsLayout.addWidget(self.batchmodeCheckBox)
        self.optionsLayout.addWidget(self.groupAsLayer)
        self.optionsLayout.addWidget(self.ignoreInvisibleLayersCheckBox)
        self.optionsLayout.addWidget(self.cropToImageBounds)
        self.optionsLayout.addWidget(self.addIncrementPrefixCheckBox)
 
        self.resSpinBoxLayout.addRow(i18n("dpi:"), self.resSpinBox)
 
        self.rectSizeLayout.addWidget(self.rectWidthSpinBox)
        self.rectSizeLayout.addWidget(self.rectHeightSpinBox)
        self.rectSizeLayout.addLayout(self.resSpinBoxLayout)
 
        self.formLayout.addRow(i18n("Documents:"), self.documentLayout)
        self.formLayout.addRow(
            i18n("Initial directory:"), self.directorySelectorLayout)
        self.formLayout.addRow(i18n("Export options:"), self.optionsLayout)
        self.formLayout.addRow(i18n("Export size:"), self.rectSizeLayout)
        self.formLayout.addRow(
            i18n("Images extensions:"), self.formatsComboBox)
 
        self.line = QFrame()
        self.line.setFrameShape(QFrame.Shape.HLine)
        self.line.setFrameShadow(QFrame.Shadow.Sunken)
 
        self.mainLayout.addLayout(self.formLayout)
        self.mainLayout.addWidget(self.line)
        self.mainLayout.addWidget(self.buttonBox)
        
        self.mainDialog.resize(500, 300)
        self.mainDialog.setWindowTitle(i18n("Export Layers"))
        self.mainDialog.setSizeGripEnabled(True)
        self.mainDialog.show()
        self.mainDialog.activateWindow()
 

◆ loadDocuments()

exportlayers.uiexportlayers.UIExportLayers.loadDocuments ( self )

Definition at line 127 of file uiexportlayers.py.

    def loadDocuments(self):
        self.widgetDocuments.clear()
 
        self.documentsList = [
            document for document in self.kritaInstance.documents()
        ]
 
        currentDoc = None
        if self.kritaInstance.activeDocument():
            currentDoc = self.kritaInstance.activeDocument().fileName()
        
        activeDoc = 0
        docCount = 0
        for document in self.documentsList:
            fullName = document.fileName()
            if document.name(): #if you open a file that isn't a .kra file it won't have a name property...
                shortName = document.name()
            else:
                shortName = os.path.basename(document.fileName()) #... so just get the name from the file using os.path.basename()
            newListItem= QListWidgetItem(shortName)
            newListItem.setToolTip(fullName) # ... show the full path as a ToolTip, rather than in the list, better UX
            if fullName == currentDoc:
                activeDoc = docCount
            self.widgetDocuments.addItem(newListItem)
            docCount += 1
        if self.widgetDocuments.count():
            self.widgetDocuments.setCurrentItem(self.widgetDocuments.item(activeDoc))
        

References colorspace.uicolorspace.UIColorSpace.documentsList, documenttools.uidocumenttools.UIDocumentTools.documentsList, exportlayers.uiexportlayers.UIExportLayers.documentsList, colorspace.uicolorspace.UIColorSpace.kritaInstance, documenttools.uidocumenttools.UIDocumentTools.kritaInstance, exportlayers.uiexportlayers.UIExportLayers.kritaInstance, filtermanager.uifiltermanager.UIFilterManager.kritaInstance, lastdocumentsdocker.lastdocumentslistmodel.LastDocumentsListModel.kritaInstance, tenbrushes.uitenbrushes.UITenBrushes.kritaInstance, tenscripts.uitenscripts.UITenScripts.kritaInstance, colorspace.uicolorspace.UIColorSpace.widgetDocuments, documenttools.uidocumenttools.UIDocumentTools.widgetDocuments, and exportlayers.uiexportlayers.UIExportLayers.widgetDocuments.

◆ mkdir()

exportlayers.uiexportlayers.UIExportLayers.mkdir	(		self,
			directory )

Definition at line 177 of file uiexportlayers.py.

    def mkdir(self, directory):
        target_directory = self.directoryTextField.text() + directory
        if (os.path.exists(target_directory)
                and os.path.isdir(target_directory)):
            return
 
        try:
            os.makedirs(target_directory)
        except OSError as e:
            raise e
 

References exportlayers.uiexportlayers.UIExportLayers.directoryTextField.

◆ refreshButtonClicked()

exportlayers.uiexportlayers.UIExportLayers.refreshButtonClicked ( self )

Definition at line 155 of file uiexportlayers.py.

    def refreshButtonClicked(self):
        self.loadDocuments()
 

References colorspace.uicolorspace.UIColorSpace.loadDocuments(), documenttools.uidocumenttools.UIDocumentTools.loadDocuments(), and exportlayers.uiexportlayers.UIExportLayers.loadDocuments().

Member Data Documentation

◆ _selectDir

exportlayers.uiexportlayers.UIExportLayers._selectDir

protected

Definition at line 63 of file uiexportlayers.py.

◆ _setResolution

exportlayers.uiexportlayers.UIExportLayers._setResolution

protected

Definition at line 64 of file uiexportlayers.py.

◆ _toggleCropSize

exportlayers.uiexportlayers.UIExportLayers._toggleCropSize

protected

Definition at line 70 of file uiexportlayers.py.

◆ addIncrementPrefixCheckBox

exportlayers.uiexportlayers.UIExportLayers.addIncrementPrefixCheckBox

Definition at line 47 of file uiexportlayers.py.

◆ batchmodeCheckBox

exportlayers.uiexportlayers.UIExportLayers.batchmodeCheckBox

Definition at line 41 of file uiexportlayers.py.

◆ buttonBox

exportlayers.uiexportlayers.UIExportLayers.buttonBox

Definition at line 55 of file uiexportlayers.py.

◆ confirmButton

exportlayers.uiexportlayers.UIExportLayers.confirmButton

Definition at line 68 of file uiexportlayers.py.

◆ cropToImageBounds

exportlayers.uiexportlayers.UIExportLayers.cropToImageBounds

Definition at line 45 of file uiexportlayers.py.

◆ directoryDialogButton

exportlayers.uiexportlayers.UIExportLayers.directoryDialogButton

Definition at line 38 of file uiexportlayers.py.

◆ directorySelectorLayout

exportlayers.uiexportlayers.UIExportLayers.directorySelectorLayout

Definition at line 31 of file uiexportlayers.py.

◆ directoryTextField

exportlayers.uiexportlayers.UIExportLayers.directoryTextField

Definition at line 37 of file uiexportlayers.py.

◆ documentLayout

exportlayers.uiexportlayers.UIExportLayers.documentLayout

Definition at line 30 of file uiexportlayers.py.

◆ documentsList

exportlayers.uiexportlayers.UIExportLayers.documentsList

Definition at line 59 of file uiexportlayers.py.

◆ exportFilterLayersCheckBox

exportlayers.uiexportlayers.UIExportLayers.exportFilterLayersCheckBox

Definition at line 39 of file uiexportlayers.py.

◆ formatsComboBox

exportlayers.uiexportlayers.UIExportLayers.formatsComboBox

Definition at line 52 of file uiexportlayers.py.

◆ formLayout

exportlayers.uiexportlayers.UIExportLayers.formLayout

Definition at line 28 of file uiexportlayers.py.

◆ groupAsLayer

exportlayers.uiexportlayers.UIExportLayers.groupAsLayer

Definition at line 42 of file uiexportlayers.py.

◆ ignoreInvisibleLayersCheckBox

exportlayers.uiexportlayers.UIExportLayers.ignoreInvisibleLayersCheckBox

Definition at line 43 of file uiexportlayers.py.

◆ kritaInstance

exportlayers.uiexportlayers.UIExportLayers.kritaInstance

Definition at line 58 of file uiexportlayers.py.

◆ line

exportlayers.uiexportlayers.UIExportLayers.line

Definition at line 113 of file uiexportlayers.py.

◆ mainDialog

exportlayers.uiexportlayers.UIExportLayers.mainDialog

Definition at line 26 of file uiexportlayers.py.

◆ mainLayout

exportlayers.uiexportlayers.UIExportLayers.mainLayout

Definition at line 27 of file uiexportlayers.py.

◆ msgBox

exportlayers.uiexportlayers.UIExportLayers.msgBox

Definition at line 165 of file uiexportlayers.py.

◆ optionsLayout

exportlayers.uiexportlayers.UIExportLayers.optionsLayout

Definition at line 32 of file uiexportlayers.py.

◆ rectHeightSpinBox

exportlayers.uiexportlayers.UIExportLayers.rectHeightSpinBox

Definition at line 51 of file uiexportlayers.py.

◆ rectSizeLayout

exportlayers.uiexportlayers.UIExportLayers.rectSizeLayout

Definition at line 33 of file uiexportlayers.py.

◆ rectWidthSpinBox

exportlayers.uiexportlayers.UIExportLayers.rectWidthSpinBox

Definition at line 50 of file uiexportlayers.py.

◆ refreshButton

exportlayers.uiexportlayers.UIExportLayers.refreshButton

Definition at line 35 of file uiexportlayers.py.

◆ refreshButtonClicked

exportlayers.uiexportlayers.UIExportLayers.refreshButtonClicked

Definition at line 67 of file uiexportlayers.py.

◆ resSpinBox

exportlayers.uiexportlayers.UIExportLayers.resSpinBox

Definition at line 53 of file uiexportlayers.py.

◆ resSpinBoxLayout

exportlayers.uiexportlayers.UIExportLayers.resSpinBoxLayout

Definition at line 29 of file uiexportlayers.py.

◆ widgetDocuments

exportlayers.uiexportlayers.UIExportLayers.widgetDocuments

Definition at line 36 of file uiexportlayers.py.

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

plugins/python/exportlayers/uiexportlayers.py

Public Attributes
	addIncrementPrefixCheckBox

	batchmodeCheckBox

	buttonBox

	confirmButton

	cropToImageBounds

	directoryDialogButton

	directorySelectorLayout

	directoryTextField

	documentLayout

	documentsList

	exportFilterLayersCheckBox

	formatsComboBox

	formLayout

	groupAsLayer

	ignoreInvisibleLayersCheckBox

	kritaInstance

	line

	mainDialog

	mainLayout

	msgBox

	optionsLayout

	rectHeightSpinBox

	rectSizeLayout

	rectWidthSpinBox

	refreshButton

	refreshButtonClicked

	resSpinBox

	resSpinBoxLayout

	widgetDocuments

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _exportLayers()

◆ _selectDir()

◆ _setResolution()

◆ _toggleCropSize()

◆ confirmButton()

◆ export()

◆ initialize()

◆ loadDocuments()

◆ mkdir()

◆ refreshButtonClicked()

Member Data Documentation

◆ _selectDir

◆ _setResolution

◆ _toggleCropSize

◆ addIncrementPrefixCheckBox

◆ batchmodeCheckBox

◆ buttonBox

◆ confirmButton

◆ cropToImageBounds

◆ directoryDialogButton

◆ directorySelectorLayout

◆ directoryTextField

◆ documentLayout

◆ documentsList

◆ exportFilterLayersCheckBox

◆ formatsComboBox

◆ formLayout

◆ groupAsLayer

◆ ignoreInvisibleLayersCheckBox

◆ kritaInstance

◆ line

◆ mainDialog

◆ mainLayout

◆ msgBox

◆ optionsLayout

◆ rectHeightSpinBox

◆ rectSizeLayout

◆ rectWidthSpinBox

◆ refreshButton

◆ refreshButtonClicked

◆ resSpinBox

◆ resSpinBoxLayout

◆ widgetDocuments

◆ init()