FreeCAD C++
Public Member Functions | Protected Member Functions | List of all members
App::PropertyContainer Class Reference

#include <App/PropertyContainer.h>

Detailed Description

Base class of all classes with properties

Public Member Functions

 PropertyContainer ()
 
virtual ~PropertyContainer ()
 
virtual PropertygetPropertyByName (const char *name) const
 find a property by its name
 
virtual const char * getPropertyName (const Property *prop) const
 get the name of a property
 
virtual void getPropertyMap (std::map< std::string, Property * > &Map) const
 get all properties of the class (including properties of the parent)
 
virtual void getPropertyList (std::vector< Property * > &List) const
 get all properties of the class (including properties of the parent)
 
void setPropertyStatus (unsigned char bit, bool value)
 set the Status bit of all properties at once
 
virtual short getPropertyType (const Property *prop) const
 get the Type of a Property
 
virtual short getPropertyType (const char *name) const
 get the Type of a named Property
 
virtual const char * getPropertyGroup (const Property *prop) const
 get the Group of a Property
 
virtual const char * getPropertyGroup (const char *name) const
 get the Group of a named Property
 
virtual const char * getPropertyDocumentation (const Property *prop) const
 get the Group of a Property
 
virtual const char * getPropertyDocumentation (const char *name) const
 get the Group of a named Property
 
bool isReadOnly (const Property *prop) const
 check if the property is read-only
 
bool isReadOnly (const char *name) const
 check if the named property is read-only
 
bool isHidden (const Property *prop) const
 check if the property is hidden
 
bool isHidden (const char *name) const
 check if the named property is hidden
 
- Public Member Functions inherited from Base::Persistence
virtual void SaveDocFile (Writer &) const
 
virtual void RestoreDocFile (Reader &)
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction.
 
virtual ~BaseClass ()
 Destruction.
 

Protected Member Functions

virtual void onChanged (const Property *)
 get called by the container when a property has changed
 
virtual void onBeforeChange (const Property *)
 get called before the value is changed
 

Additional Inherited Members

- Static Public Member Functions inherited from Base::Persistence
static std::string encodeAttribute (const std::string &)
 Encodes an attribute upon saving.
 

Constructor & Destructor Documentation

◆ PropertyContainer()

App::PropertyContainer::PropertyContainer ( )

A constructor. A more elaborate description of the constructor.

◆ ~PropertyContainer()

virtual App::PropertyContainer::~PropertyContainer ( )
virtual

A destructor. A more elaborate description of the destructor.