Palette Class Reference

The Palette class Palette is a resource object that stores organised color data. It's purpose is to allow artists to save colors and store them. More...

#include <Palette.h>

Inheritance diagram for Palette:

Public Slots
void	addEntry (Swatch entry, QString groupName=QString())
	add a color entry to a group. Color is appended to the end.
void	addGroup (QString name)
	Palette content can be organized in groups. This method allows to add a new group in palette.
Q_DECL_DEPRECATED void	changeGroupName (QString oldGroupName, QString newGroupName)
	changeGroupName change the group name.
int	colorsCountGroup (QString name)
	colorsCountGroup
int	colorsCountTotal ()
	number of filled colors (swatches) in palette NOTE: same as numberOfEntries()
Q_DECL_DEPRECATED Swatch *	colorSetEntryByIndex (int index)
	colorSetEntryByIndex get the colorsetEntry from the global index.
Q_DECL_DEPRECATED Swatch *	colorSetEntryFromGroup (int index, const QString &groupName)
	colorSetEntryFromGroup
int	columnCount ()
	Palettes are defined in grids. The number of column define grid width. The number of rows will depend of columns and total number of entries.
QString	comment ()
	the comment or description associated with the palette.
Swatch *	entryByIndex (int index)
	get color (swatch) from the global index.
Swatch *	entryByIndexFromGroup (int index, const QString &groupName)
	get color (swatch) from the given group index.
QStringList	groupNames () const
	Palette content can be organized in groups.
void	moveGroup (const QString &groupName, const QString &groupNameInsertBefore=QString())
	Move the group groupName to position before group groupNameInsertBefore.
int	numberOfEntries () const
	number of filled colors (swatches) in palette NOTE: same as colorsCountTotal()
void	removeEntry (int index)
	Remove the color entry at the given index in this palette.
void	removeEntryFromGroup (int index, const QString &groupName)
	Remove the color entry at the given index in the given group.
void	removeGroup (QString name, bool keepColors=true)
	Palette content can be organized in groups. This method allows to remove an existing group from palette.
void	renameGroup (QString oldGroupName, QString newGroupName)
	rename a group
int	rowCount ()
	The number of rows in the palette grid. If the palette has groups, the row count is defined by the groups' row count. Otherwise, it's determined by the number of columns and entries.
int	rowCountGroup (QString name)
	The number of rows defined in the given group.
bool	save ()
	save the palette
void	setColumnCount (int columns)
	Palettes are defined in grids. The number of column define grid width, this value can be defined. The number of rows will depend of columns and total number of entries.
void	setComment (QString comment)
	the comment or description associated with the palette.
void	setRowCountGroup (int rows, QString name)
	Set the number of rows defined in the given group.
int	slotCount ()
	number of slots for swatches in palette This includes any empty slots not filled by a color.
int	slotCountGroup (QString name)
	number of slots for swatches in group This includes any empty slots not filled by a color.

Public Member Functions
bool	operator!= (const Palette &other) const
bool	operator== (const Palette &other) const
	Palette (Resource *resource, QObject *parent=0)
	~Palette () override

Private Member Functions
KoColorSetSP	colorSet ()
	colorSet

Private Attributes
Private *const	d

Friends
class	PaletteView

Detailed Description

The Palette class Palette is a resource object that stores organised color data. It's purpose is to allow artists to save colors and store them.

An example for printing all the palettes and the entries:

import sys
from krita import *
 
resources = Application.resources("palette")
 
for (k, v) in resources.items():
    print(k)
    palette = Palette(v)
    for x in range(palette.numberOfEntries()):
        entry = palette.colorSetEntryByIndex(x)
        print(x, entry.name(), entry.id(), entry.spotColor())

Definition at line 43 of file Palette.h.

Constructor & Destructor Documentation

Palette()

Palette::Palette ( Resource * resource, QObject * parent = 0 )

explicit

Definition at line 18 of file Palette.cpp.

       : QObject(parent)
       , d(new Private()) {
    d->palette = resource->resource().dynamicCast<KoColorSet>();
}

References d, krita::Palette::Private::palette, and Resource::resource().

~Palette()

Palette::~Palette ( )

override

Definition at line 24 of file Palette.cpp.

{
    delete d;
}

References d.

Member Function Documentation

addEntry

void Palette::addEntry ( Swatch entry, QString groupName = QString() )

slot

add a color entry to a group. Color is appended to the end.

Parameters

entry	the entry
groupName	the name of the group to add to.

Definition at line 170 of file Palette.cpp.

{
    d->palette->addSwatch(entry.kisSwatch(), groupName);
}

References d, Swatch::kisSwatch(), and krita::Palette::Private::palette.

addGroup

void Palette::addGroup ( QString name )

slot

Palette content can be organized in groups. This method allows to add a new group in palette.

Parameters

name	The name of the new group to add.

Definition at line 99 of file Palette.cpp.

{
    if (!d->palette) return;
    d->palette->addGroup(name);
}

References d, and krita::Palette::Private::palette.

changeGroupName

void Palette::changeGroupName ( QString oldGroupName, QString newGroupName )

slot

changeGroupName change the group name.

DEPRECATED: use renameGroup() instead

Parameters

oldGroupName	the old groupname to change.
newGroupName	the new name to change it into.

Returns

whether successful. Reasons for failure include not knowing have oldGroupName

Definition at line 203 of file Palette.cpp.

{
    warnScript << "DEPRECATED Palette.changeGroupName() - use Palette.renameGroup() instead";
    return renameGroup(oldGroupName, newGroupName);
}

References renameGroup(), and warnScript.

colorsCountGroup

int Palette::colorsCountGroup ( QString name )

slot

colorsCountGroup

Parameters

name	of the group to check. Empty is the default group.

Returns

the amount of filled colors within that group.

Definition at line 117 of file Palette.cpp.

{
    if (!d->palette) return 0;
    KisSwatchGroupSP group = d->palette->getGroup(name);
    if (!group) return 0;
    return group->colorCount();
}

References d, and krita::Palette::Private::palette.

colorsCountTotal

int Palette::colorsCountTotal ( )

slot

number of filled colors (swatches) in palette NOTE: same as numberOfEntries()

Returns

total number of colors

Definition at line 111 of file Palette.cpp.

{
    if (!d->palette) return 0;
    return d->palette->colorCount();
}

References d, and krita::Palette::Private::palette.

colorSet()

KoColorSetSP Palette::colorSet ( )

private

colorSet

Returns

gives a KoColorSet object back

Definition at line 224 of file Palette.cpp.

{
    return d->palette;
}

References d, and krita::Palette::Private::palette.

colorSetEntryByIndex

Swatch * Palette::colorSetEntryByIndex ( int index )

slot

colorSetEntryByIndex get the colorsetEntry from the global index.

DEPRECATED: use entryByIndex() instead

Parameters

index

the global index

Returns

the colorset entry

Definition at line 139 of file Palette.cpp.

{
    warnScript << "DEPRECATED Palette.colorSetEntryByIndex() - use Palette.entryByIndex() instead";
    return entryByIndex(index);
}

References entryByIndex(), and warnScript.

colorSetEntryFromGroup

Swatch * Palette::colorSetEntryFromGroup ( int index, const QString & groupName )

slot

colorSetEntryFromGroup

DEPRECATED: use entryByIndexFromGroup() instead

Parameters

index	index in the group.
groupName	the name of the group to get the color from.

Returns

the colorsetentry.

Definition at line 155 of file Palette.cpp.

{
    warnScript << "DEPRECATED Palette.colorSetEntryFromGroup() - use Palette.entryByIndexFromGroup() instead";
    return entryByIndexFromGroup(index, groupName);
}

References entryByIndexFromGroup(), and warnScript.

columnCount

int Palette::columnCount ( )

slot

Palettes are defined in grids. The number of column define grid width. The number of rows will depend of columns and total number of entries.

Returns

the number of columns this palette is set to use.

Definition at line 46 of file Palette.cpp.

{
    if (!d->palette) return 0;
    return d->palette->columnCount();
}

References d, and krita::Palette::Private::palette.

comment

QString Palette::comment ( )

slot

the comment or description associated with the palette.

Returns

A string for which value contains the comment/description of palette.

Definition at line 81 of file Palette.cpp.

{
    if (!d->palette) return "";
    return d->palette->comment();
}

References d, and krita::Palette::Private::palette.

entryByIndex

Swatch * Palette::entryByIndex ( int index )

slot

get color (swatch) from the global index.

Parameters

index

the global index

Returns

The Swatch color for given index.

Definition at line 145 of file Palette.cpp.

{
    if (!d->palette || columnCount() == 0) {
        return new Swatch();
    }
    int col = index % columnCount();
    int row = (index - col) / columnCount();
    return new Swatch(d->palette->getColorGlobal(col, row));
}

References columnCount(), d, and krita::Palette::Private::palette.

entryByIndexFromGroup

Swatch * Palette::entryByIndexFromGroup ( int index, const QString & groupName )

slot

get color (swatch) from the given group index.

Parameters

index	index in the group.
groupName	the name of the group to get the color from.

Returns

The Swatch color for given index within given group name.

Definition at line 161 of file Palette.cpp.

{
    if (!d->palette || columnCount() == 0) {
        return new Swatch();
    }
    int col = index % columnCount();
    return new Swatch(d->palette->getSwatchFromGroup(col, (index - col) / columnCount(), groupName));
}

References columnCount(), d, and krita::Palette::Private::palette.

groupNames

QStringList Palette::groupNames ( ) const

slot

Palette content can be organized in groups.

Returns

The list of group names (list of string). This list follow the order the groups are defined in palette.

Definition at line 93 of file Palette.cpp.

{
    if (!d->palette) return QStringList();
    return d->palette->swatchGroupNames();
}

References d, and krita::Palette::Private::palette.

moveGroup

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

slot

Move the group groupName to position before group groupNameInsertBefore.

Parameters

groupName	group to move.
groupNameInsertBefore	reference group for which groupName have to be moved before.

Definition at line 214 of file Palette.cpp.

{
    return d->palette->moveGroup(groupName, groupNameInsertBefore);
}

References d, and krita::Palette::Private::palette.

numberOfEntries

int Palette::numberOfEntries ( ) const

slot

number of filled colors (swatches) in palette NOTE: same as colorsCountTotal()

Returns

total number of colors

Definition at line 40 of file Palette.cpp.

{
    if (!d->palette) return 0;
    return d->palette->colorCount();
}

References d, and krita::Palette::Private::palette.

operator!=()

bool Palette::operator!=

(

const Palette &

other

)

const

Definition at line 34 of file Palette.cpp.

{
    return !(operator==(other));
}

References operator==().

operator==()

bool Palette::operator==

(

const Palette &

other

)

const

Definition at line 29 of file Palette.cpp.

{
    return (d->palette == other.d->palette);
}

References d, and krita::Palette::Private::palette.

removeEntry

void Palette::removeEntry ( int index )

slot

Remove the color entry at the given index in this palette.

Parameters

index

index in this palette.

Definition at line 175 of file Palette.cpp.

{
    int col = index % columnCount();
    int tmp = index;
    int row = (index - col) / columnCount();
    KisSwatchGroupSP groupFoundIn;
    Q_FOREACH(const QString &name, groupNames()) {
        KisSwatchGroupSP g = d->palette->getGroup(name);
        tmp -= g->rowCount() * columnCount();
        if (tmp < 0) {
            groupFoundIn = g;
            break;
        }
        row -= g->rowCount();
    }
    if (!groupFoundIn) { return; }
    d->palette->removeSwatch(col, row, groupFoundIn);
}

References columnCount(), d, groupNames(), and krita::Palette::Private::palette.

removeEntryFromGroup

void Palette::removeEntryFromGroup ( int index, const QString & groupName )

slot

Remove the color entry at the given index in the given group.

Parameters

index	index in the group.
groupName	the name of the group to remove the entry from.

Definition at line 193 of file Palette.cpp.

{
    if (!d->palette) return;
    KisSwatchGroupSP group = d->palette->getGroup(groupName);
    if (!group) return;
    int col = index % columnCount();
    int row = (index - col) / columnCount();
    d->palette->removeSwatch(col, row, group);
}

References columnCount(), d, and krita::Palette::Private::palette.

removeGroup

void Palette::removeGroup ( QString name, bool keepColors = true )

slot

Palette content can be organized in groups. This method allows to remove an existing group from palette.

Parameters

name	The name of the group to remove.
keepColors	whether or not to delete all the colors inside, or to move them to the default group.

Definition at line 105 of file Palette.cpp.

{
    if (!d->palette) return;
    return d->palette->removeGroup(name, keepColors);
}

References d, and krita::Palette::Private::palette.

renameGroup

void Palette::renameGroup ( QString oldGroupName, QString newGroupName )

slot

rename a group

Parameters

oldGroupName	the old groupname to change.
newGroupName	the new name to change it into.

Definition at line 209 of file Palette.cpp.

{
    d->palette->changeGroupName(oldGroupName, newGroupName);
}

References d, and krita::Palette::Private::palette.

rowCount

int Palette::rowCount ( )

slot

The number of rows in the palette grid. If the palette has groups, the row count is defined by the groups' row count. Otherwise, it's determined by the number of columns and entries.

Returns

the number of rows this palette has.

Definition at line 58 of file Palette.cpp.

{
    if (!d->palette) return 0;
    return d->palette->rowCount();
}

References d, and krita::Palette::Private::palette.

rowCountGroup

int Palette::rowCountGroup ( QString name )

slot

The number of rows defined in the given group.

Parameters

name	of the group to check.

Returns

the number of rows this group is set to use.

Definition at line 64 of file Palette.cpp.

{
    if (!d->palette) return 0;
    KisSwatchGroupSP group = d->palette->getGroup(name);
    if (!group) return 0;
    return group->rowCount();
}

References d, and krita::Palette::Private::palette.

save

bool Palette::save ( )

slot

save the palette

WARNING: this method does nothing and need to be implemented!

Returns

always False

Definition at line 219 of file Palette.cpp.

{
    return false;
}

setColumnCount

void Palette::setColumnCount ( int columns )

slot

Palettes are defined in grids. The number of column define grid width, this value can be defined. The number of rows will depend of columns and total number of entries.

Parameters

columns

Set the amount of columns this palette should use.

Definition at line 52 of file Palette.cpp.

{
    if (d->palette && columns > 0)
        d->palette->setColumnCount(columns);
}

References d, and krita::Palette::Private::palette.

setComment

void Palette::setComment ( QString comment )

slot

the comment or description associated with the palette.

Parameters

comment

set the comment or description associated with the palette.

Definition at line 87 of file Palette.cpp.

{
    if (!d->palette) return;
    return d->palette->setComment(comment);
}

References comment(), d, and krita::Palette::Private::palette.

setRowCountGroup

void Palette::setRowCountGroup ( int rows, QString name )

slot

Set the number of rows defined in the given group.

Parameters

rows	the amount of rows this group should use.
name	of the group to modify.

Definition at line 72 of file Palette.cpp.

{
    if (!d->palette) return;
    KisSwatchGroupSP group = d->palette->getGroup(name);
    if (!group) return;
    if (rows > 0)
        group->setRowCount(rows);
}

References d, and krita::Palette::Private::palette.

slotCount

int Palette::slotCount ( )

slot

number of slots for swatches in palette This includes any empty slots not filled by a color.

Returns

total number of slots

Definition at line 125 of file Palette.cpp.

{
    if (!d->palette) return 0;
    return d->palette->slotCount();
}

References d, and krita::Palette::Private::palette.

slotCountGroup

int Palette::slotCountGroup ( QString name )

slot

number of slots for swatches in group This includes any empty slots not filled by a color.

Parameters

name	of the group to check. Empty is the default group.

Returns

number of slots in group

Definition at line 131 of file Palette.cpp.

{
    if (!d->palette) return 0;
    KisSwatchGroupSP group = d->palette->getGroup(name);
    if (!group) return 0;
    return group->slotCount();
}

References d, and krita::Palette::Private::palette.

Friends And Related Symbol Documentation

PaletteView

friend class PaletteView

friend

Definition at line 275 of file Palette.h.

Member Data Documentation

d

Private* const Palette::d

private

Definition at line 277 of file Palette.h.

---

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

• libs/libkis/Palette.h
• libs/libkis/Palette.cpp