tdeconfigskeleton.h

/*
 * This file is part of KDE.
 * 
 * Copyright (c) 2001,2002,2003 Cornelius Schumacher <schumacher@kde.org>
 * Copyright (c) 2003 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; either
 * version 2 of the License, or (at your option) any later version.
 * 
 * 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.
 */
 
#ifndef _TDECONFIGSKELETON_H
#define _TDECONFIGSKELETON_H
 
#include <tqcolor.h>
#include <tqdatetime.h>
#include <tqfont.h>
#include <tqpoint.h>
#include <tqptrlist.h>
#include <tqdict.h>
#include <tqrect.h>
#include <tqsize.h>
#include <tqstringlist.h>
#include <tqvariant.h>
#include <tdeconfig.h>
#include <tdeglobalsettings.h>

  class TDECORE_EXPORT TDEConfigSkeletonItem
  {
  public:
    typedef TQValueList < TDEConfigSkeletonItem * >List;
    typedef TQDict < TDEConfigSkeletonItem > Dict;
    typedef TQDictIterator < TDEConfigSkeletonItem > DictIterator;

    TDEConfigSkeletonItem(const TQString & group, const TQString & key)
      :mGroup(group),mKey(key), mIsImmutable(true)
    {
    }

    virtual ~TDEConfigSkeletonItem()
    {
    }

    void setGroup( const TQString &group )
    {
      mGroup = group;
    }

    TQString group() const
    {
      return mGroup;
    }

    void setKey( const TQString &key )
    {
      mKey = key;
    }
    
    TQString key() const
    {
      return mKey;
    }

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

    TQString name() const
    {
      return mName;
    }

    void setLabel( const TQString &l )
    {
      mLabel = l;
    }
    
    TQString label() const
    {
      return mLabel;
    }

    void setWhatsThis( const TQString &w )
    {
      mWhatsThis = w;
    }
    
    TQString whatsThis() const
    {
      return mWhatsThis;
    }

    virtual void readConfig(TDEConfig *) = 0;

    virtual void writeConfig(TDEConfig *) = 0;

    virtual void readDefault(TDEConfig *) = 0;

    virtual void setProperty(const TQVariant &p) = 0;
    
    virtual TQVariant property() const = 0;

    virtual TQVariant minValue() const { return TQVariant(); }

    virtual TQVariant maxValue() const { return TQVariant(); }

    virtual void setDefault() = 0;

    virtual void swapDefault() = 0;

    bool isImmutable() const
    {
      return mIsImmutable;
    }
 
  protected:
    void readImmutability(TDEConfig *config);
 
    TQString mGroup;
    TQString mKey;
    TQString mName;
 
  private:
    bool mIsImmutable;
 
    TQString mLabel;
    TQString mWhatsThis;
  };
 
 
template < typename T > class TDEConfigSkeletonGenericItem:public TDEConfigSkeletonItem
  {
  public:
    TDEConfigSkeletonGenericItem(const TQString & group, const TQString & key, T & reference,
                T defaultValue)
      : TDEConfigSkeletonItem(group, key), mReference(reference),
        mDefault(defaultValue), mLoadedValue(defaultValue)
    {
    }

    void setValue(const T & v)
    {
      mReference = v;
    }

    T & value()
    {
      return mReference;
    }

    const T & value() const
    {
      return mReference;
    }

    virtual void setDefaultValue( const T &v )
    {
      mDefault = v;
    }
 
    virtual void setDefault()
    {
      mReference = mDefault;
    }
 
    virtual void writeConfig(TDEConfig * config)
    {
      if ( mReference != mLoadedValue ) // Is this needed?
      {
        config->setGroup(mGroup);
        if ((mDefault == mReference) && !config->hasDefault( mKey))
          config->revertToDefault( mKey );
        else
          config->writeEntry(mKey, mReference);
      }
    }
 
    void readDefault(TDEConfig * config)
    {
      config->setReadDefaults(true);
      readConfig(config);
      config->setReadDefaults(false);
      mDefault = mReference;
    }
 
    void swapDefault()
    {
      T tmp = mReference;
      mReference = mDefault;
      mDefault = tmp;
    }
 
  protected:
    T & mReference;
    T mDefault;
    T mLoadedValue;
  };

class TDECORE_EXPORT TDEConfigSkeleton
{
public:

  class TDECORE_EXPORT ItemString:public TDEConfigSkeletonGenericItem < TQString >
  {
  public:
    enum Type { Normal, Password, Path };
 
    ItemString(const TQString & group, const TQString & key,
               TQString & reference,
               const TQString & defaultValue = TQString::fromLatin1(""), // NOT TQString::null !!
               Type type = Normal);
 
    void writeConfig(TDEConfig * config);
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
 
  private:
    Type mType;
  };

  class TDECORE_EXPORT ItemPassword:public ItemString
  {
  public:
    ItemPassword(const TQString & group, const TQString & key,
               TQString & reference,
               const TQString & defaultValue = TQString::fromLatin1("")); // NOT TQString::null !!
  };

  class TDECORE_EXPORT ItemPath:public ItemString
  {
  public:
    ItemPath(const TQString & group, const TQString & key,
             TQString & reference,
             const TQString & defaultValue = TQString::null);
  };
 

  class TDECORE_EXPORT ItemProperty:public TDEConfigSkeletonGenericItem < TQVariant >
  {
  public:
    ItemProperty(const TQString & group, const TQString & key,
                 TQVariant & reference, TQVariant defaultValue = 0);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemBool:public TDEConfigSkeletonGenericItem < bool >
  {
  public:
    ItemBool(const TQString & group, const TQString & key, bool & reference,
             bool defaultValue = true);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemInt:public TDEConfigSkeletonGenericItem < int >
  {
  public:
    ItemInt(const TQString & group, const TQString & key, int &reference,
            int defaultValue = 0);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
    TQVariant minValue() const;
    TQVariant maxValue() const;
 
    void setMinValue(int);
    void setMaxValue(int);
    
  private:  
    bool mHasMin : 1;
    bool mHasMax : 1;
    int mMin;
    int mMax;
  };

  class TDECORE_EXPORT ItemInt64:public TDEConfigSkeletonGenericItem < TQ_INT64 >
  {
  public:
    ItemInt64(const TQString & group, const TQString & key, TQ_INT64 &reference,
            TQ_INT64 defaultValue = 0);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
 
    TQVariant minValue() const;
    TQVariant maxValue() const;
 
    void setMinValue(TQ_INT64);
    void setMaxValue(TQ_INT64);
    
  private:  
    bool mHasMin : 1;
    bool mHasMax : 1;
    TQ_INT64 mMin;
    TQ_INT64 mMax;
  };

  class TDECORE_EXPORT ItemEnum:public ItemInt
  {
  public:
    struct Choice
    {
      TQString name;
      TQString label;
      TQString whatsThis;
    };
 
    ItemEnum(const TQString & group, const TQString & key, int &reference,
             const TQValueList<Choice> &choices, int defaultValue = 0);
 
    TQValueList<Choice> choices() const;
 
    void readConfig(TDEConfig * config);
    void writeConfig(TDEConfig * config);
 
  private:
      TQValueList<Choice> mChoices;
  };
 

  class TDECORE_EXPORT ItemUInt:public TDEConfigSkeletonGenericItem < unsigned int >
  {
  public:
    ItemUInt(const TQString & group, const TQString & key,
             unsigned int &reference, unsigned int defaultValue = 0);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
    TQVariant minValue() const;
    TQVariant maxValue() const;
 
    void setMinValue(unsigned int);
    void setMaxValue(unsigned int);
    
  private:  
    bool mHasMin : 1;
    bool mHasMax : 1;
    unsigned int mMin;
    unsigned int mMax;
  };
 

  class TDECORE_EXPORT ItemLong:public TDEConfigSkeletonGenericItem < long >
  {
  public:
    ItemLong(const TQString & group, const TQString & key, long &reference,
             long defaultValue = 0);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
    TQVariant minValue() const;
    TQVariant maxValue() const;
 
    void setMinValue(long);
    void setMaxValue(long);
    
  private:  
    bool mHasMin : 1;
    bool mHasMax : 1;
    long mMin;
    long mMax;
  };
 

  class TDECORE_EXPORT ItemULong:public TDEConfigSkeletonGenericItem < unsigned long >
  {
  public:
    ItemULong(const TQString & group, const TQString & key,
              unsigned long &reference, unsigned long defaultValue = 0);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
    TQVariant minValue() const;
    TQVariant maxValue() const;
 
    void setMinValue(unsigned long);
    void setMaxValue(unsigned long);
    
  private:  
    bool mHasMin : 1;
    bool mHasMax : 1;
    unsigned long mMin;
    unsigned long mMax;
  };

  class TDECORE_EXPORT ItemUInt64:public TDEConfigSkeletonGenericItem < TQ_UINT64 >
  {
  public:
    ItemUInt64(const TQString & group, const TQString & key, TQ_UINT64 &reference,
            TQ_UINT64 defaultValue = 0);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
 
    TQVariant minValue() const;
    TQVariant maxValue() const;
 
    void setMinValue(TQ_UINT64);
    void setMaxValue(TQ_UINT64);
    
  private:  
    bool mHasMin : 1;
    bool mHasMax : 1;
    TQ_UINT64 mMin;
    TQ_UINT64 mMax;
  };

  class TDECORE_EXPORT ItemDouble:public TDEConfigSkeletonGenericItem < double >
  {
  public:
    ItemDouble(const TQString & group, const TQString & key,
               double &reference, double defaultValue = 0);
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
    TQVariant minValue() const;
    TQVariant maxValue() const;
 
    void setMinValue(double);
    void setMaxValue(double);
    
  private:  
    bool mHasMin : 1;
    bool mHasMax : 1;
    double mMin;
    double mMax;
  };
 

  class TDECORE_EXPORT ItemColor:public TDEConfigSkeletonGenericItem < TQColor >
  {
  public:
    ItemColor(const TQString & group, const TQString & key,
              TQColor & reference,
              const TQColor & defaultValue = TQColor(128, 128, 128));
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemFont:public TDEConfigSkeletonGenericItem < TQFont >
  {
  public:
    ItemFont(const TQString & group, const TQString & key, TQFont & reference,
             const TQFont & defaultValue = TDEGlobalSettings::generalFont());
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemRect:public TDEConfigSkeletonGenericItem < TQRect >
  {
  public:
    ItemRect(const TQString & group, const TQString & key, TQRect & reference,
             const TQRect & defaultValue = TQRect());
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemPoint:public TDEConfigSkeletonGenericItem < TQPoint >
  {
  public:
    ItemPoint(const TQString & group, const TQString & key, TQPoint & reference,
              const TQPoint & defaultValue = TQPoint());
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemSize:public TDEConfigSkeletonGenericItem < TQSize >
  {
  public:
    ItemSize(const TQString & group, const TQString & key, TQSize & reference,
             const TQSize & defaultValue = TQSize());
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemDateTime:public TDEConfigSkeletonGenericItem < TQDateTime >
  {
  public:
    ItemDateTime(const TQString & group, const TQString & key,
                 TQDateTime & reference,
                 const TQDateTime & defaultValue = TQDateTime());
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemStringList:public TDEConfigSkeletonGenericItem < TQStringList >
  {
  public:
    ItemStringList(const TQString & group, const TQString & key,
                   TQStringList & reference,
                   const TQStringList & defaultValue = TQStringList());
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 

  class TDECORE_EXPORT ItemPathList:public ItemStringList
  {
  public:
    ItemPathList(const TQString & group, const TQString & key,
                   TQStringList & reference,
                   const TQStringList & defaultValue = TQStringList());
 
    void readConfig(TDEConfig * config);
    void writeConfig(TDEConfig * config);
  };
 

  class TDECORE_EXPORT ItemIntList:public TDEConfigSkeletonGenericItem < TQValueList < int > >
  {
  public:
    ItemIntList(const TQString & group, const TQString & key,
                TQValueList < int >&reference,
                const TQValueList < int >&defaultValue = TQValueList < int >());
 
    void readConfig(TDEConfig * config);
    void setProperty(const TQVariant & p);
    TQVariant property() const;
  };
 
 
public:
  TDEConfigSkeleton(const TQString & configname = TQString::null);

  TDEConfigSkeleton(TDESharedConfig::Ptr config);

    virtual ~ TDEConfigSkeleton();

  void setDefaults();

  void readConfig();

  void writeConfig();

  void setCurrentGroup(const TQString & group);

  TQString currentGroup() // ### KDE 4.0: make const
  {
    return mCurrentGroup;
  }

  void addItem(TDEConfigSkeletonItem *, const TQString & name = TQString::null );

  ItemString *addItemString(const TQString & name, TQString & reference,
                            const TQString & defaultValue = TQString::fromLatin1(""), // NOT TQString::null !!
                            const TQString & key = TQString::null);

  ItemPassword *addItemPassword(const TQString & name, TQString & reference,
                              const TQString & defaultValue = TQString::fromLatin1(""),
                              const TQString & key = TQString::null);

  ItemPath *addItemPath(const TQString & name, TQString & reference,
                          const TQString & defaultValue = TQString::fromLatin1(""),
                          const TQString & key = TQString::null);

  ItemProperty *addItemProperty(const TQString & name, TQVariant & reference,
                                const TQVariant & defaultValue = TQVariant(),
                                const TQString & key = TQString::null);
  ItemBool *addItemBool(const TQString & name, bool & reference,
                        bool defaultValue = false,
                        const TQString & key = TQString::null);

  ItemInt *addItemInt(const TQString & name, int &reference, int defaultValue = 0,
                      const TQString & key = TQString::null);

  ItemUInt *addItemUInt(const TQString & name, unsigned int &reference,
                        unsigned int defaultValue = 0,
                        const TQString & key = TQString::null);

  ItemLong *addItemLong(const TQString & name, long &reference,
                        long defaultValue = 0,
                        const TQString & key = TQString::null);

  ItemULong *addItemULong(const TQString & name, unsigned long &reference,
                          unsigned long defaultValue = 0,
                          const TQString & key = TQString::null);

  ItemInt64 *addItemInt64(const TQString & name, TQ_INT64 &reference,
                          TQ_INT64 defaultValue = 0,
                          const TQString & key = TQString::null);

  ItemUInt64 *addItemUInt64(const TQString & name, TQ_UINT64 &reference,
                            TQ_UINT64 defaultValue = 0,
                            const TQString & key = TQString::null);

  ItemDouble *addItemDouble(const TQString & name, double &reference,
                            double defaultValue = 0.0,
                            const TQString & key = TQString::null);

  ItemColor *addItemColor(const TQString & name, TQColor & reference,
                          const TQColor & defaultValue = TQColor(128, 128, 128),
                          const TQString & key = TQString::null);

  ItemFont *addItemFont(const TQString & name, TQFont & reference,
                        const TQFont & defaultValue =
                        TDEGlobalSettings::generalFont(),
                        const TQString & key = TQString::null);

  ItemRect *addItemRect(const TQString & name, TQRect & reference,
                        const TQRect & defaultValue = TQRect(),
                        const TQString & key = TQString::null);

  ItemPoint *addItemPoint(const TQString & name, TQPoint & reference,
                          const TQPoint & defaultValue = TQPoint(),
                          const TQString & key = TQString::null);

  ItemSize *addItemSize(const TQString & name, TQSize & reference,
                        const TQSize & defaultValue = TQSize(),
                        const TQString & key = TQString::null);

  ItemDateTime *addItemDateTime(const TQString & name, TQDateTime & reference,
                                const TQDateTime & defaultValue = TQDateTime(),
                                const TQString & key = TQString::null);

  ItemStringList *addItemStringList(const TQString & name, TQStringList & reference,
                                    const TQStringList & defaultValue = TQStringList(),
                                    const TQString & key = TQString::null);

  ItemIntList *addItemIntList(const TQString & name, TQValueList < int >&reference,
                              const TQValueList < int >&defaultValue =
                              TQValueList < int >(),
                              const TQString & key = TQString::null);

  TDEConfig *config() const;

  TDEConfigSkeletonItem::List items() const
  {
    return mItems;
  }

  bool isImmutable(const TQString & name);

  TDEConfigSkeletonItem * findItem(const TQString & name);

  bool useDefaults(bool b);
 
protected:
  virtual void usrUseDefaults(bool)
  {
  }
 
  virtual void usrSetDefaults()
  {
  }

  virtual void usrReadConfig()
  {
  }

  virtual void usrWriteConfig()
  {
  }
 
private:
  TQString mCurrentGroup;
 
  TDESharedConfig::Ptr mConfig; // pointer to TDEConfig object
 
  TDEConfigSkeletonItem::List mItems;
  TDEConfigSkeletonItem::Dict mItemDict;
  
  bool mUseDefaults;
 
  class Private;
  Private *d;
 
};
 
#endif