Property.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (c) Jürgen Riegel          (juergen.riegel@web.de) 2002     *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   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., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef APP_PROPERTY_H
#define APP_PROPERTY_H

// Std. configurations

#include <Base/Persistence.h>
#include <string>
#include <bitset>


namespace App
{

class PropertyContainer;

class AppExport Property : public Base::Persistence
{
    TYPESYSTEM_HEADER();

public:
    Property();
    virtual ~Property();

    virtual unsigned int getMemSize (void) const {
        // you have to implement this method in all property classes!
        return Base::Persistence::getMemSize() + sizeof(father) + sizeof(StatusBits);
    }

    const char* getName(void) const;

    virtual const char* getEditorName(void) const { return ""; }

    short getType(void) const; 

    const char* getGroup(void) const;

    const char* getDocumentation(void) const;

    void setContainer(PropertyContainer *Father);

    PropertyContainer *getContainer(void) const {return father;}
    void touch();
    bool isTouched(void) const {return StatusBits.test(0);}
    void purgeTouched(void){StatusBits.reset(0);}

    virtual Property *Copy(void) const = 0;
    virtual void Paste(const Property &from) = 0;
    std::string encodeAttribute(const std::string&) const;


    friend class PropertyContainer;

    std::bitset<32> StatusBits;


protected:
    void hasSetValue(void);
    void aboutToSetValue(void);

private:
    // forbidden
    Property(const Property&);
    Property& operator = (const Property&);

private:
    PropertyContainer *father;
};


class AppExport PropertyLists : public Property
{
    TYPESYSTEM_HEADER();

public:
    virtual void setSize(int newSize)=0;   
    virtual int getSize(void) const =0;   
};

} // namespace App

#endif // APP_PROPERTY_H