#include <KoColorSet.h>

Inheritance diagram for KoColorSet:

Classes
class	Private

Public Types
enum	PaletteType { UNKNOWN = 0 , GPL , RIFF_PAL , ACT , PSP_PAL , ACO , XML , KPL , SBZ , ASE , ACB , CSS }

Signals
void	entryChanged (int column, int row)

void	layoutAboutToChange ()

void	layoutChanged ()

void	modified ()

Public Member Functions
void	addGroup (const QString &groupName, int columnCount=KisSwatchGroup::DEFAULT_COLUMN_COUNT, int rowCount=KisSwatchGroup::DEFAULT_ROW_COUNT)
	addGroup Adds a new group.

void	addSwatch (const KisSwatch &swatch, const QString &groupName=GLOBAL_GROUP_NAME, int column=-1, int row=-1)
	Add a color to the palette.

void	changeGroupName (const QString &oldGroupName, const QString &newGroupName)
	changeGroupName

void	clear ()
	clears the complete colorset

KoResourceSP	clone () const override

quint32	colorCount () const

int	columnCount () const

QString	comment ()

QString	defaultFileExtension () const override

bool	fromByteArray (QByteArray &data, KisResourcesInterfaceSP resourcesInterface)

KisSwatchGroup::SwatchInfo	getClosestSwatchInfo (KoColor compare, bool useGivenColorSpace=true) const
	getIndexClosestColor function that matches the color to all colors in the colorset, and returns the index of the closest match.

KisSwatch	getColorGlobal (quint32 column, quint32 row) const
	getColorGlobal A function for getting a color based on a global index. Useful for iterating through all color entries.

KisSwatchGroupSP	getGlobalGroup () const
	getGlobalGroup

KisSwatchGroupSP	getGroup (const QString &name) const
	getGroup

KisSwatchGroupSP	getGroup (int row) const
	getGroup get the group that covers this row

KisSwatch	getSwatchFromGroup (quint32 column, quint32 row, QString groupName=KoColorSet::GLOBAL_GROUP_NAME) const
	getColorGroup A function for getting the color from a specific group.

bool	isGroupTitleRow (int row) const
	isGroupRow checks whether the current row is a group title

bool	isLocked () const

	KoColorSet (const KoColorSet &rhs)
	Create an copied palette.

	KoColorSet (const QString &filename=QString())

bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override

void	moveGroup (const QString &groupName, const QString &groupNameInsertBefore=GLOBAL_GROUP_NAME)
	moveGroup Move a group in the internal stringlist.

KoColorSet &	operator= (const KoColorSet &rhs)=delete

PaletteType	paletteType () const

void	removeGroup (const QString &groupName, bool keepColors=true)
	removeGroup Remove a group from the KoColorSet

void	removeSwatch (int column, int row, KisSwatchGroupSP group)
	remove the swatch from the given group at column and row

QPair< QString, QString >	resourceType () const override

int	rowCount () const

int	rowCountWithTitles () const

int	rowNumberInGroup (int rowNumber) const
	rowNumberInGroup calculates the row number in the group from the global rownumber

bool	saveToDevice (QIODevice *dev) const override

void	setColumnCount (int columns)

void	setComment (QString comment)

void	setLocked (bool lock)

void	setPaletteType (PaletteType paletteType)

quint32	slotCount () const

int	startRowForGroup (const QString &groupName) const
	rowForNamedGroup returns the row the group's title is on

QStringList	swatchGroupNames () const
	getGroupNames

KUndo2Stack *	undoStack () const

void	updateThumbnail () override
	updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.

	~KoColorSet () override

Public Member Functions inherited from KoResource
bool	active () const

void	addMetaData (QString key, QVariant value)
	store the given key, value pair in the resource

virtual void	clearSideLoadedResources ()

virtual QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const

QString	filename () const

QImage	image () const

bool	isDirty () const

virtual bool	isEphemeral () const

virtual bool	isSerializable () const

	KoResource ()

	KoResource (const KoResource &rhs)

	KoResource (const QString &filename)

virtual QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const

bool	load (KisResourcesInterfaceSP resourcesInterface)

QString	md5Sum (bool generateIfEmpty=true) const

QMap< QString, QVariant >	metadata () const
	get a map with all the metadata

virtual QString	name () const

KoResource &	operator= (const KoResource &rhs)=delete

bool	permanent () const

virtual QList< int >	requiredCanvasResources () const

QList< KoResourceLoadResult >	requiredResources (KisResourcesInterfaceSP globalResourcesInterface) const

int	resourceId () const

bool	save ()

void	setActive (bool active)

void	setDirty (bool value)
	Mark the preset as modified but not saved.

void	setFilename (const QString &filename)

void	setImage (const QImage &image)

void	setMD5Sum (const QString &md5sum)
	Set the md5sum of this resource. It must be in hex-encoded string format.

void	setName (const QString &name)

void	setPermanent (bool permanent)

void	setResourceId (int id)

void	setStorageLocation (const QString &location)

void	setValid (bool valid)

void	setVersion (int version)

virtual QList< KoResourceLoadResult >	sideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface) const

KoResourceSignature	signature () const

QString	storageLocation () const

QList< KoResourceLoadResult >	takeSideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface)

virtual QImage	thumbnail () const
	thumbnail the thumbnail image to use in resource selectors

virtual QString	thumbnailPath () const
	thumbnailPath returns the path to a separate thumbnail image, outside the actual resource file itself. If the path is relative, it is supposed start in the same location as the resource itself. If it's absolute, that is, it starts with "/", it is from the root of the storage.

bool	valid () const

int	version () const
	Get the version of the resource.

virtual	~KoResource ()

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Static Public Attributes
static const QString	GLOBAL_GROUP_NAME = QString()

static const QString	KPL_COLOR_DEPTH_ID_ATTR = "colorDepthId"

static const QString	KPL_COLOR_MODEL_ID_ATTR = "colorModelId"

static const QString	KPL_GROUP_NAME_ATTR = "name"

static const QString	KPL_GROUP_ROW_COUNT_ATTR = "rows"

static const QString	KPL_GROUP_TAG = "Group"

static const QString	KPL_PALETTE_COLUMN_COUNT_ATTR = "columns"

static const QString	KPL_PALETTE_COMMENT_ATTR = "comment"

static const QString	KPL_PALETTE_FILENAME_ATTR = "filename"

static const QString	KPL_PALETTE_NAME_ATTR = "name"

static const QString	KPL_PALETTE_PROFILE_TAG = "Profile"

static const QString	KPL_PALETTE_READONLY_ATTR = "readonly"

static const QString	KPL_PALETTE_TAG = "ColorSet"

static const QString	KPL_SWATCH_BITDEPTH_ATTR = "bitdepth"

static const QString	KPL_SWATCH_COL_ATTR = "column"

static const QString	KPL_SWATCH_ID_ATTR = "id"

static const QString	KPL_SWATCH_NAME_ATTR = "name"

static const QString	KPL_SWATCH_POS_TAG = "Position"

static const QString	KPL_SWATCH_ROW_ATTR = "row"

static const QString	KPL_SWATCH_SPOT_ATTR = "spot"

static const QString	KPL_SWATCH_TAG = "ColorSetEntry"

static const QString	KPL_VERSION_ATTR = "version"

Private Slots
void	canRedoChanged (bool canRedo)

void	canUndoChanged (bool canUndo)

Private Member Functions
void	notifySwatchChanged (const QString &groupName, int column, int row)

void	setModified (bool)

Private Attributes
const QScopedPointer< Private >	d

Friends
struct	AddGroupCommand

struct	AddSwatchCommand

struct	ChangeGroupNameCommand

struct	ClearCommand

struct	MoveGroupCommand

struct	RemoveGroupCommand

struct	RemoveSwatchCommand

struct	SetColumnCountCommand

struct	SetCommentCommand

struct	SetPaletteTypeCommand

class	TestKisPaletteModel

class	TestKoColorSet

Additional Inherited Members
Public Attributes inherited from KoResource
bool	active {true}

QString	filename

QImage	image

QString	md5sum

QMap< QString, QVariant >	metadata

bool	modified {false}

QString	name

bool	permanent {false}

int	resourceId {-1}

QString	storageLocation

bool	valid {false}

int	version {-1}

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Detailed Description

Also called palette. Open Gimp, Photoshop or RIFF palette files. This is a straight port from the Gimp.

Definition at line 28 of file KoColorSet.h.

Member Enumeration Documentation

◆ PaletteType

enum KoColorSet::PaletteType

Enumerator
UNKNOWN
GPL
RIFF_PAL
ACT
PSP_PAL
ACO
XML
KPL
SBZ
ASE
ACB
CSS

Definition at line 57 of file KoColorSet.h.

                     {
        UNKNOWN = 0,
        GPL,                // GIMP
        RIFF_PAL,           // RIFF
        ACT,                // Photoshop binary
        PSP_PAL,            // PaintShop Pro
        ACO,                // Photoshop Swatches
        XML,                // XML palette (Scribus)
        KPL,                // KoColor-based XML palette
        SBZ,                // SwatchBooker
        ASE,                // Adobe swatch exchange
        ACB,                // Adobe Color Book.
        CSS                 // CSS palette
    };

Constructor & Destructor Documentation

◆ KoColorSet() [1/2]

KoColorSet::KoColorSet ( const QString & filename = QString() )

explicit

Load a color set from a file. This can be a Gimp palette, a RIFF palette, a Photoshop palette, a Krita palette, a Scribus palette or a SwatchBooker palette.

Definition at line 561 of file KoColorSet.cpp.

    : QObject()
    , KoResource(filename)
    , d(new Private(this))
{
    connect(&d->undoStack, SIGNAL(canUndoChanged(bool)), this, SLOT(canUndoChanged(bool)));
    connect(&d->undoStack, SIGNAL(canRedoChanged(bool)), this, SLOT(canRedoChanged(bool)));
}

References canRedoChanged(), canUndoChanged(), connect(), and d.

◆ KoColorSet() [2/2]

KoColorSet::KoColorSet ( const KoColorSet & rhs )

Create an copied palette.

Definition at line 571 of file KoColorSet.cpp.

    : QObject()
    , KoResource(rhs)
    , d(new Private(this))
{
    d->paletteType = rhs.d->paletteType;
    d->data = rhs.d->data;
    d->comment = rhs.d->comment;
    d->swatchGroups = rhs.d->swatchGroups;
}

References d.

◆ ~KoColorSet()

KoColorSet::~KoColorSet ( )

override

Definition at line 582 of file KoColorSet.cpp.

583{

584}

Member Function Documentation

◆ addGroup()

void KoColorSet::addGroup	(	const QString &	groupName,
		int	columnCount = KisSwatchGroup::DEFAULT_COLUMN_COUNT,
		int	rowCount = KisSwatchGroup::DEFAULT_ROW_COUNT )

addGroup Adds a new group.

Parameters

groupName the name of the new group. When not specified, this will fail.

Returns: whether the group was made.

Definition at line 842 of file KoColorSet.cpp.

{
    if (swatchGroupNames().contains(groupName) || d->isLocked) return;
 
    AddGroupCommand *cmd = new AddGroupCommand(this, groupName, columnCount, rowCount);
 
    d->undoStack.push(cmd);
}

References AddGroupCommand, columnCount(), d, rowCount(), and swatchGroupNames().

◆ addSwatch()

void KoColorSet::addSwatch	(	const KisSwatch &	swatch,
		const QString &	groupName = GLOBAL_GROUP_NAME,
		int	column = -1,
		int	row = -1 )

Add a color to the palette.

Parameters

c	the swatch
groupName	color to add the group to. If empty, it will be added to the unsorted.
column.	The column in the group
row.	The row in the group

Definition at line 643 of file KoColorSet.cpp.

{
    if (d->isLocked) return;
 
    AddSwatchCommand *cmd = new AddSwatchCommand(this, swatch, groupName, column, row);
 
    d->undoStack.push(cmd);
 
}

References AddSwatchCommand, and d.

◆ canRedoChanged

void KoColorSet::canRedoChanged ( bool canRedo )

privateslot

Definition at line 794 of file KoColorSet.cpp.

{
    if (d->undoStack.canUndo()) {
        setModified(true);
    }
    else {
        setModified(false);
    }
}

References d, and setModified().

◆ canUndoChanged

void KoColorSet::canUndoChanged ( bool canUndo )

privateslot

Definition at line 784 of file KoColorSet.cpp.

{
    if (canUndo) {
        setModified(true);
    }
    else {
        setModified(false);
    }
}

References setModified().

◆ changeGroupName()

void KoColorSet::changeGroupName	(	const QString &	oldGroupName,
		const QString &	newGroupName )

changeGroupName

Parameters

oldGroupName
newGroupName

Definition at line 804 of file KoColorSet.cpp.

{
    if (!swatchGroupNames().contains(oldGroupName) || (oldGroupName == newGroupName) || d->isLocked) return;
 
    ChangeGroupNameCommand *cmd = new ChangeGroupNameCommand(this, oldGroupName, newGroupName);
    d->undoStack.push(cmd);
}

References ChangeGroupNameCommand, d, and swatchGroupNames().

◆ clear()

void KoColorSet::clear ( )

clears the complete colorset

Definition at line 661 of file KoColorSet.cpp.

{
    if (d->isLocked) return;
 
    ClearCommand *cmd = new ClearCommand(this);
 
    d->undoStack.push(cmd);
}

References ClearCommand, and d.

◆ clone()

KoResourceSP KoColorSet::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 586 of file KoColorSet.cpp.

{
    return KoResourceSP(new KoColorSet(*this));
}

References KoColorSet().

◆ colorCount()

quint32 KoColorSet::colorCount ( ) const

Definition at line 908 of file KoColorSet.cpp.

{
    int colorCount = 0;
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        colorCount += group->colorCount();
    }
    return colorCount;
}

References colorCount(), and d.

◆ columnCount()

int KoColorSet::columnCount ( ) const

Definition at line 821 of file KoColorSet.cpp.

{
    Q_ASSERT(d->swatchGroups.size() > 0);
 
    return d->swatchGroups.first()->columnCount();
}

References d.

◆ comment()

QString KoColorSet::comment ( )

Definition at line 828 of file KoColorSet.cpp.

{
    return d->comment;
}

References d.

◆ defaultFileExtension()

QString KoColorSet::defaultFileExtension ( ) const

overridevirtual

Returns: the default file extension which should be used when saving the resource

Reimplemented from KoResource.

Definition at line 874 of file KoColorSet.cpp.

{
    return (d->paletteType == GPL) ? ".gpl" : ".kpl";
}

References d, and GPL.

◆ entryChanged

void KoColorSet::entryChanged	(	int	column,
		int	row )

signal

◆ fromByteArray()

bool KoColorSet::fromByteArray	(	QByteArray &	data,
		KisResourcesInterfaceSP	resourcesInterface )

Definition at line 621 of file KoColorSet.cpp.

{
    QBuffer buf(&data);
    buf.open(QIODevice::ReadOnly);
    return loadFromDevice(&buf, resourcesInterface);
}

References loadFromDevice().

◆ getClosestSwatchInfo()

KisSwatchGroup::SwatchInfo KoColorSet::getClosestSwatchInfo	(	KoColor	compare,
		bool	useGivenColorSpace = true ) const

getIndexClosestColor function that matches the color to all colors in the colorset, and returns the index of the closest match.

Parameters

compare	the color you wish to compare.
useGivenColorSpace	whether to use the color space of the color given when the two colors' colorspaces don't match. Else it'll use the entry's colorspace.

Returns: returns the int of the closest match.

Definition at line 981 of file KoColorSet.cpp.

{
    KisSwatchGroup::SwatchInfo closestSwatch;
 
    quint8 highestPercentage = 0;
    quint8 testPercentage = 0;
 
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        for (const KisSwatchGroup::SwatchInfo &currInfo : group->infoList()) {
            KoColor color = currInfo.swatch.color();
            if (useGivenColorSpace == true && compare.colorSpace() != color.colorSpace()) {
                color.convertTo(compare.colorSpace());
 
            } else if (compare.colorSpace() != color.colorSpace()) {
                compare.convertTo(color.colorSpace());
            }
            testPercentage = (255 - compare.colorSpace()->difference(compare.data(), color.data()));
            if (testPercentage > highestPercentage)
            {
                highestPercentage = testPercentage;
                closestSwatch = currInfo;
            }
        }
    }
    return closestSwatch;
}

References KoColor::colorSpace(), KoColor::convertTo(), d, KoColor::data(), and KoColorSpace::difference().

◆ getColorGlobal()

KisSwatch KoColorSet::getColorGlobal	(	quint32	column,
		quint32	row ) const

getColorGlobal A function for getting a color based on a global index. Useful for iterating through all color entries.

Parameters

x	the global x index over the whole palette.
y	the global y index over the whole palette.

Returns: the entry.

Definition at line 670 of file KoColorSet.cpp.

{
    KisSwatchGroupSP group = getGroup(row);
    Q_ASSERT(group);
 
    int titleRow = startRowForGroup(group->name());
    int rowInGroup = -1;
 
    if (group->name().isEmpty()) {
        rowInGroup = (int)row - titleRow;
    }
    else {
        rowInGroup = (int)row - (titleRow + 1);
    }
 
    Q_ASSERT((isGroupTitleRow(titleRow) && titleRow > 0) || titleRow == 0);
    Q_ASSERT(rowInGroup < group->rowCount());
 
    return group->getSwatch(column, rowInGroup);
 
}

References getGroup(), isGroupTitleRow(), rowCount(), and startRowForGroup().

◆ getGlobalGroup()

KisSwatchGroupSP KoColorSet::getGlobalGroup ( ) const

getGlobalGroup

Returns

Definition at line 974 of file KoColorSet.cpp.

{
    Q_ASSERT(d->swatchGroups.size() > 0);
    Q_ASSERT(d->swatchGroups.first()->name() == GLOBAL_GROUP_NAME);
    return d->swatchGroups.first();
}

References d, and GLOBAL_GROUP_NAME.

◆ getGroup() [1/2]

KisSwatchGroupSP KoColorSet::getGroup ( const QString & name ) const

getGroup

Parameters

name

Returns: the group with the name given; global group if no parameter is given null pointer if not found.

Definition at line 926 of file KoColorSet.cpp.

{
    for (KisSwatchGroupSP &group : d->swatchGroups) {
        if (group->name() == name) {
            return group;
        }
    }
    return 0;
}

References d, and KoResource::name.

◆ getGroup() [2/2]

KisSwatchGroupSP KoColorSet::getGroup ( int row ) const

getGroup get the group that covers this row

Parameters

row

Returns: a swatch group

Definition at line 936 of file KoColorSet.cpp.

{
//    qDebug() << "------------";
 
    if (row >= rowCountWithTitles()) return nullptr;
 
    int currentRow = 0;
 
    for (KisSwatchGroupSP &group : d->swatchGroups) {
 
        int groupRowCount = group->rowCount();
        if (group->name() != KoColorSet::GLOBAL_GROUP_NAME) {
            groupRowCount++;
        }
 
//        qDebug() << group->name()
//                 << "row" << row << "currentRow" << currentRow << "group rowcount" << groupRowCount
//                 << "hit" << (currentRow <= row && row < currentRow + groupRowCount);
 
        bool hit = (currentRow <= row && row < currentRow + groupRowCount);
 
        if  (hit) {
            return group;
        }
 
        currentRow += group->rowCount();
 
        if (group->name() != KoColorSet::GLOBAL_GROUP_NAME) {
             currentRow += 1;
        }
 
        if (currentRow >= rowCountWithTitles()) return nullptr;
    }
 
    return nullptr;
 
}

References d, GLOBAL_GROUP_NAME, and rowCountWithTitles().

◆ getSwatchFromGroup()

KisSwatch KoColorSet::getSwatchFromGroup	(	quint32	column,
		quint32	row,
		QString	groupName = KoColorSet::GLOBAL_GROUP_NAME ) const

getColorGroup A function for getting the color from a specific group.

Parameters

x	the x index over the group.
y	the y index over the group.
groupName	the name of the group, will give unsorted when not defined.

Returns: the entry

Definition at line 692 of file KoColorSet.cpp.

{
    KisSwatch swatch;
    for (const KisSwatchGroupSP &group: d->swatchGroups) {
        if (group->name() == groupName) {
            if (group->checkSwatchExists(column, row)) {
                swatch = group->getSwatch(column, row);
            }
            break;
        }
    }
    return swatch;
}

References d.

◆ isGroupTitleRow()

bool KoColorSet::isGroupTitleRow ( int row ) const

isGroupRow checks whether the current row is a group title

Parameters

row	the row to check

Returns: true if this is a group row

Definition at line 715 of file KoColorSet.cpp.

{
    int idx = 0;
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        idx += group->rowCount();
        if (group->name() != KoColorSet::GLOBAL_GROUP_NAME) {
            idx++;
        }
        if (idx == row) {
            return true;
        }
    }
    return false;
}

References d, and GLOBAL_GROUP_NAME.

◆ isLocked()

bool KoColorSet::isLocked ( ) const

Definition at line 889 of file KoColorSet.cpp.

{
    return d->isLocked;
}

References d.

◆ layoutAboutToChange

void KoColorSet::layoutAboutToChange ( )

signal

◆ layoutChanged

void KoColorSet::layoutChanged ( )

signal

◆ loadFromDevice()

bool KoColorSet::loadFromDevice	(	QIODevice *	dev,
		KisResourcesInterfaceSP	resourcesInterface )

overridevirtual

Implements KoResource.

Definition at line 591 of file KoColorSet.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    if (!dev->isOpen()) dev->open(QIODevice::ReadOnly);
 
    d->data = dev->readAll();
 
    Q_ASSERT(d->data.size() != 0);
 
    return d->init();
}

References d.

◆ modified

void KoColorSet::modified ( )

signal

◆ moveGroup()

void KoColorSet::moveGroup	(	const QString &	groupName,
		const QString &	groupNameInsertBefore = GLOBAL_GROUP_NAME )

moveGroup Move a group in the internal stringlist.

Parameters

groupName	the groupname to move.
groupNameInsertBefore	the groupname to insert before. Empty means it will be added to the end.

Returns

Definition at line 851 of file KoColorSet.cpp.

{
    QStringList groupNames = swatchGroupNames();
    if (!groupNames.contains(groupName)
            || !groupNames.contains(groupNameInsertBefore)
            || d->isLocked) return;
 
    MoveGroupCommand *cmd = new MoveGroupCommand(this, groupName, groupNameInsertBefore);
 
    d->undoStack.push(cmd);
 
}

References d, MoveGroupCommand, and swatchGroupNames().

◆ notifySwatchChanged()

void KoColorSet::notifySwatchChanged	(	const QString &	groupName,
		int	column,
		int	row )

private

Definition at line 774 of file KoColorSet.cpp.

{
    int startRow = 0;
    if (!groupName.isEmpty()) {
        startRow = startRowForGroup(groupName) + 1;
    }
    Q_EMIT entryChanged(column, startRow + row);
}

References entryChanged(), and startRowForGroup().

◆ operator=()

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

delete

◆ paletteType()

KoColorSet::PaletteType KoColorSet::paletteType ( ) const

Definition at line 628 of file KoColorSet.cpp.

{
    return d->paletteType;
}

References d.

◆ removeGroup()

void KoColorSet::removeGroup	(	const QString &	groupName,
		bool	keepColors = true )

removeGroup Remove a group from the KoColorSet

Parameters

groupName	the name of the group you want to remove.
keepColors	Whether you wish to keep the colorsetentries. These will be added to the unsorted.

Returns: whether it could find the group to remove.

Definition at line 864 of file KoColorSet.cpp.

{
 
    if (!swatchGroupNames().contains(groupName) || (groupName == GLOBAL_GROUP_NAME) || d->isLocked) return;
 
    RemoveGroupCommand *cmd = new RemoveGroupCommand(this, groupName, keepColors);
 
    d->undoStack.push(cmd);
}

References d, GLOBAL_GROUP_NAME, RemoveGroupCommand, and swatchGroupNames().

◆ removeSwatch()

void KoColorSet::removeSwatch	(	int	column,
		int	row,
		KisSwatchGroupSP	group )

remove the swatch from the given group at column and row

Definition at line 653 of file KoColorSet.cpp.

{
    if (d->isLocked) return;
    RemoveSwatchCommand *cmd = new RemoveSwatchCommand(this, column, row, group);
 
    d->undoStack.push(cmd);
}

References d, and RemoveSwatchCommand.

◆ resourceType()

QPair< QString, QString > KoColorSet::resourceType ( ) const

inlineoverridevirtual

Returns: the resource type

Implements KoResource.

Definition at line 92 of file KoColorSet.h.

    {
        return QPair<QString, QString>(ResourceType::Palettes, "");
    }

References ResourceType::Palettes.

◆ rowCount()

int KoColorSet::rowCount ( ) const

Definition at line 894 of file KoColorSet.cpp.

{
    int res = 0;
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        res += group->rowCount();
    }
    return res;
}

References d.

◆ rowCountWithTitles()

int KoColorSet::rowCountWithTitles ( ) const

Definition at line 903 of file KoColorSet.cpp.

{
    return rowCount() + d->swatchGroups.size() - 1;
}

References d, and rowCount().

◆ rowNumberInGroup()

int KoColorSet::rowNumberInGroup ( int rowNumber ) const

rowNumberInGroup calculates the row number in the group from the global rownumber

Parameters

rowNumber this is a row in rowCountWithTitles

Returns: -1 if the row is a group title row.

Definition at line 747 of file KoColorSet.cpp.

{
    if (isGroupTitleRow(rowNumber)) {
        return -1;
    }
 
    int rowInGroup = -1;
    for (int i = rowNumber; i > -1; i--) {
        if (isGroupTitleRow(i)) {
            return rowInGroup;
        }
        else {
            rowInGroup++;
        }
    }
 
    return rowInGroup;
}

References isGroupTitleRow().

◆ saveToDevice()

bool KoColorSet::saveToDevice ( QIODevice * dev ) const

overridevirtual

Reimplemented from KoResource.

Definition at line 604 of file KoColorSet.cpp.

{
    bool res = false;
    switch(d->paletteType) {
    case GPL:
        res = d->saveGpl(dev);
        break;
    default:
        res = d->saveKpl(dev);
    }
 
    if (res) const_cast<KoColorSet*>(this)->setDirty(false);
    d->undoStack.clear();
 
    return res;
}

References KUndo2QStack::clear(), d, GPL, KoResource::setDirty(), and undoStack().

◆ setColumnCount()

void KoColorSet::setColumnCount ( int columns )

Definition at line 812 of file KoColorSet.cpp.

{
    if (d->isLocked || (columns == d->columns)) return;
 
    SetColumnCountCommand *cmd = new SetColumnCountCommand (this, columns);
 
    d->undoStack.push(cmd);
}

References d, and SetColumnCountCommand.

◆ setComment()

void KoColorSet::setComment ( QString comment )

Definition at line 833 of file KoColorSet.cpp.

{
    if (d->isLocked || comment == d->comment) return;
 
    SetCommentCommand *cmd = new SetCommentCommand(this, comment);
 
    d->undoStack.push(cmd);
}

References comment(), d, and SetCommentCommand.

◆ setLocked()

void KoColorSet::setLocked ( bool lock )

Definition at line 884 of file KoColorSet.cpp.

{
    d->isLocked = lock;
}

References d.

◆ setModified()

void KoColorSet::setModified ( bool _modified )

private

Definition at line 766 of file KoColorSet.cpp.

{
    setDirty(_modified);
    if (_modified) {
        Q_EMIT modified();
    }
}

References modified(), and KoResource::setDirty().

◆ setPaletteType()

void KoColorSet::setPaletteType ( PaletteType paletteType )

Definition at line 633 of file KoColorSet.cpp.

{
    if (d->isLocked || paletteType == d->paletteType) return;
 
    SetPaletteTypeCommand *cmd = new SetPaletteTypeCommand(this, paletteType);
 
    d->undoStack.push(cmd);
}

References d, paletteType(), and SetPaletteTypeCommand.

◆ slotCount()

quint32 KoColorSet::slotCount ( ) const

Definition at line 917 of file KoColorSet.cpp.

{
    int slotCount = 0;
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        slotCount += group->slotCount();
    }
    return slotCount;
}

References d, and slotCount().

◆ startRowForGroup()

int KoColorSet::startRowForGroup ( const QString & groupName ) const

rowForNamedGroup returns the row the group's title is on

Parameters

groupName

Returns

Definition at line 730 of file KoColorSet.cpp.

{
    if (groupName.isEmpty()) return 0;
 
    int row = 0;
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        if (group->name() == groupName) {
            return row;
        }
        row += group->rowCount();
        if (group->name() != KoColorSet::GLOBAL_GROUP_NAME) {
            row++;
        }
    }
    return row;
}

References d, and GLOBAL_GROUP_NAME.

◆ swatchGroupNames()

QStringList KoColorSet::swatchGroupNames ( ) const

getGroupNames

Returns: returns a list of group names, excluding the unsorted group.

Definition at line 706 of file KoColorSet.cpp.

{
    QStringList groupNames;
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        groupNames << group->name();
    }
    return groupNames;
}

References d.

◆ undoStack()

KUndo2Stack * KoColorSet::undoStack ( ) const

Definition at line 879 of file KoColorSet.cpp.

{
    return &d->undoStack;
}

References d.

◆ updateThumbnail()

void KoColorSet::updateThumbnail ( )

overridevirtual

updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.

Reimplemented from KoResource.

Definition at line 1008 of file KoColorSet.cpp.

{
    int rows = 0;
 
    // Determine the last filled row in each group
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        int lastRowInGroup =  0;
        for (const KisSwatchGroup::SwatchInfo &info : group->infoList()) {
            lastRowInGroup = qMax(lastRowInGroup, info.row);
        }
        rows += (lastRowInGroup + 1);
    }
 
    QImage img(d->global()->columnCount() * 4, rows * 4, QImage::Format_ARGB32);
    QPainter gc(&img);
    gc.fillRect(img.rect(), Qt::darkGray);
 
    int lastRow = 0;
    for (const KisSwatchGroupSP &group : d->swatchGroups) {
        int lastRowGroup = 0;
        for (const KisSwatchGroup::SwatchInfo &info : group->infoList()) {
            QColor c = info.swatch.color().toQColor();
            gc.fillRect(info.column * 4, (lastRow + info.row) * 4, 4, 4, c);
            lastRowGroup = qMax(lastRowGroup, info.row);
        }
        lastRow += (lastRowGroup + 1);
    }
 
    setImage(img);
}

References d, and KoResource::setImage().

Friends And Related Symbol Documentation

◆ AddGroupCommand

friend struct AddGroupCommand

friend

Definition at line 276 of file KoColorSet.h.

◆ AddSwatchCommand

friend struct AddSwatchCommand

friend

Definition at line 273 of file KoColorSet.h.

◆ ChangeGroupNameCommand

friend struct ChangeGroupNameCommand

friend

Definition at line 275 of file KoColorSet.h.

◆ ClearCommand

friend struct ClearCommand

friend

Definition at line 278 of file KoColorSet.h.

◆ MoveGroupCommand

friend struct MoveGroupCommand

friend

Definition at line 282 of file KoColorSet.h.

◆ RemoveGroupCommand

friend struct RemoveGroupCommand

friend

Definition at line 277 of file KoColorSet.h.

◆ RemoveSwatchCommand

friend struct RemoveSwatchCommand

friend

Definition at line 274 of file KoColorSet.h.

◆ SetColumnCountCommand

friend struct SetColumnCountCommand

friend

Definition at line 279 of file KoColorSet.h.

◆ SetCommentCommand

friend struct SetCommentCommand

friend

Definition at line 280 of file KoColorSet.h.

◆ SetPaletteTypeCommand

friend struct SetPaletteTypeCommand

friend

Definition at line 281 of file KoColorSet.h.

◆ TestKisPaletteModel

friend class TestKisPaletteModel

friend

Definition at line 284 of file KoColorSet.h.

◆ TestKoColorSet

friend class TestKoColorSet

friend

Definition at line 283 of file KoColorSet.h.

Member Data Documentation

◆ d

const QScopedPointer<Private> KoColorSet::d

private

Definition at line 287 of file KoColorSet.h.

◆ GLOBAL_GROUP_NAME

const QString KoColorSet::GLOBAL_GROUP_NAME = QString()

static

Definition at line 33 of file KoColorSet.h.

◆ KPL_COLOR_DEPTH_ID_ATTR

const QString KoColorSet::KPL_COLOR_DEPTH_ID_ATTR = "colorDepthId"

static

Definition at line 42 of file KoColorSet.h.

◆ KPL_COLOR_MODEL_ID_ATTR

const QString KoColorSet::KPL_COLOR_MODEL_ID_ATTR = "colorModelId"

static

Definition at line 41 of file KoColorSet.h.

◆ KPL_GROUP_NAME_ATTR

const QString KoColorSet::KPL_GROUP_NAME_ATTR = "name"

static

Definition at line 43 of file KoColorSet.h.

◆ KPL_GROUP_ROW_COUNT_ATTR

const QString KoColorSet::KPL_GROUP_ROW_COUNT_ATTR = "rows"

static

Definition at line 35 of file KoColorSet.h.

◆ KPL_GROUP_TAG

const QString KoColorSet::KPL_GROUP_TAG = "Group"

static

Definition at line 53 of file KoColorSet.h.

◆ KPL_PALETTE_COLUMN_COUNT_ATTR

const QString KoColorSet::KPL_PALETTE_COLUMN_COUNT_ATTR = "columns"

static

Definition at line 36 of file KoColorSet.h.

◆ KPL_PALETTE_COMMENT_ATTR

const QString KoColorSet::KPL_PALETTE_COMMENT_ATTR = "comment"

static

Definition at line 38 of file KoColorSet.h.

◆ KPL_PALETTE_FILENAME_ATTR

const QString KoColorSet::KPL_PALETTE_FILENAME_ATTR = "filename"

static

Definition at line 39 of file KoColorSet.h.

◆ KPL_PALETTE_NAME_ATTR

const QString KoColorSet::KPL_PALETTE_NAME_ATTR = "name"

static

Definition at line 37 of file KoColorSet.h.

◆ KPL_PALETTE_PROFILE_TAG

const QString KoColorSet::KPL_PALETTE_PROFILE_TAG = "Profile"

static

Definition at line 50 of file KoColorSet.h.

◆ KPL_PALETTE_READONLY_ATTR

const QString KoColorSet::KPL_PALETTE_READONLY_ATTR = "readonly"

static

Definition at line 40 of file KoColorSet.h.

◆ KPL_PALETTE_TAG

const QString KoColorSet::KPL_PALETTE_TAG = "ColorSet"

static

Definition at line 54 of file KoColorSet.h.

◆ KPL_SWATCH_BITDEPTH_ATTR

const QString KoColorSet::KPL_SWATCH_BITDEPTH_ATTR = "bitdepth"

static

Definition at line 49 of file KoColorSet.h.

◆ KPL_SWATCH_COL_ATTR

const QString KoColorSet::KPL_SWATCH_COL_ATTR = "column"

static

Definition at line 45 of file KoColorSet.h.

◆ KPL_SWATCH_ID_ATTR

const QString KoColorSet::KPL_SWATCH_ID_ATTR = "id"

static

Definition at line 48 of file KoColorSet.h.

◆ KPL_SWATCH_NAME_ATTR

const QString KoColorSet::KPL_SWATCH_NAME_ATTR = "name"

static

Definition at line 46 of file KoColorSet.h.

◆ KPL_SWATCH_POS_TAG

const QString KoColorSet::KPL_SWATCH_POS_TAG = "Position"

static

Definition at line 51 of file KoColorSet.h.

◆ KPL_SWATCH_ROW_ATTR

const QString KoColorSet::KPL_SWATCH_ROW_ATTR = "row"

static

Definition at line 44 of file KoColorSet.h.

◆ KPL_SWATCH_SPOT_ATTR

const QString KoColorSet::KPL_SWATCH_SPOT_ATTR = "spot"

static

Definition at line 47 of file KoColorSet.h.

◆ KPL_SWATCH_TAG

const QString KoColorSet::KPL_SWATCH_TAG = "ColorSetEntry"

static

Definition at line 52 of file KoColorSet.h.

◆ KPL_VERSION_ATTR

const QString KoColorSet::KPL_VERSION_ATTR = "version"

static

Definition at line 34 of file KoColorSet.h.

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

libs/pigment/resources/KoColorSet.h
libs/pigment/resources/KoColorSet.cpp

Classes

Public Types

Signals

Public Member Functions

Static Public Attributes

Private Slots

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PaletteType

Constructor & Destructor Documentation

◆ KoColorSet() [1/2]

◆ KoColorSet() [2/2]

◆ ~KoColorSet()

Member Function Documentation

◆ addGroup()

◆ addSwatch()

◆ canRedoChanged

◆ canUndoChanged

◆ changeGroupName()

◆ clear()

◆ clone()

◆ colorCount()

◆ columnCount()

◆ comment()

◆ defaultFileExtension()

◆ entryChanged

◆ fromByteArray()

◆ getClosestSwatchInfo()

◆ getColorGlobal()

◆ getGlobalGroup()

◆ getGroup() [1/2]

◆ getGroup() [2/2]

◆ getSwatchFromGroup()

◆ isGroupTitleRow()

◆ isLocked()

◆ layoutAboutToChange

◆ layoutChanged

◆ loadFromDevice()

◆ modified

◆ moveGroup()

◆ notifySwatchChanged()

◆ operator=()

◆ paletteType()

◆ removeGroup()

◆ removeSwatch()

◆ resourceType()

◆ rowCount()

◆ rowCountWithTitles()

◆ rowNumberInGroup()

◆ saveToDevice()

◆ setColumnCount()

◆ setComment()

◆ setLocked()

◆ setModified()

◆ setPaletteType()

◆ slotCount()

◆ startRowForGroup()

◆ swatchGroupNames()

◆ undoStack()

◆ updateThumbnail()

Friends And Related Symbol Documentation

◆ AddGroupCommand

◆ AddSwatchCommand

◆ ChangeGroupNameCommand

◆ ClearCommand

◆ MoveGroupCommand

◆ RemoveGroupCommand

◆ RemoveSwatchCommand

◆ SetColumnCountCommand

◆ SetCommentCommand

◆ SetPaletteTypeCommand

◆ TestKisPaletteModel

◆ TestKoColorSet

Member Data Documentation

◆ d

◆ GLOBAL_GROUP_NAME