sccolor.h

/*
For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/
/***************************************************************************
                          sccolor.h  -  description
                             -------------------
    begin                : Sun Sep 9 2001
    copyright            : (C) 2001 by Franz Schmid
    email                : Franz.Schmid@altmuehlnet.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SCCOLOR_H
#define SCCOLOR_H

#include <QColor>
#include <QMap>
#include <QPointer>
#include <QString>

#include "scribusapi.h"

class ScribusDoc;


enum colorModel
{
    colorModelRGB,
    colorModelCMYK,
    colorModelLab
};

class SCRIBUS_API ScColor 
{
public:

    friend class ScColorEngine;

    ScColor(void);
    ScColor(int c, int m, int y, int k);
    ScColor(int r, int g, int b);
    ScColor(double l, double a, double b);
    
    bool operator==(const ScColor& other) const;

    void setColor(ScribusDoc* doc, const QString& name);

    void setColor(int c, int m, int y, int k);

    void setColor(double l, double a, double b);

    void setColorRGB(int r, int g, int b);

    colorModel getColorModel () const;

    void fromQColor(QColor color);

    void getRawRGBColor(int *r, int *g, int *b) const;
    QColor getRawRGBColor() const;

    void getCMYK(int *c, int *m, int *y, int *k) const;

    void getRGB(int *r, int *g, int *b) const;

    void getLab(double *L, double *a, double *b) const;

    QString name();
    QString nameRGB(const ScribusDoc* doc = NULL);
    QString nameCMYK(const ScribusDoc* doc = NULL);

    void setNamedColor(QString nam);

    bool isSpotColor() const;
    void setSpotColor(bool s);
    bool isRegistrationColor() const;
    void setRegistrationColor(bool s);

private:

    int CR;
    int MG;
    int YB;
    int K;
    double L_val;
    double a_val;
    double b_val;

    bool Spot;
    bool Regist;
    colorModel Model;
};

class SCRIBUS_API ColorList : public QMap<QString,ScColor>
{
protected:
    QPointer<ScribusDoc> m_doc;
    bool m_retainDoc;

    void ensureBlack(void);

    void ensureWhite(void);

    void ensureRegistration(void);

public:
    ColorList(ScribusDoc* doc = NULL, bool retainDoc = false);

    ColorList& operator= (const ColorList& list);

    ScribusDoc* document(void) const;

    void setDocument(ScribusDoc* doc);

    void addColors(const ColorList& colorList, bool overwrite = true);

    void copyColors(const ColorList& colorList, bool overwrite = true);

    void ensureDefaultColors(void);

    QString tryAddColor(QString name, ScColor col);
};

#endif