The KisSwatchGroup class stores a matrix of color swatches swatches can accessed using (x, y) coordinates. x is the column number from left to right and y is the row number from top to bottom. Both x and y start at 0 there could be empty entries, so the checkEntry(int, int) method must used whenever you want to get an entry from the matrix. More...

#include <KisSwatchGroup.h>

Classes
struct	Private

Public Member Functions
bool	checkSwatchExists (int column, int row) const
	checkSwatch checks if position `column` and `row` has a valid entry both `column` and `row` start from 0

int	colorCount () const

KisSwatch	getSwatch (int column, int row) const
	getSwatch used to get the swatch entry at position (`column`, `row`) there is an assertion to make sure that this position isn't empty, so checkEntry(int, int) must be used before this method to ensure a valid entry can be found

QList< SwatchInfo >	infoList () const
	getColors

	KisSwatchGroup (const KisSwatchGroup &rhs)

QString	name () const

KisSwatchGroup &	operator= (const KisSwatchGroup &rhs)

int	rowCount () const

void	setName (const QString &name)

void	setRowCount (int newRowCount)

int	slotCount () const

	~KisSwatchGroup ()

Public Attributes
	: struct SwatchInfo { QString group

int	column

int	row

KisSwatch	swatch

Static Public Attributes
static int	DEFAULT_COLUMN_COUNT = 16

static int	DEFAULT_ROW_COUNT = 20

Private Member Functions
QPair< int, int >	addSwatch (const KisSwatch &e)
	addEntry adds the entry e to the right of the rightmost entry in the last row if the rightmost entry in the last row is in the right most column, add e to the leftmost column of a new row

void	clear ()

int	columnCount () const

	KisSwatchGroup ()

bool	removeSwatch (int column, int row)
	removeSwatch removes the entry at position (`column`, `row`)

void	setColumnCount (int columnCount)

void	setSwatch (const KisSwatch &e, int column, int row)
	setSwatch sets the entry at position (`column`, `row`) to be `e`

Private Attributes
std::experimental::propagate_const< std::unique_ptr< Private > >	d

Friends
struct	AddGroupCommand

struct	AddSwatchCommand

struct	ClearCommand

class	KisPaletteEditor

class	KoColorSet

struct	RemoveGroupCommand

struct	RemoveSwatchCommand

struct	SetColumnCountCommand

class	TestKisSwatchGroup

class	TestKoColorSet

Detailed Description

The KisSwatchGroup class stores a matrix of color swatches swatches can accessed using (x, y) coordinates. x is the column number from left to right and y is the row number from top to bottom. Both x and y start at 0 there could be empty entries, so the checkEntry(int, int) method must used whenever you want to get an entry from the matrix.

Definition at line 31 of file KisSwatchGroup.h.

Constructor & Destructor Documentation

◆ ~KisSwatchGroup()

KisSwatchGroup::~KisSwatchGroup ( )

Definition at line 29 of file KisSwatchGroup.cpp.

30{ }

◆ KisSwatchGroup() [1/2]

KisSwatchGroup::KisSwatchGroup ( const KisSwatchGroup & rhs )

Definition at line 32 of file KisSwatchGroup.cpp.

33 : d(new Private(*rhs.d))

34{ }

KisSwatchGroup::d

std::experimental::propagate_const< std::unique_ptr< Private > > d

Definition KisSwatchGroup.h:144

Private

Definition SvgTransformParser.cpp:20

◆ KisSwatchGroup() [2/2]

KisSwatchGroup::KisSwatchGroup ( )

private

Definition at line 25 of file KisSwatchGroup.cpp.

26 : d(new Private)

27{ }

Member Function Documentation

◆ addSwatch()

QPair< int, int > KisSwatchGroup::addSwatch ( const KisSwatch & e )

private

addEntry adds the entry e to the right of the rightmost entry in the last row if the rightmost entry in the last row is in the right most column, add e to the leftmost column of a new row

when column is set to 0, resize number of columns to default

Parameters

e

Definition at line 156 of file KisSwatchGroup.cpp.

{
    if (columnCount() == 0) {
        setColumnCount(DEFAULT_COLUMN_COUNT);
    }
 
    int y = 0;
    int x = 0;
    while (checkSwatchExists(x, y))
    {
        if(++x == d->colorMatrix.size())
        {
            x = 0;
            ++y;
        }
    }
    // clear color metadata for now.
    swatch.color().clearMetadata();
 
    setSwatch(swatch, x, y);
 
    return QPair<int, int> (x, y);
}

References checkSwatchExists(), KoColor::clearMetadata(), KisSwatch::color(), columnCount(), d, DEFAULT_COLUMN_COUNT, setColumnCount(), setSwatch(), and swatch.

◆ checkSwatchExists()

bool KisSwatchGroup::checkSwatchExists	(	int	column,
		int	row ) const

checkSwatch checks if position column and row has a valid entry both column and row start from 0

Parameters

column
row

Returns: true if there is a valid entry at position (column, row)

Definition at line 58 of file KisSwatchGroup.cpp.

{
    if (row >= d->rowCount) {
        return false;
    }
 
    if (column >= d->colorMatrix.size()){
        return false;
    }
 
    if (column < 0) {
        return false;
    }
 
    if (!d->colorMatrix[column].contains(row)) {
        return false;
    }
 
    if (!d->colorMatrix[column][row].isValid()) {
        return false;
    }
 
    return true;
}

References column, d, and row.

◆ clear()

void KisSwatchGroup::clear ( )

private

Definition at line 180 of file KisSwatchGroup.cpp.

{
    d->colorMatrix.clear();
}

References d.

◆ colorCount()

int KisSwatchGroup::colorCount ( ) const

Definition at line 203 of file KisSwatchGroup.cpp.

{
    return d->colorCount;
}

References d.

◆ columnCount()

int KisSwatchGroup::columnCount ( ) const

private

Definition at line 140 of file KisSwatchGroup.cpp.

                                      {
    return d->colorMatrix.size();
}

References d.

◆ getSwatch()

KisSwatch KisSwatchGroup::getSwatch	(	int	column,
		int	row ) const

getSwatch used to get the swatch entry at position (column, row) there is an assertion to make sure that this position isn't empty, so checkEntry(int, int) must be used before this method to ensure a valid entry can be found

Parameters

column
row

Returns: the swatch entry at position (column, row)

Definition at line 144 of file KisSwatchGroup.cpp.

{
    // This is perfectly normal when Krita gets initialized, so it needs an if, not an assert.
    // Getting -1, -1 is not a coding error.
    if (row < 0 || column < 0) return KisSwatch();
 
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(column >= 0 && column < d->colorMatrix.size(), KisSwatch());
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(row >= 0 && row < d->rowCount, KisSwatch());
 
    return d->colorMatrix[column][row];
}

References column, d, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, row, and rowCount().

◆ infoList()

QList< KisSwatchGroup::SwatchInfo > KisSwatchGroup::infoList ( ) const

getColors

Returns: the list of colors in this SwatchGroup, in no specific order.

Definition at line 213 of file KisSwatchGroup.cpp.

{
    QList<SwatchInfo> res;
    int column = 0;
    for (const Private::Column &c : d->colorMatrix) {
        int i = 0;
        for (const KisSwatch &s : c.values()) {
            SwatchInfo info = {d->name, s, c.keys()[i++], column};
            res.append(info);
        }
        column++;
    }
    return res;
}

References column, and d.

◆ name()

QString KisSwatchGroup::name ( ) const

Definition at line 233 of file KisSwatchGroup.cpp.

{
    return d->name;
}

References d.

◆ operator=()

KisSwatchGroup & KisSwatchGroup::operator= ( const KisSwatchGroup & rhs )

Definition at line 36 of file KisSwatchGroup.cpp.

{
    if (&rhs == this) {
        return *this;
    }
    *d = *rhs.d;
    return *this;
}

References d.

◆ removeSwatch()

bool KisSwatchGroup::removeSwatch	(	int	column,
		int	row )

private

removeSwatch removes the entry at position (column, row)

Parameters

column
row

Returns: true if these is an entry at (column, row)

Definition at line 83 of file KisSwatchGroup.cpp.

{
    if (d->colorCount == 0) {
        return false;
    }
 
    if (row >= d->rowCount || column >= d->colorMatrix.size() || column < 0) {
        return false;
    }
 
    // QMap::remove returns 1 if key found else 0
    if (d->colorMatrix[column].remove(row)) {
        d->colorCount -= 1;
        return true;
    } else {
        return false;
    }
}

References column, d, and row.

◆ rowCount()

int KisSwatchGroup::rowCount ( ) const

Definition at line 198 of file KisSwatchGroup.cpp.

{
    return d->rowCount;
}

References d.

◆ setColumnCount()

void KisSwatchGroup::setColumnCount ( int columnCount )

private

Definition at line 102 of file KisSwatchGroup.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(columnCount >= 1);
 
 
    // Move 'removed' swatches into new row
    QVector <KisSwatch> movedSwatches;
 
    for (int r = 0; r < rowCount(); r++ ) {
        for (int c = 0; c < d->colorMatrix.size(); c++ ) {
 
            if (c >= columnCount && checkSwatchExists(c, r)) {
                movedSwatches.push_back(getSwatch(c, r));
            }
        }
    }
    if ( !movedSwatches.isEmpty()) {
        for (int i = 0; i< movedSwatches.size(); i++) {
            int r = (i/columnCount) + d->rowCount;
            int c = (i%columnCount);
            d->colorMatrix[c][r] = movedSwatches.at(i);
        }
        d->rowCount += (movedSwatches.size()/columnCount);
        if (movedSwatches.size()%columnCount > 0) {
            d->rowCount += 1;
        }
    }
 
    if (columnCount < d->colorMatrix.size()) {
        int newColorCount = 0;
        for (int i = 0; i < columnCount; i++ ) {
            newColorCount += d->colorMatrix[i].size();
        }
        d->colorCount = newColorCount;
    }
    d->colorMatrix.resize(columnCount);
}

References checkSwatchExists(), columnCount(), d, getSwatch(), KIS_SAFE_ASSERT_RECOVER_RETURN, and rowCount().

◆ setName()

void KisSwatchGroup::setName ( const QString & name )

Definition at line 228 of file KisSwatchGroup.cpp.

{
    d->name = name;
}

References d, and name().

◆ setRowCount()

void KisSwatchGroup::setRowCount ( int newRowCount )

Definition at line 185 of file KisSwatchGroup.cpp.

{
    d->rowCount = newRowCount;
    for (Private::Column &c : d->colorMatrix) {
        for (int k : c.keys()) {
            if (k >= newRowCount) {
                c.remove(k);
                d->colorCount--;
            }
        }
    }
}

References d.

◆ setSwatch()

void KisSwatchGroup::setSwatch	(	const KisSwatch &	e,
		int	column,
		int	row )

private

setSwatch sets the entry at position (column, row) to be e

Parameters

e
column
row

Definition at line 45 of file KisSwatchGroup.cpp.

{
    Q_ASSERT(column < d->colorMatrix.size() && column >= 0 && row >= 0);
 
    if (row + 1 >= d->rowCount) {
        setRowCount(row + 1);
    }
    if (!checkSwatchExists(column, row)) {
        d->colorCount++;
    }
    d->colorMatrix[column][row] = e;
}

References checkSwatchExists(), column, d, row, and setRowCount().

◆ slotCount()

int KisSwatchGroup::slotCount ( ) const

Definition at line 208 of file KisSwatchGroup.cpp.

{
    return columnCount() * rowCount();
}

References columnCount(), and rowCount().

Friends And Related Symbol Documentation

◆ AddGroupCommand

friend struct AddGroupCommand

friend

Definition at line 93 of file KisSwatchGroup.h.

◆ AddSwatchCommand

friend struct AddSwatchCommand

friend

Definition at line 90 of file KisSwatchGroup.h.

◆ ClearCommand

friend struct ClearCommand

friend

Definition at line 94 of file KisSwatchGroup.h.

◆ KisPaletteEditor

friend class KisPaletteEditor

friend

Definition at line 102 of file KisSwatchGroup.h.

◆ KoColorSet

friend class KoColorSet

friend

Definition at line 89 of file KisSwatchGroup.h.

◆ RemoveGroupCommand

friend struct RemoveGroupCommand

friend

Definition at line 91 of file KisSwatchGroup.h.

◆ RemoveSwatchCommand

friend struct RemoveSwatchCommand

friend

Definition at line 92 of file KisSwatchGroup.h.

◆ SetColumnCountCommand

friend struct SetColumnCountCommand

friend

Definition at line 95 of file KisSwatchGroup.h.

◆ TestKisSwatchGroup

friend class TestKisSwatchGroup

friend

Definition at line 96 of file KisSwatchGroup.h.

◆ TestKoColorSet

friend class TestKoColorSet

friend

Definition at line 97 of file KisSwatchGroup.h.

Member Data Documentation

◆ pad0

KisSwatchGroup::__pad0__

Definition at line 153 of file KisSwatchGroup.h.

◆ column

int KisSwatchGroup::column

Definition at line 38 of file KisSwatchGroup.h.

◆ d

std::experimental::propagate_const<std::unique_ptr<Private> > KisSwatchGroup::d

private

Definition at line 144 of file KisSwatchGroup.h.

◆ DEFAULT_COLUMN_COUNT

int KisSwatchGroup::DEFAULT_COLUMN_COUNT = 16

static

Definition at line 43 of file KisSwatchGroup.h.

◆ DEFAULT_ROW_COUNT

int KisSwatchGroup::DEFAULT_ROW_COUNT = 20

static

Definition at line 44 of file KisSwatchGroup.h.

◆ row

int KisSwatchGroup::row

Definition at line 37 of file KisSwatchGroup.h.

◆ swatch

KisSwatch KisSwatchGroup::swatch

Definition at line 36 of file KisSwatchGroup.h.

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

libs/pigment/resources/KisSwatchGroup.h
libs/pigment/resources/KisSwatchGroup.cpp

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~KisSwatchGroup()

◆ KisSwatchGroup() [1/2]

◆ KisSwatchGroup() [2/2]

Member Function Documentation

◆ addSwatch()

◆ checkSwatchExists()

◆ clear()

◆ colorCount()

◆ columnCount()

◆ getSwatch()

◆ infoList()

◆ name()

◆ operator=()

◆ removeSwatch()

◆ rowCount()

◆ setColumnCount()

◆ setName()

◆ setRowCount()

◆ setSwatch()

◆ slotCount()

Friends And Related Symbol Documentation

◆ AddGroupCommand

◆ AddSwatchCommand

◆ ClearCommand

◆ KisPaletteEditor

◆ KoColorSet

◆ RemoveGroupCommand

◆ RemoveSwatchCommand

◆ SetColumnCountCommand

◆ TestKisSwatchGroup

◆ TestKoColorSet

Member Data Documentation

◆ __pad0__

◆ column

◆ d

◆ DEFAULT_COLUMN_COUNT

◆ DEFAULT_ROW_COUNT

◆ row

◆ swatch

◆ pad0