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

#include <App/PropertyPythonObject.h>

Detailed Description

PropertyPythonObject is used to manage Py::Object instances as properties.

Author
Werner Mayer

Public Member Functions

virtual void Save (Base::Writer &writer) const
 
virtual void Restore (Base::XMLReader &reader)
 
- Public Member Functions inherited from App::Property
const char * getName (void) const
 get the name of this property in the belonging container
 
virtual const char * getEditorName (void) const
 Get the class name of the associated property editor item.
 
short getType (void) const
 Get the type of the property in the container.
 
const char * getGroup (void) const
 Get the group of this property.
 
const char * getDocumentation (void) const
 Get the documentation of this property.
 
void setContainer (PropertyContainer *Father)
 Is called by the framework to set the father (container)
 
PropertyContainergetContainer (void) const
 Get a pointer to the PropertyContainer derived class the property belongs to.
 
virtual void setPathValue (const App::ObjectIdentifier &path, const boost::any &value)
 Set value of property.
 
virtual const boost::any getPathValue (const App::ObjectIdentifier &path) const
 Get value of property.
 
virtual const App::ObjectIdentifier canonicalPath (const App::ObjectIdentifier &p) const
 Convert p to a canonical representation of it.
 
virtual void getPaths (std::vector< App::ObjectIdentifier > &paths) const
 Get valid paths for this property; used by auto completer.
 
void touch ()
 Set the property touched. More...
 
bool isTouched (void) const
 Test if this property is touched.
 
void purgeTouched (void)
 Reset this property touched.
 
unsigned long getStatus () const
 return the status bits
 
void setReadOnly (bool readOnly)
 Sets property editable/grayed out in property editor.
 
void setSinglePrecision (bool single)
 
bool isSinglePrecision () const
 Gets precision of properties using floating point numbers.
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction.
 
virtual ~BaseClass ()
 Destruction.
 

Additional Inherited Members

- Static Public Member Functions inherited from Base::Persistence
static std::string encodeAttribute (const std::string &)
 Encodes an attribute upon saving.
 
- Protected Member Functions inherited from App::Property
void hasSetValue (void)
 Gets called by all setValue() methods after the value has changed.
 
void aboutToSetValue (void)
 Gets called by all setValue() methods before the value has changed.
 
virtual void verifyPath (const App::ObjectIdentifier &p) const
 Verify a path for the current property.
 
- Protected Attributes inherited from App::Property
std::bitset< 32 > StatusBits
 

Member Function Documentation

◆ Restore()

virtual void App::PropertyPythonObject::Restore ( Base::XMLReader reader)
virtual

Use Python's pickle module to restore the object

Implements Base::Persistence.

◆ Save()

virtual void App::PropertyPythonObject::Save ( Base::Writer writer) const
virtual

Use Python's pickle module to save the object

Implements Base::Persistence.