property.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_PROPERTY_H
#define KPROPERTY_PROPERTY_H
 
#include <tqvariant.h>
#include "koproperty_global.h"
 
template<class U> class TQAsciiDict;
template<class U> class TQAsciiDictIterator;

namespace KoProperty {
 
class PropertyPrivate;
class CustomProperty;
class Set;

//KOPROPERTY_EXPORT TQStringVariantMap createValueListFromStringLists(
//  const TQStringList &keys, const TQStringList &values);

enum PropertyType {
    //standard supported TQVariant types
    Auto = TQVariant::Invalid - 1,
    Invalid = TQVariant::Invalid   ,
    Map = TQVariant::Map           ,
    List = TQVariant::List         ,
    String = TQVariant::String     ,
    StringList = TQVariant::StringList  ,
    Font = TQVariant::Font         ,
    Pixmap = TQVariant::Pixmap     ,
    Rect = TQVariant::Rect         ,
    Size = TQVariant::Size         ,
    Color = TQVariant::Color       ,
    Point = TQVariant::Point       ,
    Integer = TQVariant::Int       ,
    Boolean = TQVariant::Bool      ,
    Double = TQVariant::Double     ,
    CString = TQVariant::CString   ,
    Cursor = TQVariant::Cursor     ,
    SizePolicy = TQVariant::SizePolicy  ,
    Date = TQVariant::Date         ,
    Time = TQVariant::Time         ,
    DateTime = TQVariant::DateTime ,
 
    //predefined custom types
    ValueFromList = 2000          ,
    Symbol = 2001                 ,
    FontName                      ,
    FileURL                       ,
    PictureFileURL                ,
    DirectoryURL                  ,
    LineStyle                     ,
 
    // Child property types
    Size_Height = 3001,
    Size_Width,
    Point_X,
    Point_Y,
    Rect_X,
    Rect_Y,
    Rect_Width,
    Rect_Height,
    SizePolicy_HorData,
    SizePolicy_VerData,
    SizePolicy_HorStretch,
    SizePolicy_VerStretch,
 
    UserDefined = 4000            
};

class KOPROPERTY_EXPORT Property
{
    public:
        static const Property null;
 
        typedef TQAsciiDict<Property> Dict;
        typedef TQAsciiDictIterator<Property> DictIterator;

        class KOPROPERTY_EXPORT ListData
        {
        public:
            ListData(const TQStringList& keys_, const TQStringList& names_);
            ListData(const TQValueList<TQVariant> keys_, const TQStringList& names_);
            ListData();
            ~ListData();
 
            void setKeysAsStringList(const TQStringList& list);
            TQStringList keysAsStringList() const;

            TQValueList<TQVariant> keys;
//          TQStringList keys;


            TQStringList names;
 
//unused for now            /*! True (the default), if the list has fixed number of possible
//unused for now             items (keys). If this is false, user can add or enter own values. */
//unused for now            bool fixed : 1;
        };

        Property();

        Property(const TQCString &name, const TQVariant &value = TQVariant(),
            const TQString &caption = TQString(), const TQString &description = TQString(),
            int type = Auto, Property* parent = 0);

        Property(const TQCString &name, const TQStringList &keys, const TQStringList &strings,
            const TQVariant &value = TQVariant(),
            const TQString &caption = TQString(), const TQString &description = TQString(),
            int type = ValueFromList, Property* parent = 0);

        Property(const TQCString &name, ListData* listData,
            const TQVariant &value = TQVariant(),
            const TQString &caption = TQString(), const TQString &description = TQString(),
            int type = ValueFromList, Property* parent = 0);

        Property(const Property &prop);
 
        ~Property();

        TQCString name() const;

        void setName(const TQCString &name);

        TQString caption() const;

        TQString captionForDisplaying() const;

        void setCaption(const TQString &caption);

        TQString description() const;

        void setDescription(const TQString &description);

        int type() const;

        void setType(int type);

        TQVariant value() const;

        TQVariant oldValue() const;

        void setValue(const TQVariant &value, bool rememberOldValue = true, bool useCustomProperty=true);

        void resetValue();

        ListData* listData() const;

        void setListData(ListData* list);

        void setListData(const TQStringList &keys, const TQStringList &names);

        void setIcon(const TQString &icon);

        TQString icon() const;

        const TQValueList<Property*>*  children() const;

        Property* child(const TQCString &name);

        Property* parent() const;

        CustomProperty* customProperty() const;

        void setCustomProperty(CustomProperty *prop);

        bool isNull() const;

        operator bool () const;

        bool isModified() const;

        void clearModifiedFlag();

        bool isReadOnly() const;

        void setReadOnly(bool readOnly);

        bool isVisible() const;

        void setVisible(bool visible);

        bool isStorable() const;

        void setStorable(bool storable);

        int autoSync() const;

        void setAutoSync(int sync);

        void setOption(const char* name, const TQVariant& val);

        TQVariant option(const char* name) const;

        bool hasOptions() const;

        const Property& operator= (const TQVariant& val);

        const Property& operator= (const Property &property);

        bool operator ==(const Property &prop) const;

        int sortingKey() const;
 
    protected:
        void addChild(Property *prop);

        void addSet(Set *set);

        void setSortingKey(int key);

        const TQValueList<Property*>* related() const;

        void addRelatedProperty(Property *property);

        void emitPropertyChanged();

        void debug();

        PropertyPrivate *d;
 
    friend class Set;
    friend class Buffer;
    friend class CustomProperty;
};
 
}
 
#endif