property.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2002-2004 by Alexander Dymo  <cloudtemple@mskat.net>    *
 *                                                                         *
 *   This program 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 program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this program; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.             *
 ***************************************************************************/
#ifndef PROPERTY_H
#define PROPERTY_H
 
#include <tqvariant.h>
 
#include <tqmap.h>
 
class TQWidget;
class TQString;

namespace PropertyLib{


class Property {
public:
    enum PropertyType {
        //standard supported TQVariant types
        Invalid = TQVariant::Invalid        ,
        Map = TQVariant::Map                ,
        List = TQVariant::List              ,       
        String = TQVariant::String          ,
        StringList = TQVariant::StringList  ,
        Font = TQVariant::Font              ,
        Pixmap = TQVariant::Pixmap          ,
        //@todo implement TQVariant::Brush
        Rect = TQVariant::Rect              ,
        Size = TQVariant::Size              ,
        Color = TQVariant::Color            ,
        //@todo implement TQVariant::Palette
        //@todo implement TQVariant::ColorGroup
        //@todo implement TQVariant::IconSet
        Point = TQVariant::Point            ,
        //@todo implement TQVariant::Image
        Integer = TQVariant::Int            ,
        //@todo implement TQVariant::UInt
        Boolean = TQVariant::Bool           ,
        Double = TQVariant::Double          ,
        //@todo implement TQVariant::CString
        //@todo implement TQVariant::PointArray
        //@todo implement TQVariant::Region
        //@todo implement TQVariant::Bitmap
        Cursor = TQVariant::Cursor          ,
        SizePolicy = TQVariant::SizePolicy  ,
        Date = TQVariant::Date              ,
        //@todo implement TQVariant::Time
        DateTime = TQVariant::DateTime      ,
        //@todo implement TQVariant::ByteArray
        //@todo implement TQVariant::BitArray
        //@todo implement TQVariant::KeySequence
        //@todo implement TQVariant::Pen
        //@todo implement TQVariant::Long
        //@todo implement TQVariant::LongLong
        //@todo implement TQVariant::ULongLong
        
 
        //predefined custom types
        ValueFromList = 2000               ,
        Symbol = 2001                      ,
        FontName = 2002                    ,
        FileURL = 2003                     ,
        DirectoryURL = 2004                ,
        LineStyle = 2005                   ,
 
        UserDefined = 3000                 
    };

    Property() {}
    Property(int type, const TQString &name, const TQString &description,
        const TQVariant &value = TQVariant(), bool save = true, bool readOnly = false);
    Property(const TQString &name, const TQStringVariantMap &v_valueList,
        const TQString &description, const TQVariant &value = TQVariant(), bool save = true, bool readOnly = false);
    virtual ~Property();
 
    virtual bool operator<(const Property &prop) const;

    virtual TQString name() const;
    virtual void setName(const TQString &name);
    virtual int type() const;
    virtual void setType(int type);
    virtual TQVariant value() const;
    virtual void setValue(const TQVariant &value, bool rememberOldValue = true);
    virtual TQString description() const;
    virtual void setDescription(const TQString &description);
    virtual void setValueList(const TQStringVariantMap &list);
    TQStringVariantMap valueList;

    virtual bool allowSaving() const;
    virtual bool readOnly() const;
    virtual bool visible() const;
    virtual void setVisible(const bool visible);
    
    virtual TQVariant oldValue() const;
    
private:
//    Property(Property &property) {};
//    void operator=(Property &property) {};
 
    int m_type;
    TQString m_name;
    TQString m_description;
    TQVariant m_value;
    TQVariant m_oldValue;
    bool m_save;
    bool m_readOnly;
    bool m_visible;
};
 
}
 
#endif