kcolorcollection.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1999 Waldo Bastian (bastian@kde.org)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; version 
    2 of the License.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
//-----------------------------------------------------------------------------
// KDE color collection.

#ifndef KDELIBS_KCOLORCOLLECTION_H
#define KDELIBS_KCOLORCOLLECTION_H

#include <kdeui_export.h>

#include <QtGui/QColor>
#include <QtCore/QList>
#include <QtCore/QString>
#include <QtCore/QStringList>

class KDEUI_EXPORT KColorCollection
{
public:
   static QStringList installedCollections();

   explicit KColorCollection(const QString &name=QString());

   KColorCollection(const KColorCollection &);

   ~KColorCollection();
   
   KColorCollection& operator=( const KColorCollection &);

   bool save();

   QString description() const;

   void setDescription(const QString &desc);

   QString name() const;

   void setName(const QString &name);

   enum Editable { Yes, 
                  No,  
           Ask  
   };
  
   Editable editable() const;

   void setEditable(Editable editable);

   int count() const;

   QColor color(int index) const;
   
   int findColor(const QColor &color) const;

   QString name(int index) const;
   
   QString name(const QColor &color) const;

   int addColor(const QColor &newColor, 
                const QString &newColorName = QString());

   int changeColor(int index, 
                   const QColor &newColor, 
                   const QString &newColorName = QString());
 
   int changeColor(const QColor &oldColor, 
                   const QColor &newColor, 
                   const QString &newColorName = QString());

private:
   class KColorCollectionPrivate *d;
};


#endif // KDELIBS_KCOLORCOLLECTION_H