set.h

/* This file is part of the KDE project
   Copyright (C) 2004 Cedric Pasteur <cedric.pasteur@free.fr>
   Copyright (C) 2004 Alexander Dymo <cloudtemple@mskat.net>
   Copyright (C) 2004-2006 Jaroslaw Staniek <js@iidea.pl>
 
   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 KPROPERTY_SET_H
#define KPROPERTY_SET_H
 
#include "koproperty_global.h"
#include <tqobject.h>
#include <tqasciidict.h>
 
namespace KoProperty {
 
class Property;
class SetPrivate;

class KOPROPERTY_EXPORT Set : public TQObject
{
    TQ_OBJECT
  
 
    public:
        class KOPROPERTY_EXPORT Iterator {
            public:
                Iterator(const Set &set);
                ~Iterator();
 
                void operator ++();
                Property*  operator *() const;
 
                TQCString  currentKey() const;
                Property*  current() const;
 
            private:
                TQAsciiDictIterator<Property> *iterator;
                friend class Set;
        };
 
        explicit Set(TQObject *parent=0, const TQString &typeName=TQString());

        explicit Set(const Set& set);
 
        virtual ~Set();

        void addProperty(Property *property, TQCString group = "common");

        void removeProperty(Property *property);

        void removeProperty(const TQCString &name);

        virtual void clear();

        uint count() const;

        bool isEmpty() const;

        bool isReadOnly() const;

        void setReadOnly(bool readOnly);

        bool contains(const TQCString &name) const;

        Property& property( const TQCString &name) const;

        Property& operator[](const TQCString &name) const;

        const Set& operator= (const Set &set);

        void changeProperty(const TQCString &property, const TQVariant &value);

        void setGroupDescription(const TQCString &group, const TQString& desc);

        TQString groupDescription(const TQCString &group) const;

        void setGroupIcon(const TQCString &group, const TQString& icon);

        TQString groupIcon(const TQCString &group) const;

        const TQValueList<TQCString>& groupNames() const;

        const TQValueList<TQCString>& propertyNamesForGroup(const TQCString &group) const;

        TQCString prevSelection() const;
 
        void setPrevSelection(const TQCString& prevSelection);

        TQString typeName() const;

        void debug();
 
    protected:
        Set(bool propertyOwner);

        void addToGroup(const TQCString &group, Property *property);

        void removeFromGroup(Property *property);

        void addPropertyInternal(Property *property, TQCString group, bool updateSortingKey);

        void informAboutClearing(bool& cleared);
 
    signals:
        void propertyChanged(KoProperty::Set& set, KoProperty::Property& property);

        void propertyChangedInternal(KoProperty::Set& set, KoProperty::Property& property);

        void propertyReset(KoProperty::Set& set, KoProperty::Property& property);

        void aboutToDeleteProperty(KoProperty::Set& set, KoProperty::Property& property);

        void aboutToBeCleared();

        void aboutToBeDeleted();
 
    protected:
        SetPrivate *d;
 
    friend class Iterator;
    friend class Property;
    friend class Buffer;
};

class KOPROPERTY_EXPORT Buffer : public Set
{
    TQ_OBJECT
  
 
    public:
        Buffer();
        Buffer(const Set *set);

        virtual void intersect(const Set *set);
 
    protected slots:
        void intersectedChanged(KoProperty::Set& set, KoProperty::Property& prop);
        void intersectedReset(KoProperty::Set& set, KoProperty::Property& prop);
 
    private:
        void initialSet(const Set *set);
};
 
}
 
#endif