tdevelop/lib/widgets/propeditor/childproperty.h

/***************************************************************************
 *   Copyright (C) 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 CHILDPROPERTY_H
#define CHILDPROPERTY_H

#include "property.h"

namespace PropertyLib{

class MultiProperty;

/**
@short Child property

Child property is a detailed property for complex parent properties.
For example, to edit a property of Point type one can request two
child properties for "x" and "y" components of a point.

Child properties instances usually belong to MultiProperty class
which is used to fetch and display them in the property editor.
Child properties are created by a PropertyMachineFactory.
Factory in such case does not only creates a machine for a property,
but also fills corrresponding multiproperty with a list of child
properties.
*/
class ChildProperty: public Property{
public:
    enum ChildPropertyType {
        Size_Height,
        Size_Width,
        Point_X,
        Point_Y,
        Rect_X,
        Rect_Y,
        Rect_Width,
        Rect_Height,
        SizePolicy_HorData,
        SizePolicy_VerData,
        SizePolicy_HorStretch,
        SizePolicy_VerStretch
    };
    
    /**Constructs empty property.*/
    ChildProperty() {}
    /**Constructs property.*/
    ChildProperty(MultiProperty *parent, int type, ChildPropertyType childType, const TQString &name,
        const TQString &description, const TQVariant &value = TQVariant(),
        bool save = true, bool readOnly = false);
    /**Constructs property with @ref ValueFromList type.*/
    ChildProperty(MultiProperty *parent, const TQString &name, ChildPropertyType childType,
        const TQMap<TQString, TQVariant> &v_valueList, const TQString &description,
        const TQVariant &value = TQVariant(), bool save = true, bool readOnly = false);

    /**@return the value of the property.*/
    virtual TQVariant value() const;
    /**Sets the value of the property.*/
    virtual void setValue(const TQVariant &value, bool rememberOldValue = true);
    
private:
    MultiProperty *m_parent;
    ChildPropertyType m_childType;
};

}

#endif