142 lines
5.7 KiB
C++
142 lines
5.7 KiB
C++
/***************************************************************************
|
|
* Copyright (c) 2009 Werner Mayer <wmayer[at]users.sourceforge.net> *
|
|
* *
|
|
* 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_DYNAMICPROPERTY_H
|
|
#define APP_DYNAMICPROPERTY_H
|
|
|
|
#include <Base/Persistence.h>
|
|
#include <map>
|
|
#include <vector>
|
|
#include <string>
|
|
|
|
namespace Base {
|
|
class Writer;
|
|
class XMLWriter;
|
|
}
|
|
|
|
namespace App
|
|
{
|
|
class Property;
|
|
class PropertyContainer;
|
|
|
|
/** This class implements an interface to add properties at run-time to an object
|
|
* derived from PropertyContainer. The additional properties are made persistent.
|
|
* @author Werner Mayer
|
|
*/
|
|
class AppExport DynamicProperty : public Base::Persistence
|
|
{
|
|
public:
|
|
DynamicProperty(PropertyContainer* pc);
|
|
virtual ~DynamicProperty();
|
|
|
|
/** @name Access properties */
|
|
//@{
|
|
/// Get all properties of the class (including parent)
|
|
void getPropertyList(std::vector<Property*> &List) const;
|
|
/// Get all properties of the class (including parent)
|
|
void getPropertyMap(std::map<std::string,Property*> &Map) const;
|
|
/// Find a property by its name
|
|
Property *getPropertyByName(const char* name) const;
|
|
/// Find a dynamic property by its name
|
|
Property *getDynamicPropertyByName(const char* name) const;
|
|
/*!
|
|
Add a dynamic property of the type @a type and with the name @a name.
|
|
@a Group gives the grouping name which appears in the property editor and
|
|
@a doc shows the tooltip there.
|
|
With @a attr, @a ro and @a hidden the behaviour of the property can be controlled.
|
|
@a attr is an OR'ed value of Prop_ReadOnly, Prop_Transient, Prop_Hidden or Prop_Output.
|
|
If no special attribute should be set Prop_None can be set (or leave the default of 0).
|
|
For convenience the attributes for 'Read-Only' and 'Hidden' can also be controlled with
|
|
the values @a ro or @a hidden. This means,
|
|
@code
|
|
addDynamicProperty(..., ..., "Base","blah", Prop_ReadOnly | Prop_Hidden);
|
|
@endcode
|
|
is equivalent to
|
|
@code
|
|
addDynamicProperty(..., ..., "Base","blah", Prop_None, true, true);
|
|
@endcode
|
|
*/
|
|
Property* addDynamicProperty(const char* type, const char* name=0, const char* group=0,
|
|
const char* doc=0, short attr=0, bool ro=false, bool hidden=false);
|
|
/*!
|
|
Removes a dynamic property by name. Returns true if the property is part of the container, otherwise
|
|
false is returned.
|
|
*/
|
|
bool removeDynamicProperty(const char* name);
|
|
/// Get a list of all dynamic properties.
|
|
std::vector<std::string> getDynamicPropertyNames() const;
|
|
/*!
|
|
Get all dynamic properties of the given container and add these property types to this
|
|
instance of DynamicProperty.
|
|
*/
|
|
void addDynamicProperties(const PropertyContainer*);
|
|
/// Get the name of a property
|
|
const char* getPropertyName(const Property* prop) const;
|
|
//@}
|
|
|
|
/** @name Property attributes */
|
|
//@{
|
|
/// Get the attributes of a property
|
|
short getPropertyType(const Property* prop) const;
|
|
/// Get the attributes of a named property
|
|
short getPropertyType(const char *name) const;
|
|
/// Get the group name of a property
|
|
const char* getPropertyGroup(const Property* prop) const;
|
|
/// Get the group name of a named property
|
|
const char* getPropertyGroup(const char *name) const;
|
|
/// Get the documentation of a property
|
|
const char* getPropertyDocumentation(const Property* prop) const;
|
|
/// Get the documentation of a named property
|
|
const char* getPropertyDocumentation(const char *name) const;
|
|
//@}
|
|
|
|
/** @name Property serialization */
|
|
//@{
|
|
void Save (Base::Writer &writer) const;
|
|
void Restore(Base::XMLReader &reader);
|
|
unsigned int getMemSize (void) const;
|
|
//@}
|
|
|
|
private:
|
|
/// Encodes an attribute upon saving.
|
|
std::string encodeAttribute(const std::string&) const;
|
|
std::string getUniquePropertyName(const char *Name) const;
|
|
|
|
private:
|
|
struct PropData {
|
|
Property* property;
|
|
std::string group;
|
|
std::string doc;
|
|
short attr;
|
|
bool readonly;
|
|
bool hidden;
|
|
};
|
|
|
|
PropertyContainer* pc;
|
|
std::map<std::string,PropData> props;
|
|
};
|
|
|
|
} // namespace App
|
|
|
|
#endif // APP_DYNAMICPROPERTY_H
|