Inheritance diagram for palette_docker.palette_docker.PaletteDocker:

Public Member Functions
	__init__ (self)

	canvasChanged (self, canvas)

	slot_add_entry (self)

	slot_add_group (self)

	slot_edit_palette_data (self)

	slot_export_to_gimp_palette (self)

	slot_export_to_inkscape_svg (self)

	slot_fill_combobox (self)

	slot_get_color_from_combobox (self)

	slot_paletteChanged (self, name)

	slot_remove_entry (self)

	slot_sort_colors (self)

	slot_swatchSelected (self, entry)

Detailed Description

Definition at line 38 of file palette_docker.py.

Constructor & Destructor Documentation

◆ init()

palette_docker.palette_docker.PaletteDocker.__init__ ( self )

Definition at line 41 of file palette_docker.py.

    def __init__(self):
        super(PaletteDocker, self).__init__()
        # make base-widget and layout
        widget = QWidget()
        layout = QVBoxLayout()
        buttonLayout = QHBoxLayout()
        widget.setLayout(layout)
        self.setWindowTitle(i18n("Python Palette Docker"))
 
        # Make a combobox and add palettes
        self.cmb_palettes = QComboBox()
        allPalettes = Application.resources("palette")
        for palette_name in allPalettes:
            self.cmb_palettes.addItem(palette_name)
            self.cmb_palettes.model().sort(0)
 
        if len(allPalettes.keys()) > 0:
            self.currentPalette = Palette(list(allPalettes.values())[0])
        else:
            self.currentPalette = None
 
        self.cmb_palettes.currentTextChanged.connect(self.slot_paletteChanged)
        layout.addWidget(self.cmb_palettes)  # add combobox to the layout
        self.paletteView = PaletteView()
        self.paletteView.setPalette(self.currentPalette)
        layout.addWidget(self.paletteView)
        self.paletteView.entrySelectedForeGround.connect(
            self.slot_swatchSelected)
 
        self.colorComboBox = QComboBox()
        self.colorList = list()
        buttonLayout.addWidget(self.colorComboBox)
        self.bnSetColor = QToolButton()
        self.bnSetColor.setText(i18n("Set"))
        self.bnSetColor.clicked.connect(self.slot_get_color_from_combobox)
        buttonLayout.addWidget(self.bnSetColor)
 
        self.addEntry = QAction(self)
        self.addEntry.setIconText(i18n("+"))
        self.addEntry.triggered.connect(self.slot_add_entry)
        self.addGroup = QAction(self)
        self.addGroup.triggered.connect(self.slot_add_group)
        self.addGroup.setText(i18nc("Group as Color Group in a Palette", "Add Group"))
        self.addGroup.setIconText(str("\U0001F4C2"))
        self.removeEntry = QAction(self)
        self.removeEntry.setText(i18n("Remove Entry"))
        self.removeEntry.setIconText("-")
        self.removeEntry.triggered.connect(self.slot_remove_entry)
        addEntryButton = QToolButton()
        addEntryButton.setDefaultAction(self.addEntry)
        buttonLayout.addWidget(addEntryButton)
        addGroupButton = QToolButton()
        addGroupButton.setDefaultAction(self.addGroup)
        buttonLayout.addWidget(addGroupButton)
        removeEntryButton = QToolButton()
        removeEntryButton.setDefaultAction(self.removeEntry)
        buttonLayout.addWidget(removeEntryButton)
 
        # QActions
        self.extra = QToolButton()
        self.editPaletteData = QAction(self)
        self.editPaletteData.setText(i18n("Edit Palette Settings"))
        self.editPaletteData.triggered.connect(self.slot_edit_palette_data)
        self.extra.setDefaultAction(self.editPaletteData)
        buttonLayout.addWidget(self.extra)
        self.actionMenu = QMenu()
        self.exportToGimp = QAction(self)
        self.exportToGimp.setText(i18n("Export as GIMP Palette File"))
        self.exportToGimp.triggered.connect(self.slot_export_to_gimp_palette)
        self.exportToInkscape = QAction(self)
        self.exportToInkscape.setText(
            i18n("Export as Inkscape SVG with Swatches"))
        self.exportToInkscape.triggered.connect(
            self.slot_export_to_inkscape_svg)
        self.sortColors = QAction(self)
        self.sortColors.setText(i18n("Sort Colors"))
        self.sortColors.triggered.connect(self.slot_sort_colors)
        self.actionMenu.addAction(self.editPaletteData)
        self.actionMenu.addAction(self.exportToGimp)
        self.actionMenu.addAction(self.exportToInkscape)
        self.actionMenu.addAction(self.sortColors)
 
        self.extra.setMenu(self.actionMenu)
 
        layout.addLayout(buttonLayout)
        self.slot_fill_combobox()
        self.setWidget(widget)        # add widget to the docker
 

References palette_docker.palette_docker.PaletteDocker.__init__(), KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

Member Function Documentation

◆ canvasChanged()

palette_docker.palette_docker.PaletteDocker.canvasChanged	(		self,
			canvas )

Definition at line 270 of file palette_docker.py.

    def canvasChanged(self, canvas):
        self.cmb_palettes.clear()
        allPalettes = Application.resources("palette")
        for palette_name in allPalettes:
            self.cmb_palettes.addItem(palette_name)
            self.cmb_palettes.model().sort(0)
 
        if self.currentPalette is None and len(allPalettes.keys()) > 0:
            self.currentPalette = Palette(list(allPalettes.values())[0])

References palette_docker.palette_docker.PaletteDocker.cmb_palettes, palette_docker.palette_docker.PaletteDocker.currentPalette, palette_docker.palette_exporter_gimppalette.gimpPaletteExporter.currentPalette, palette_docker.palette_exporter_inkscapeSVG.inkscapeSVGExporter.currentPalette, and palette_docker.palette_sortColors.sortColors.currentPalette.

◆ slot_add_entry()

palette_docker.palette_docker.PaletteDocker.slot_add_entry ( self )

Definition at line 200 of file palette_docker.py.

    def slot_add_entry(self):
        if (self.canvas()) is not None:
            if (self.canvas().view()) is not None:
                color = self.canvas().view().foregroundColor()
                success = self.paletteView.addEntryWithDialog(color)
                if success is True:
                    self.slot_fill_combobox()
 

References KoSnapProxy.canvas(), KoCanvasController.canvas(), KoCanvasObserverBasePrivate.canvas, KoShapeController::Private.canvas, KoShapeFillResourceConnector::Private.canvas, KoShapeManager.canvas(), KoShapeManager.canvas, KoSnapGuide.canvas, KoSnapGuide.canvas(), KoToolBase.canvas(), KoToolBasePrivate.canvas, CanvasData.canvas, KoToolProxy.canvas(), KoShapePainter.canvas, Canvas::Private.canvas, krita::DockWidget::Private.canvas, DockWidget.canvas(), View.canvas(), Private.canvas, KisCanvasWidgetBase::Private.canvas, KisCanvasWidgetBase.canvas(), KisCanvasAnimationState::Private.canvas, KisInputManager::Private.canvas, KisOpenGLCanvasRenderer.canvas(), KisOpenGLCanvasRenderer::CanvasBridge.canvas(), KoCanvasControllerWidget.canvas(), KoCanvasControllerWidget.canvas, Viewport.canvas(), KisShapeLayer::Private.canvas, KisShapeLayer.canvas(), KisInputManager.canvas(), KisCanvasResourceProvider.canvas(), KisView.canvas, KisViewManager.canvas(), KisOpenGLCanvas2::CanvasBridge.canvas(), KisAsyncColorSamplerHelper::Private.canvas, KoFillConfigWidget.canvas, KoStrokeConfigWidget.canvas, KoShadowConfigWidget.canvas, KisAnimCurvesDocker::Private.canvas, KisAnimTimelineDocker::Private.canvas, KisAnimTimelineFramesView::Private.canvas, RecorderWriter::Private.canvas, RecorderWriterManager::Private.canvas, RecorderDockerDock::Private.canvas, SnapshotDocker::Private.canvas, workflow_buttons.buttons_settings_dialog.SelectedColorPreview.canvas, SvgTextCursor.canvas, KoColorSetWidget.paletteView, palette_docker.palette_docker.PaletteDocker.paletteView, and palette_docker.palette_docker.PaletteDocker.slot_fill_combobox().

◆ slot_add_group()

palette_docker.palette_docker.PaletteDocker.slot_add_group ( self )

Definition at line 208 of file palette_docker.py.

    def slot_add_group(self):
        success = self.paletteView.addGroupWithDialog()
        if success is True:
            self.slot_fill_combobox()
 

References KoColorSetWidget.paletteView, palette_docker.palette_docker.PaletteDocker.paletteView, and palette_docker.palette_docker.PaletteDocker.slot_fill_combobox().

◆ slot_edit_palette_data()

palette_docker.palette_docker.PaletteDocker.slot_edit_palette_data ( self )

A function for giving a gui to edit palette metadata... I also
want this to be the way to edit the settings of the palette
docker.

Definition at line 218 of file palette_docker.py.

    def slot_edit_palette_data(self):
        '''A function for giving a gui to edit palette metadata... I also
        want this to be the way to edit the settings of the palette
        docker.
        '''
 
        dialog = QDialog(self)
        tabWidget = QTabWidget()
        dialog.setWindowTitle(i18n("Edit Palette Data"))
        dialog.setLayout(QVBoxLayout())
        dialog.layout().addWidget(tabWidget)
        paletteWidget = QWidget()
        paletteWidget.setLayout(QVBoxLayout())
        tabWidget.addTab(paletteWidget, i18n("Palette Data"))
        paletteName = QLineEdit()
        paletteName.setText(self.cmb_palettes.currentText())
        paletteWidget.layout().addWidget(paletteName)
        paletteColumns = QSpinBox()
        paletteColumns.setValue(self.currentPalette.columnCount())
        paletteWidget.layout().addWidget(paletteColumns)
        paletteComment = QPlainTextEdit()
        paletteComment.appendPlainText(self.currentPalette.comment())
        paletteWidget.layout().addWidget(paletteComment)
        buttons = QDialogButtonBox(QDialogButtonBox.StandardButton.Ok)
        dialog.layout().addWidget(buttons)
        buttons.accepted.connect(dialog.accept)
        # buttons.rejected.connect(dialog.reject())
 
        if dialog.exec() == QDialog.DialogCode.Accepted:
            Resource = Application.resources("palette")[
                self.cmb_palettes.currentText()]
            Resource.setName(paletteName.text())
            self.currentPalette = Palette(Resource)
            self.currentPalette.setColumnCount(paletteColumns.value())
            self.paletteView.setPalette(self.currentPalette)
            self.slot_fill_combobox()
            self.currentPalette.setComment(paletteComment.toPlainText())
            self.currentPalette.save()
 

References palette_docker.palette_docker.PaletteDocker.cmb_palettes, palette_docker.palette_docker.PaletteDocker.currentPalette, palette_docker.palette_exporter_gimppalette.gimpPaletteExporter.currentPalette, palette_docker.palette_exporter_inkscapeSVG.inkscapeSVGExporter.currentPalette, palette_docker.palette_sortColors.sortColors.currentPalette, KoColorSetWidget.paletteView, palette_docker.palette_docker.PaletteDocker.paletteView, Resource.setName(), and palette_docker.palette_docker.PaletteDocker.slot_fill_combobox().

◆ slot_export_to_gimp_palette()

palette_docker.palette_docker.PaletteDocker.slot_export_to_gimp_palette ( self )

Definition at line 257 of file palette_docker.py.

    def slot_export_to_gimp_palette(self):
        palette_exporter_gimppalette.gimpPaletteExporter(
            self.cmb_palettes.currentText())
 

References palette_docker.palette_docker.PaletteDocker.cmb_palettes.

◆ slot_export_to_inkscape_svg()

palette_docker.palette_docker.PaletteDocker.slot_export_to_inkscape_svg ( self )

Definition at line 261 of file palette_docker.py.

    def slot_export_to_inkscape_svg(self):
        palette_exporter_inkscapeSVG.inkscapeSVGExporter(
            self.cmb_palettes.currentText())
 

References palette_docker.palette_docker.PaletteDocker.cmb_palettes.

◆ slot_fill_combobox()

palette_docker.palette_docker.PaletteDocker.slot_fill_combobox ( self )

A function for making a combobox with the available colors. We use
QCompleter on the colorComboBox so that people can type in the
name of a color to select it. This is useful for people with
carefully made palettes where the colors are named properly,
which makes it easier for them to find colors.

Definition at line 151 of file palette_docker.py.

    def slot_fill_combobox(self):
        '''A function for making a combobox with the available colors. We use
        QCompleter on the colorComboBox so that people can type in the
        name of a color to select it. This is useful for people with
        carefully made palettes where the colors are named properly,
        which makes it easier for them to find colors.
        '''
 
        if self.currentPalette is None:
            return
        self.colorComboBox.clear()
        self.colorList = list()
        palette = self.currentPalette
        for i in range(palette.colorsCountTotal()):
            entry = palette.entryByIndex(i)
            color = entry.color().colorForCanvas(self.canvas())
            colorSquare = QPixmap(12, 12)
            if entry.spotColor() is True:
                img = colorSquare.toImage()
                circlePainter = QPainter()
                img.fill(self.colorComboBox.palette().color(QPalette.ColorRole.Base))
                circlePainter.begin(img)
                brush = QBrush(Qt.BrushStyle.SolidPattern)
                brush.setColor(color)
                circlePainter.setBrush(brush)
                circlePainter.pen().setWidth(0)
                circlePainter.drawEllipse(0, 0, 11, 11)
                circlePainter.end()
                colorSquare = QPixmap.fromImage(img)
            else:
                colorSquare.fill(color)
            name = entry.name()
            if len(entry.id()) > 0:
                name = entry.id() + " - " + entry.name()
            self.colorList.append(name)
            self.colorComboBox.addItem(QIcon(colorSquare), name)
        self.colorComboBox.setEditable(True)
        self.colorComboBox.setInsertPolicy(QComboBox.InsertPolicy.NoInsert)
        self.colorComboBox.completer().setCompletionMode(
            QCompleter.CompletionMode.PopupCompletion)
        self.colorComboBox.completer().setCaseSensitivity(Qt.CaseSensitivity.CaseInsensitive)
        self.colorComboBox.completer().setFilterMode(Qt.MatchFlag.MatchContains)
 

References KoCanvasController.canvas(), KoCanvasObserverBasePrivate.canvas, KoShapeController::Private.canvas, KoShapeFillResourceConnector::Private.canvas, KoShapeManager.canvas(), KoShapeManager.canvas, KoSnapGuide.canvas, KoSnapProxy.canvas(), KoSnapGuide.canvas(), KoToolBase.canvas(), KoToolBasePrivate.canvas, CanvasData.canvas, KoToolProxy.canvas(), KoShapePainter.canvas, Canvas::Private.canvas, krita::DockWidget::Private.canvas, DockWidget.canvas(), View.canvas(), Private.canvas, KisCanvasWidgetBase::Private.canvas, KisCanvasWidgetBase.canvas(), KisCanvasAnimationState::Private.canvas, KoCanvasControllerWidget.canvas, Viewport.canvas(), KisShapeLayer::Private.canvas, KisShapeLayer.canvas(), KisInputManager.canvas(), KisInputManager::Private.canvas, KisCanvasResourceProvider.canvas(), KisView.canvas, KisViewManager.canvas(), KisOpenGLCanvasRenderer.canvas(), KisOpenGLCanvasRenderer::CanvasBridge.canvas(), KoCanvasControllerWidget.canvas(), KisOpenGLCanvas2::CanvasBridge.canvas(), KisAsyncColorSamplerHelper::Private.canvas, KoFillConfigWidget.canvas, KoStrokeConfigWidget.canvas, KoShadowConfigWidget.canvas, KisAnimCurvesDocker::Private.canvas, KisAnimTimelineDocker::Private.canvas, KisAnimTimelineFramesView::Private.canvas, RecorderWriter::Private.canvas, RecorderWriterManager::Private.canvas, RecorderDockerDock::Private.canvas, SnapshotDocker::Private.canvas, workflow_buttons.buttons_settings_dialog.SelectedColorPreview.canvas, SvgTextCursor.canvas, palette_docker.palette_docker.PaletteDocker.colorComboBox, palette_docker.palette_docker.PaletteDocker.colorList, palette_docker.palette_docker.PaletteDocker.currentPalette, palette_docker.palette_exporter_gimppalette.gimpPaletteExporter.currentPalette, palette_docker.palette_exporter_inkscapeSVG.inkscapeSVGExporter.currentPalette, palette_docker.palette_sortColors.sortColors.currentPalette, and palette.

◆ slot_get_color_from_combobox()

palette_docker.palette_docker.PaletteDocker.slot_get_color_from_combobox ( self )

Definition at line 194 of file palette_docker.py.

    def slot_get_color_from_combobox(self):
        if self.currentPalette is not None:
            entry = self.currentPalette.entryByIndex(
                self.colorComboBox.currentIndex())
            self.slot_swatchSelected(entry)
 

References palette_docker.palette_docker.PaletteDocker.colorComboBox, palette_docker.palette_docker.PaletteDocker.currentPalette, palette_docker.palette_exporter_gimppalette.gimpPaletteExporter.currentPalette, palette_docker.palette_exporter_inkscapeSVG.inkscapeSVGExporter.currentPalette, palette_docker.palette_sortColors.sortColors.currentPalette, palette_docker.palette_docker.PaletteDocker.slot_swatchSelected, and palette_docker.palette_docker.PaletteDocker.slot_swatchSelected().

◆ slot_paletteChanged()

palette_docker.palette_docker.PaletteDocker.slot_paletteChanged	(		self,
			name )

Definition at line 129 of file palette_docker.py.

    def slot_paletteChanged(self, name):
        allPalettes = Application.resources("palette")
        if len(allPalettes) > 0 and name in allPalettes:
            self.currentPalette = Palette(
                Application.resources("palette")[name])
            self.paletteView.setPalette(self.currentPalette)
            self.slot_fill_combobox()
 

References palette_docker.palette_docker.PaletteDocker.currentPalette, palette_docker.palette_exporter_gimppalette.gimpPaletteExporter.currentPalette, palette_docker.palette_exporter_inkscapeSVG.inkscapeSVGExporter.currentPalette, palette_docker.palette_sortColors.sortColors.currentPalette, KoColorSetWidget.paletteView, palette_docker.palette_docker.PaletteDocker.paletteView, and palette_docker.palette_docker.PaletteDocker.slot_fill_combobox().

◆ slot_remove_entry()

palette_docker.palette_docker.PaletteDocker.slot_remove_entry ( self )

Definition at line 213 of file palette_docker.py.

    def slot_remove_entry(self):
        success = self.paletteView.removeSelectedEntryWithDialog()
        if success is True:
            self.slot_fill_combobox()
 

References KoColorSetWidget.paletteView, palette_docker.palette_docker.PaletteDocker.paletteView, and palette_docker.palette_docker.PaletteDocker.slot_fill_combobox().

◆ slot_sort_colors()

palette_docker.palette_docker.PaletteDocker.slot_sort_colors ( self )

Definition at line 265 of file palette_docker.py.

    def slot_sort_colors(self):
        colorSorter = palette_sortColors.sortColors(
            self.cmb_palettes.currentText())
        self.paletteView.setPalette(colorSorter.palette())
 

References palette_docker.palette_docker.PaletteDocker.cmb_palettes, KoColorSetWidget.paletteView, and palette_docker.palette_docker.PaletteDocker.paletteView.

◆ slot_swatchSelected()

palette_docker.palette_docker.PaletteDocker.slot_swatchSelected	(		self,
			entry )

Definition at line 138 of file palette_docker.py.

    def slot_swatchSelected(self, entry):
        if (self.canvas()) is not None:
            if (self.canvas().view()) is not None:
                name = entry.name()
                if len(entry.id()) > 0:
                    name = entry.id() + " - " + entry.name()
                if len(name) > 0:
                    if name in self.colorList:
                        self.colorComboBox.setCurrentIndex(
                            self.colorList.index(name))
                color = entry.color()
                self.canvas().view().setForeGroundColor(color)
 

Member Data Documentation

◆ actionMenu

palette_docker.palette_docker.PaletteDocker.actionMenu

Definition at line 106 of file palette_docker.py.

◆ addEntry

palette_docker.palette_docker.PaletteDocker.addEntry

Definition at line 78 of file palette_docker.py.

◆ addGroup

palette_docker.palette_docker.PaletteDocker.addGroup

Definition at line 81 of file palette_docker.py.

◆ bnSetColor

palette_docker.palette_docker.PaletteDocker.bnSetColor

Definition at line 73 of file palette_docker.py.

◆ cmb_palettes

palette_docker.palette_docker.PaletteDocker.cmb_palettes

Definition at line 51 of file palette_docker.py.

◆ colorComboBox

palette_docker.palette_docker.PaletteDocker.colorComboBox

Definition at line 70 of file palette_docker.py.

◆ colorList

palette_docker.palette_docker.PaletteDocker.colorList

Definition at line 71 of file palette_docker.py.

◆ currentPalette

palette_docker.palette_docker.PaletteDocker.currentPalette

Definition at line 58 of file palette_docker.py.

◆ editPaletteData

palette_docker.palette_docker.PaletteDocker.editPaletteData

Definition at line 101 of file palette_docker.py.

◆ exportToGimp

palette_docker.palette_docker.PaletteDocker.exportToGimp

Definition at line 107 of file palette_docker.py.

◆ exportToInkscape

palette_docker.palette_docker.PaletteDocker.exportToInkscape

Definition at line 110 of file palette_docker.py.

◆ extra

palette_docker.palette_docker.PaletteDocker.extra

Definition at line 100 of file palette_docker.py.

◆ paletteView

palette_docker.palette_docker.PaletteDocker.paletteView

Definition at line 64 of file palette_docker.py.

◆ removeEntry

palette_docker.palette_docker.PaletteDocker.removeEntry

Definition at line 85 of file palette_docker.py.

◆ slot_add_entry

palette_docker.palette_docker.PaletteDocker.slot_add_entry

Definition at line 80 of file palette_docker.py.

◆ slot_add_group

palette_docker.palette_docker.PaletteDocker.slot_add_group

Definition at line 82 of file palette_docker.py.

◆ slot_edit_palette_data

palette_docker.palette_docker.PaletteDocker.slot_edit_palette_data

Definition at line 103 of file palette_docker.py.

◆ slot_export_to_gimp_palette

palette_docker.palette_docker.PaletteDocker.slot_export_to_gimp_palette

Definition at line 109 of file palette_docker.py.

◆ slot_export_to_inkscape_svg

palette_docker.palette_docker.PaletteDocker.slot_export_to_inkscape_svg

Definition at line 114 of file palette_docker.py.

◆ slot_get_color_from_combobox

palette_docker.palette_docker.PaletteDocker.slot_get_color_from_combobox

Definition at line 75 of file palette_docker.py.

◆ slot_paletteChanged

palette_docker.palette_docker.PaletteDocker.slot_paletteChanged

Definition at line 62 of file palette_docker.py.

◆ slot_remove_entry

palette_docker.palette_docker.PaletteDocker.slot_remove_entry

Definition at line 88 of file palette_docker.py.

◆ slot_sort_colors

palette_docker.palette_docker.PaletteDocker.slot_sort_colors

Definition at line 117 of file palette_docker.py.

◆ slot_swatchSelected

palette_docker.palette_docker.PaletteDocker.slot_swatchSelected

Definition at line 68 of file palette_docker.py.

◆ sortColors

palette_docker.palette_docker.PaletteDocker.sortColors

Definition at line 115 of file palette_docker.py.

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

plugins/python/palette_docker/palette_docker.py

Public Attributes
	actionMenu

	addEntry

	addGroup

	bnSetColor

	cmb_palettes

	colorComboBox

	colorList

	currentPalette

	editPaletteData

	exportToGimp

	exportToInkscape

	extra

	paletteView

	removeEntry

	slot_add_entry

	slot_add_group

	slot_edit_palette_data

	slot_export_to_gimp_palette

	slot_export_to_inkscape_svg

	slot_get_color_from_combobox

	slot_paletteChanged

	slot_remove_entry

	slot_sort_colors

	slot_swatchSelected

	sortColors

Public Member Functions

Public Attributes