KisSwatch Class Reference

#include <KisSwatch.h>

Public Member Functions
KoColor	color () const
QString	id () const
bool	isValid () const
	KisSwatch ()=default
	KisSwatch (const KoColor &color, const QString &name=QString())
QString	name () const
bool	operator== (const KisSwatch &rhs) const
void	setColor (const KoColor &color)
void	setId (const QString &id)
void	setName (const QString &name)
void	setSpotColor (bool spotColor)
bool	spotColor () const
void	writeToStream (QDataStream &stream, const QString &groupName, int originalRow, int originalColumn)

Static Public Member Functions
static KisSwatch	fromByteArray (QByteArray &data)
static KisSwatch	fromByteArray (QByteArray &data, QString &groupName, int &originalRow, int &originalColumn)

Private Attributes
KoColor	m_color
QString	m_id
QString	m_name
bool	m_spotColor {false}
bool	m_valid {false}

Detailed Description

Definition at line 17 of file KisSwatch.h.

Constructor & Destructor Documentation

KisSwatch() [1/2]

KisSwatch::KisSwatch ( )

default

KisSwatch() [2/2]

KisSwatch::KisSwatch	(	const KoColor &	color,
		const QString &	name = QString() )

Definition at line 14 of file KisSwatch.cpp.

    : m_color(color)
    , m_name(name)
    , m_valid(true)
{ }

Member Function Documentation

color()

KoColor KisSwatch::color ( ) const

inline

Definition at line 30 of file KisSwatch.h.

{ return m_color; }

fromByteArray() [1/2]

KisSwatch KisSwatch::fromByteArray ( QByteArray & data )

static

Definition at line 88 of file KisSwatch.cpp.

{
    QString s;
    int x, y;
    return fromByteArray(data, s, y, x);
}

References fromByteArray().

fromByteArray() [2/2]

KisSwatch KisSwatch::fromByteArray ( QByteArray & data, QString & groupName, int & originalRow, int & originalColumn )

static

Definition at line 57 of file KisSwatch.cpp.

{
    QDataStream stream(&data, QIODevice::ReadOnly);
    KisSwatch s;
    QString name, id;
    bool spotColor;
    QString colorXml;
 
    while (!stream.atEnd()) {
        stream >> name >> id >> spotColor
                >> originalRow >> originalColumn
                >> oldGroupName
                >> colorXml;
 
        s.setName(name);
        s.setId(id);
        s.setSpotColor(spotColor);
 
        QDomDocument doc;
        doc.setContent(colorXml);
        QDomElement e = doc.documentElement();
        QDomElement c = e.firstChildElement();
        if (!c.isNull()) {
            QString colorDepthId = c.attribute("bitdepth", Integer8BitsColorDepthID.id());
            s.setColor(KoColor::fromXML(c, colorDepthId));
        }
    }
 
    return s;
}

References KoColor::fromXML(), KoID::id(), id(), Integer8BitsColorDepthID, name(), setColor(), setId(), setName(), setSpotColor(), and spotColor().

id()

QString KisSwatch::id ( ) const

inline

Definition at line 27 of file KisSwatch.h.

{ return m_id; }

isValid()

bool KisSwatch::isValid ( ) const

inline

Definition at line 36 of file KisSwatch.h.

{ return m_valid; }

name()

QString KisSwatch::name ( ) const

inline

Definition at line 24 of file KisSwatch.h.

{ return m_name; }

operator==()

bool KisSwatch::operator== ( const KisSwatch & rhs ) const

inline

Definition at line 43 of file KisSwatch.h.

                                                {
        return m_color == rhs.m_color && m_name == rhs.m_name;
    }

References m_color, and m_name.

setColor()

void KisSwatch::setColor

(

const KoColor &

color

)

Definition at line 32 of file KisSwatch.cpp.

{
    m_color = color;
    m_valid = true;
}

References color(), m_color, and m_valid.

setId()

void KisSwatch::setId

(

const QString &

id

)

Definition at line 26 of file KisSwatch.cpp.

{
    m_id = id;
    m_valid = true;
}

References id(), m_id, and m_valid.

setName()

void KisSwatch::setName

(

const QString &

name

)

Definition at line 20 of file KisSwatch.cpp.

{
    m_name = name;
    m_valid = true;
}

References m_name, m_valid, and name().

setSpotColor()

void KisSwatch::setSpotColor

(

bool

spotColor

)

Definition at line 38 of file KisSwatch.cpp.

{
    m_spotColor = spotColor;
    m_valid = true;
}

References m_spotColor, m_valid, and spotColor().

spotColor()

bool KisSwatch::spotColor ( ) const

inline

Definition at line 33 of file KisSwatch.h.

{ return m_spotColor; }

writeToStream()

void KisSwatch::writeToStream	(	QDataStream &	stream,
		const QString &	groupName,
		int	originalRow,
		int	originalColumn )

Definition at line 44 of file KisSwatch.cpp.

{
    QDomDocument doc;
    QDomElement root = doc.createElement("Color");
    root.setAttribute("bitdepth", color().colorSpace()->colorDepthId().id());
    doc.appendChild(root);
    color().toXML(doc, root);
 
    stream << name() << id() << spotColor()
           << originalRow << originalColumn
           << groupName << doc.toString();
}

References color(), id(), name(), spotColor(), and KoColor::toXML().

Member Data Documentation

m_color

KoColor KisSwatch::m_color

private

Definition at line 48 of file KisSwatch.h.

m_id

QString KisSwatch::m_id

private

Definition at line 50 of file KisSwatch.h.

m_name

QString KisSwatch::m_name

private

Definition at line 49 of file KisSwatch.h.

m_spotColor

bool KisSwatch::m_spotColor {false}

private

Definition at line 51 of file KisSwatch.h.

{false};

m_valid

bool KisSwatch::m_valid {false}

private

Definition at line 52 of file KisSwatch.h.

{false};

---

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

• libs/pigment/resources/KisSwatch.h
• libs/pigment/resources/KisSwatch.cpp