kpalette.h

/* 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 palette.
 
#ifndef KDELIBS_KPALETTE_H
#define KDELIBS_KPALETTE_H
 
#include <tqcolor.h>
#include <tqptrlist.h>
#include <tqstring.h>
#include <tqstringlist.h>
#include "tdelibs_export.h"
 
class KPalettePrivate;

class TDECORE_EXPORT KPalette
{
public:
   static TQStringList getPaletteList();

   KPalette(const TQString &name=TQString::null);

   KPalette(const KPalette &);

   virtual ~KPalette();
   
   KPalette& operator=( const KPalette &);

   bool save();

   TQString description() const
    { return mDesc; }

   void setDescription(const TQString &desc)
    { mDesc = desc; }
   
   TQString name() const
    { return mName; }

   void setName(const TQString &name)
    { mName = name; }

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

   void setEditable(Editable editable)
    { mEditable = editable; }
   
   int nrColors() const
    { return (int) mKolorList.count(); }

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

   TQString colorName(int index);
   
   TQString colorName(const TQColor &color)
    { return colorName( findColor(color)); }
   
   int addColor(const TQColor &newColor, 
                const TQString &newColorName = TQString::null);

   int changeColor(int index, 
                   const TQColor &newColor, 
                   const TQString &newColorName = TQString::null);
 
   int changeColor(const TQColor &oldColor, 
                   const TQColor &newColor, 
                   const TQString &newColorName = TQString::null)
    { return changeColor( findColor(oldColor), newColor, newColorName); }
 
private:   
   typedef struct { TQColor color; TQString name; } kolor;
   TQPtrList<kolor> mKolorList;
   
   TQString mName;
   TQString mDesc;
   Editable mEditable;
 
   KPalettePrivate *d;
};
 
 
#endif      // KDELIBS_KPALETTE_H