F:/KPlato/koffice/libs/koproperty/property.h

Aller à la documentation de ce fichier.

/* 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 <QVariant>
#include <QStringList>
#include <QByteArray>
#include "koproperty_global.h"

template<class U> class Q3AsciiDict;
template<class U> class Q3AsciiDictIterator;

namespace KoProperty {

class PropertyPrivate;
class CustomProperty;
class Set;

//KOPROPERTY_EXPORT QMap<QString, QVariant> createValueListFromStringLists(
//      const QStringList &keys, const QStringList &values);

enum PropertyType {
        //standard supported QVariant types
        Auto = QVariant::Invalid - 1,
        Invalid = QVariant::Invalid   ,
        Map = QVariant::Map           ,
        List = QVariant::List         ,
        String = QVariant::String     ,
        StringList = QVariant::StringList  ,
        Font = QVariant::Font         ,
        Pixmap = QVariant::Pixmap     ,
        Rect = QVariant::Rect         ,
        Size = QVariant::Size         ,
        Color = QVariant::Color       ,
        Point = QVariant::Point       ,
        Integer = QVariant::Int       ,
        Boolean = QVariant::Bool      ,
        Double = QVariant::Double     ,
        CString = QVariant::CString   ,
        Cursor = QVariant::Cursor     ,
        SizePolicy = QVariant::SizePolicy  ,
        Date = QVariant::Date         ,
        Time = QVariant::Time         ,
        DateTime = QVariant::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:
                QT_STATIC_CONST Property null;

                typedef Q3AsciiDict<Property> Dict;
                typedef Q3AsciiDictIterator<Property> DictIterator;

                class KOPROPERTY_EXPORT ListData
                {
                public:
                        ListData(const QStringList& keys_, const QStringList& names_);
                        ListData(const QList<QVariant> keys_, const QStringList& names_);
                        ListData();
                        ~ListData();

                        void setKeysAsStringList(const QStringList& list);
                        QStringList keysAsStringList() const;

                        QList<QVariant> keys;
//                      QStringList keys;


                        QStringList 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 QByteArray &name, const QVariant &value = QVariant(),
                        const QString &caption = QString::null, const QString &description = QString::null,
                        int type = Auto, Property* parent = 0);

                Property(const QByteArray &name, const QStringList &keys, const QStringList &strings, 
                        const QVariant &value = QVariant(),
                        const QString &caption = QString::null, const QString &description = QString::null,
                        int type = ValueFromList, Property* parent = 0);

                Property(const QByteArray &name, ListData* listData,
                        const QVariant &value = QVariant(),
                        const QString &caption = QString::null, const QString &description = QString::null,
                        int type = ValueFromList, Property* parent = 0);

                Property(const Property &prop);

                ~Property();

                QByteArray name() const;

                void setName(const QByteArray &name);

                QString caption() const;

                QString captionForDisplaying() const;

                void setCaption(const QString &caption);

                QString description() const;

                void setDescription(const QString &description);

                int type() const;

                void setType(int type);

                QVariant value() const;

                QVariant oldValue() const;

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

                void resetValue();

                ListData* listData() const;

                void setListData(ListData* list);

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

                void setIcon(const QString &icon);

                QString icon() const;

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

                Property* child(const QByteArray &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 QVariant& val);

                QVariant option(const char* name) const;

                bool hasOptions() const;

                const Property& operator= (const QVariant& 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 QList<Property*>* related() const;

                void addRelatedProperty(Property *property);

                void emitPropertyChanged();

                void debug();

                PropertyPrivate *d;

        friend class Set;
        friend class Buffer;
        friend class CustomProperty;
};

}

#endif

---