Palette Class Reference

#include <Palette.h>

Inheritance diagram for Palette:

Public Member Functions
	Palette (Resource *resource)
void	addEntry (Swatch entry, QString groupName=QString())
void	addGroup (QString name)
void	changeGroupName (QString oldGroupName, QString newGroupName)
int	colorsCountTotal ()
Swatch *	colorSetEntryByIndex (int index)
Swatch *	colorSetEntryFromGroup (int index, const QString &groupName)
int	columnCount ()
QString	comment ()
QStringList	groupNames () const
void	moveGroup (const QString &groupName, const QString &groupNameInsertBefore=QString())
int	numberOfEntries () const
void	removeEntry (int index, const QString &groupName)
void	removeGroup (QString name, bool keepColors=true)
bool	save ()
void	setColumnCount (int columns)
void	setComment (QString comment)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

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)
        c = palette.colorForEntry(entry);
        print(x, entry.name(), entry.id(), entry.spotColor(), c.toQString())

Definition at line 45 of file Palette.h.

Constructor & Destructor Documentation

Palette()

Palette::Palette

(

Resource *

resource

)

Definition at line 18 of file Palette.cpp.

~Palette()

Palette::~Palette ( )

override

Definition at line 22 of file Palette.cpp.

Member Function Documentation

addEntry()

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

addEntry add an entry to a group.

Gets appended to the end.

Parameters

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

Definition at line 100 of file Palette.cpp.

addGroup()

void Palette::addGroup

(

QString

name

)

addGroup

Parameters

name	of the new group

Returns

whether adding the group was successful.

Definition at line 63 of file Palette.cpp.

changeGroupName()

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

changeGroupName change the group name.

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 125 of file Palette.cpp.

colorsCountTotal()

int Palette::colorsCountTotal

(

)

colorsCountTotal

Returns

the total amount of entries in the whole group

Definition at line 75 of file Palette.cpp.

colorSetEntryByIndex()

Swatch * Palette::colorSetEntryByIndex

(

int

index

)

colorSetEntryByIndex get the colorsetEntry from the global index.

Parameters

index

the global index

Returns

the colorset entry

Definition at line 81 of file Palette.cpp.

colorSetEntryFromGroup()

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

colorSetEntryFromGroup

Parameters

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

Returns

the colorsetentry.

Definition at line 91 of file Palette.cpp.

columnCount()

int Palette::columnCount

(

)

columnCount

Returns

the amount of columns this palette is set to use.

Definition at line 33 of file Palette.cpp.

comment()

QString Palette::comment

(

)

comment

Returns

the comment or description associated with the palette.

Definition at line 45 of file Palette.cpp.

groupNames()

QStringList Palette::groupNames

(

)

const

groupNames

Returns

the list of group names. This is list is in the order these groups are in the file.

Definition at line 57 of file Palette.cpp.

moveGroup()

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

moveGroup move the group to before groupNameInsertBefore.

Parameters

groupName	group to move.
groupNameInsertBefore	group to inset before.

Returns

whether successful. Reasons for failure include either group not existing.

Definition at line 130 of file Palette.cpp.

numberOfEntries()

int Palette::numberOfEntries

(

)

const

numberOfEntries

Returns

Definition at line 27 of file Palette.cpp.

removeEntry()

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

removeEntry remove the entry at index from the group groupName.

Definition at line 105 of file Palette.cpp.

removeGroup()

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

removeGroup

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.

Returns

Definition at line 69 of file Palette.cpp.

save()

bool Palette::save

(

)

save save the palette

Returns

whether it was successful.

Definition at line 135 of file Palette.cpp.

setColumnCount()

void Palette::setColumnCount

(

int

columns

)

setColumnCount Set the amount of columns this palette should use.

Definition at line 39 of file Palette.cpp.

setComment()

void Palette::setComment

(

QString

comment

)

setComment set the comment or description associated with the palette.

Parameters

comment

Definition at line 51 of file Palette.cpp.

---

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

• Palette.h
• Palette.cpp