KisPaletteView Class Reference

#include <kis_palette_view.h>

Inheritance diagram for KisPaletteView:

Classes
struct	Private

Public Slots
void	slotFGColorChanged (const KoColor &)
void	slotScrollerStateChanged (QScroller::State state)

Signals
void	sigColorSelected (const KoColor &)
void	sigIndexSelected (const QModelIndex &index)

Public Member Functions
bool	addEntryWithDialog (KoColor color)
bool	addGroupWithDialog ()
const KoColor	closestColor (const KoColor &color) const
	closestColor determines closest swatch in the active palette and returns it's color as KoColor
	KisPaletteView (QWidget *parent=0)
KisPaletteModel *	paletteModel () const
bool	removeEntryWithDialog (QModelIndex index)
void	removeSelectedEntry ()
void	scrollTo (const QModelIndex &index, ScrollHint hint=EnsureVisible) override
void	selectClosestColor (const KoColor &color)
	selectClosestColor select a color that's closest to parameter color
void	setAllowModification (bool allow)
	setAllowModification Set whether doubleclick calls up a modification window. This is to prevent users from editing the palette when the palette is intended to be a list of items.
void	setCrossedKeyword (const QString &value)
	setCrossedKeyword This allows you to set keywords that can cross out colors. This is implemented to mark the lazybrush "transparent" color.
void	setDisplayRenderer (const KoColorDisplayRendererInterface *displayRenderer)
void	setPaletteModel (KisPaletteModel *model)
	~KisPaletteView () override

Private Slots
void	slotAdditionalGuiUpdate ()
void	slotCurrentSelectionChanged (const QModelIndex &newCurrent)
void	slotHorizontalHeaderResized (int, int, int newSize)

Private Member Functions
void	resizeRows (int newSize)
void	saveModification ()

Private Attributes
const QScopedPointer< Private >	d

Static Private Attributes
static int	MINIMUM_ROW_HEIGHT = 10

Detailed Description

Definition at line 24 of file kis_palette_view.h.

Constructor & Destructor Documentation

KisPaletteView()

KisPaletteView::KisPaletteView ( QWidget * parent = 0 )

explicit

Definition at line 45 of file kis_palette_view.cpp.

    : QTableView(parent)
    , d(new Private)
{
    setItemDelegate(new KisPaletteDelegate(this));
 
    setShowGrid(true);
    setDropIndicatorShown(true);
    setDragDropMode(QAbstractItemView::DragDrop);
    setSelectionMode(QAbstractItemView::SingleSelection);
    setDragEnabled(true);
    setAcceptDrops(false);
 
    /*
     * without this, a cycle might be created:
     * the view stretches to right border, and this make it need a scroll bar;
     * after the bar is added, the view shrinks to the bar, and this makes it
     * no longer need the bar any more, and the bar is removed again
     */
    setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
 
    // set the size of swatches
    horizontalHeader()->setVisible(false);
    verticalHeader()->setVisible(false);
    horizontalHeader()->setSectionResizeMode(QHeaderView::Stretch);
    horizontalHeader()->setMinimumSectionSize(MINIMUM_ROW_HEIGHT);
    verticalHeader()->setSectionResizeMode(QHeaderView::Fixed);
    verticalHeader()->setMinimumSectionSize(MINIMUM_ROW_HEIGHT);
 
#if QT_VERSION >= QT_VERSION_CHECK(6, 9, 0) && !KRITA_QT_HEADER_VIEW_MEMORY_MODE_INITIALIZATION_FIX
    // Qt 6.9.0 got a "feature" that lets QHeaderView avoid
    // memory allocations until some custom row/column size
    // request comes from the user. This feature has a problem.
    // When calling resizeSections(QHeaderView::Fixed) on a non-
    // empty header view, it half-initialized the header,
    // leaving it in a broken state. All the following
    // initialization requests will not be able to complete
    // or fix this state.
    //
    // Hence we should switch the header into "memory" mode
    // explicitly, while it has zero sections in it. It will
    // properly initialize it.
    //
    // Offending commit:
    // https://github.com/qt/qtbase/commit/9e3a96189d9db8a458e65cd5078509afe7a160db
    //
    // Krita's copy has a fix for this issue, which is declared by
    // a special definition.
 
    verticalHeader()->setStretchLastSection(true);
    verticalHeader()->setStretchLastSection(false);
    horizontalHeader()->setStretchLastSection(true);
    horizontalHeader()->setStretchLastSection(false);
#endif
 
    connect(horizontalHeader(), SIGNAL(sectionResized(int,int,int)),
            SLOT(slotHorizontalHeaderResized(int,int,int)));
    setAutoFillBackground(true);
 
    QScroller *scroller = KisKineticScroller::createPreconfiguredScroller(this);
    if (scroller) {
        connect(scroller, SIGNAL(stateChanged(QScroller::State)),
                this, SLOT(slotScrollerStateChanged(QScroller::State)));
    }
 
    connect(this, SIGNAL(clicked(QModelIndex)), SLOT(slotCurrentSelectionChanged(QModelIndex)));
}

References KisKineticScroller::createPreconfiguredScroller(), MINIMUM_ROW_HEIGHT, slotCurrentSelectionChanged(), slotHorizontalHeaderResized(), and slotScrollerStateChanged().

~KisPaletteView()

KisPaletteView::~KisPaletteView ( )

override

Definition at line 113 of file kis_palette_view.cpp.

{
}

Member Function Documentation

addEntryWithDialog()

bool KisPaletteView::addEntryWithDialog

(

KoColor

color

)

add an entry with a dialog window.

Warning

deprecated. kept for compatibility with PaletteView in libkis

Definition at line 126 of file kis_palette_view.cpp.

{
    KoDialog dialog;
    dialog.setWindowTitle(i18nc("@title:dialog", "Add a new Color Swatch"));
    QFormLayout *editableItems = new QFormLayout(dialog.mainWidget());
 
    QComboBox *cmbGroups = new QComboBox;
    QString defaultGroupName = i18nc("Name for default swatch group", "Default");
    cmbGroups->addItem(defaultGroupName);
    cmbGroups->addItems(d->model->colorSet()->swatchGroupNames());
    QLineEdit *lnIDName = new QLineEdit;
    QLineEdit *lnName = new QLineEdit;
    KisColorButton *bnColor = new KisColorButton;
    QCheckBox *chkSpot = new QCheckBox;
    chkSpot->setToolTip(i18nc("@info:tooltip", "A spot color is a color that the printer is able to print without mixing the paints it has available to it. The opposite is called a process color."));
    editableItems->addRow(i18n("Swatch Group:"), cmbGroups);
    editableItems->addRow(i18n("Swatch ID:"), lnIDName);
    editableItems->addRow(i18n("Color swatch name:"), lnName);
    editableItems->addRow(i18nc("Color as the Color of a Swatch in a Palette", "Color:"), bnColor);
    editableItems->addRow(i18n("Spot color:"), chkSpot);
    cmbGroups->setCurrentIndex(0);
    lnName->setText(i18nc("Prefix of a color swatch default name, as in Color 1","Color")+" " + QString::number(d->model->colorSet()->colorCount()+1));
    lnIDName->setText(QString::number(d->model->colorSet()->colorCount() + 1));
    bnColor->setColor(color);
    chkSpot->setChecked(false);
 
    if (dialog.exec() == KoDialog::Accepted) {
        QString groupName = cmbGroups->currentText();
        if (groupName == defaultGroupName) {
            groupName = QString();
        }
        KisSwatch newEntry;
        newEntry.setColor(bnColor->color());
        newEntry.setName(lnName->text());
        newEntry.setId(lnIDName->text());
        newEntry.setSpotColor(chkSpot->isChecked());
        d->model->addSwatch(newEntry, groupName);
        saveModification();
        return true;
    }
 
    return false;
}

References KisColorButton::color, d, saveModification(), KisColorButton::setColor(), KisSwatch::setColor(), KisSwatch::setId(), KisSwatch::setName(), and KisSwatch::setSpotColor().

addGroupWithDialog()

bool KisPaletteView::addGroupWithDialog

(

)

add entry with a dialog window.

Warning

deprecated. kept for compatibility with PaletteView in libkis

Definition at line 170 of file kis_palette_view.cpp.

{
    KoDialog dialog;
    dialog.setWindowTitle(i18nc("@title:dialog","Add a new group"));
    QFormLayout *editableItems = new QFormLayout(dialog.mainWidget());
    QLineEdit *lnName = new QLineEdit();
    lnName->setText(i18nc("Part of default name for a new group", "Color Group")+""+QString::number(d->model->colorSet()->swatchGroupNames().size()+1));
    editableItems->addRow(i18nc("Name for a group", "Name"), lnName);
 
    if (dialog.exec() == KoDialog::Accepted) {
        d->model->addGroup(lnName->text());
        saveModification();
        return true;
    }
    return false;
}

References d, and saveModification().

closestColor()

const KoColor KisPaletteView::closestColor

(

const KoColor &

color

)

const

closestColor determines closest swatch in the active palette and returns it's color as KoColor

Parameters

color

Returns

KoColor

Definition at line 232 of file kis_palette_view.cpp.

{
    QModelIndex index = d->model->indexForClosest(color);
    KisSwatch swatch = d->model->getSwatch(index);
    return swatch.color();
}

References KisSwatch::color(), and d.

paletteModel()

KisPaletteModel * KisPaletteView::paletteModel

(

)

const

Definition at line 259 of file kis_palette_view.cpp.

{
    return d->model;
}

References d.

removeEntryWithDialog()

bool KisPaletteView::removeEntryWithDialog

(

QModelIndex

index

)

remove entry with a dialog window.(Necessary for groups.

Warning

deprecated. kept for compatibility with PaletteView in libkis

Definition at line 194 of file kis_palette_view.cpp.

{
    bool keepColors = false;
    if (qvariant_cast<bool>(index.data(KisPaletteModel::IsGroupNameRole))) {
        KoDialog dialog;
        dialog.setWindowTitle(i18nc("@title:dialog","Removing Group"));
        QFormLayout *editableItems = new QFormLayout(dialog.mainWidget());
        QCheckBox *chkKeep = new QCheckBox();
        editableItems->addRow(i18nc("Shows up when deleting a swatch group", "Keep the Colors"), chkKeep);
 
        if (dialog.exec() != KoDialog::Accepted) { return false; }
        keepColors = chkKeep->isChecked();
    }
    d->model->removeSwatch(index, keepColors);
 
    saveModification();
 
    return true;
}

References d, KisPaletteModel::IsGroupNameRole, and saveModification().

removeSelectedEntry()

void KisPaletteView::removeSelectedEntry

(

)

Definition at line 286 of file kis_palette_view.cpp.

{
    if (selectedIndexes().size() <= 0) {
        return;
    }
    d->model->removeSwatch(currentIndex());
}

References d.

resizeRows()

void KisPaletteView::resizeRows ( int newSize )

private

Definition at line 275 of file kis_palette_view.cpp.

{
    verticalHeader()->setDefaultSectionSize(newSize);
    verticalHeader()->resizeSections(QHeaderView::Fixed);
}

saveModification()

void KisPaletteView::saveModification ( )

private

Definition at line 281 of file kis_palette_view.cpp.

{
    KisResourceUserOperations::updateResourceWithUserInput(this, d->model->colorSet());
}

References d, and KisResourceUserOperations::updateResourceWithUserInput().

scrollTo()

void KisPaletteView::scrollTo ( const QModelIndex & index, ScrollHint hint = EnsureVisible )

override

Definition at line 187 of file kis_palette_view.cpp.

{
    if(!d->foregroundColorChangeInProgress) {
        QTableView::scrollTo(index, hint);
    }
}

References d.

selectClosestColor()

void KisPaletteView::selectClosestColor

(

const KoColor &

color

)

selectClosestColor select a color that's closest to parameter color

Parameters

color

Definition at line 214 of file kis_palette_view.cpp.

{
    KoColorSetSP colorSet = d->model->colorSet();
    if (!colorSet || !colorSet->valid() || currentIndex().row() < 0) {
        return;
    }
 
    //also don't select if the color is the same as the current selection
    if (d->model->getSwatch(currentIndex()).color() == color) {
        return;
    }
 
    selectionModel()->clearSelection();
    QModelIndex index = d->model->indexForClosest(color);
 
    selectionModel()->setCurrentIndex(index, QItemSelectionModel::Select);
}

References d.

setAllowModification()

void KisPaletteView::setAllowModification

(

bool

allow

)

setAllowModification Set whether doubleclick calls up a modification window. This is to prevent users from editing the palette when the palette is intended to be a list of items.

Definition at line 264 of file kis_palette_view.cpp.

{
    setAcceptDrops(allow);
}

setCrossedKeyword()

void KisPaletteView::setCrossedKeyword

(

const QString &

value

)

setCrossedKeyword This allows you to set keywords that can cross out colors. This is implemented to mark the lazybrush "transparent" color.

Parameters

value

Definition at line 117 of file kis_palette_view.cpp.

{
    KisPaletteDelegate *delegate =
        dynamic_cast<KisPaletteDelegate*>(itemDelegate());
    KIS_ASSERT_RECOVER_RETURN(delegate);
 
    delegate->setCrossedKeyword(value);
}

References KIS_ASSERT_RECOVER_RETURN, KisPaletteDelegate::setCrossedKeyword(), and value().

setDisplayRenderer()

void KisPaletteView::setDisplayRenderer

(

const KoColorDisplayRendererInterface *

displayRenderer

)

Definition at line 335 of file kis_palette_view.cpp.

{
    Q_ASSERT(d->model);
    d->model->setDisplayRenderer(displayRenderer);
}

References d.

setPaletteModel()

void KisPaletteView::setPaletteModel

(

KisPaletteModel *

model

)

Definition at line 245 of file kis_palette_view.cpp.

{
    if (d->model) {
        disconnect(d->model, 0, this, 0);
    }
    d->model = model;
    setModel(model);
    slotAdditionalGuiUpdate();
 
    connect(model, SIGNAL(rowsInserted(QModelIndex,int,int)), SLOT(slotAdditionalGuiUpdate()));
    connect(model, SIGNAL(rowsMoved(QModelIndex,int,int,QModelIndex,int)), SLOT(slotAdditionalGuiUpdate()));
    connect(model, SIGNAL(modelReset()), SLOT(slotAdditionalGuiUpdate()));
}

References d, and slotAdditionalGuiUpdate().

sigColorSelected

void KisPaletteView::sigColorSelected ( const KoColor & )

signal

sigIndexSelected

void KisPaletteView::sigIndexSelected ( const QModelIndex & index )

signal

slotAdditionalGuiUpdate

void KisPaletteView::slotAdditionalGuiUpdate ( )

privateslot

Definition at line 294 of file kis_palette_view.cpp.

{
    /*
     * Note: QTableView (Qt 5.15) does not clear spans on model resets.
     * But it does move spans on row inserts/removals, so incremental updates
     * would be possible.
     * Moving rows on the other hand does NOT update row spans accordingly...
     */
    if (!d->model->colorSet()) return;
 
    clearSpans();
    resizeRows(verticalHeader()->defaultSectionSize());
 
    for (const QString &groupName : d->model->colorSet()->swatchGroupNames()) {
        if (groupName.isEmpty()) continue;
 
        int rowNumber = d->model->colorSet()->startRowForGroup(groupName);
        setSpan(rowNumber, 0, 1, d->model->columnCount());
        setRowHeight(rowNumber, fontMetrics().lineSpacing() + 6);
    }
}

References d, and resizeRows().

slotCurrentSelectionChanged

void KisPaletteView::slotCurrentSelectionChanged ( const QModelIndex & newCurrent )

privateslot

Definition at line 316 of file kis_palette_view.cpp.

{
    if (!newCurrent.isValid()) { return; }
 
    const bool isGroupName = newCurrent.data(KisPaletteModel::IsGroupNameRole).toBool();
    const bool isCheckSlot = newCurrent.data(KisPaletteModel::CheckSlotRole).toBool();
 
    const KisSwatch newEntry = d->model->getSwatch(newCurrent);
 
    Q_EMIT sigIndexSelected(newCurrent);
    if (isGroupName) {
        return;
    }
 
    if (isCheckSlot) {
        Q_EMIT sigColorSelected(newEntry.color());
    }
}

References KisPaletteModel::CheckSlotRole, KisSwatch::color(), d, KisPaletteModel::IsGroupNameRole, sigColorSelected(), and sigIndexSelected().

slotFGColorChanged

void KisPaletteView::slotFGColorChanged ( const KoColor & color )

slot

This tries to select the closest color in the palette. This doesn't update the foreground color, just the visual selection.

Definition at line 239 of file kis_palette_view.cpp.

{
    QScopedValueRollback<bool> rollback(d->foregroundColorChangeInProgress, true);
    selectClosestColor(color);
}

References d, and selectClosestColor().

slotHorizontalHeaderResized

void KisPaletteView::slotHorizontalHeaderResized ( int , int , int newSize )

privateslot

Definition at line 269 of file kis_palette_view.cpp.

{
    resizeRows(newSize);
    slotAdditionalGuiUpdate();
}

References resizeRows(), and slotAdditionalGuiUpdate().

slotScrollerStateChanged

void KisPaletteView::slotScrollerStateChanged ( QScroller::State state )

inlineslot

Definition at line 106 of file kis_palette_view.h.

{KisKineticScroller::updateCursor(this, state);}

References KisKineticScroller::updateCursor().

Member Data Documentation

d

const QScopedPointer<Private> KisPaletteView::d

private

Definition at line 119 of file kis_palette_view.h.

MINIMUM_ROW_HEIGHT

int KisPaletteView::MINIMUM_ROW_HEIGHT = 10

staticprivate

Definition at line 28 of file kis_palette_view.h.

---

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

• libs/widgets/kis_palette_view.h
• libs/widgets/kis_palette_view.cpp