DocumentObject.DocumentObject Class Reference

Public Member Functions
def	addProperty (self, typ, name='', group='', doc='', attr=0, readonly=False, hidden=False)
def	Content (self)
def	Document (self)
def	execute (self)
def	getAllDerivedFrom (self)
def	getDocumentationOfProperty (self, attr)
def	getEnumerationsOfProperty (self, attr)
def	getGroupOfProperty (self, attr)
def	getProperty (self, attr)
def	getTypeOfProperty (self, attr)
def	init (self)
def	InList (self)
def	isDerivedFrom (self, obj)
def	MemSize (self)
def	Module (self)
def	Name (self)
def	onChanged (self, prop)
def	OutList (self)
def	PropertiesList (self)
def	propertyChanged (self, prop)
def	purgeTouched (self)
def	State (self)
def	supportedProperties (self)
def	touch (self)
def	Type (self)
def	ViewObject (self)
def	ViewObject (self, value)

Public Attributes
	initialised

Detailed Description

The Document object is the base class for all FreeCAD objects.

Member Function Documentation

addProperty()

def DocumentObject.DocumentObject.addProperty	(		self,
			typ,
			name = '',
			group = '',
			doc = '',
			attr = 0,
			readonly = False,
			hidden = False
	)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.addProperty().

Referenced by DocumentObject.DocumentObject.addProperty(), DocumentObject.Box.init(), and DocumentObject.DocumentObject.onChanged().

Content()

def DocumentObject.DocumentObject.Content

(

self

)

shows the contents of the properties of this object as an xml string.
This is the content that is saved when the file is saved by FreeCAD

References DocumentObject.DocumentObject.__object__.

Document()

def DocumentObject.DocumentObject.Document

(

self

)

References DocumentObject.DocumentObject.__object__.

execute()

def DocumentObject.DocumentObject.execute

(

self

)

Reimplemented in DocumentObject.Box.

Referenced by draftobjects.facebinder.Facebinder.addSubobjects(), PathScripts.PathDressupDogbone.ObjectDressup.boneStateList(), ArchSite.Compass.buildCoordinates(), PathScripts.PathDressupHoldingTags.ObjectTagDressup.generateTags(), ArchPanel.PanelCut.getWires(), ArchSchedule.CommandArchSchedule.IsActive(), Mod.PartDesign.Scripts.DistanceBolt.DistanceBolt.onChanged(), Mod.PartDesign.Scripts.Epitrochoid.Epitrochoid.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.Parallelepiped.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.BoxCylinder.onChanged(), Mod.PartDesign.Scripts.Spring.MySpring.onChanged(), FeaturePython.DistanceBolt.onChanged(), PathScripts.PathStock.StockFromBase.onChanged(), PathScripts.PathStock.StockCreateBox.onChanged(), PathScripts.PathStock.StockCreateCylinder.onChanged(), draftobjects.draftlink.DraftLink.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), and draftobjects.pathtwistedarray.PathTwistedArray.onDocumentRestored().

getAllDerivedFrom()

def DocumentObject.DocumentObject.getAllDerivedFrom

(

self

)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.getAllDerivedFrom().

Referenced by DocumentObject.DocumentObject.getAllDerivedFrom().

getDocumentationOfProperty()

def DocumentObject.DocumentObject.getDocumentationOfProperty	(		self,
			attr
	)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.getDocumentationOfProperty().

Referenced by DocumentObject.DocumentObject.getDocumentationOfProperty().

getEnumerationsOfProperty()

def DocumentObject.DocumentObject.getEnumerationsOfProperty	(		self,
			attr
	)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.getEnumerationsOfProperty().

Referenced by DocumentObject.DocumentObject.getEnumerationsOfProperty().

getGroupOfProperty()

def DocumentObject.DocumentObject.getGroupOfProperty	(		self,
			attr
	)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.getGroupOfProperty().

Referenced by DocumentObject.DocumentObject.getGroupOfProperty().

getProperty()

def DocumentObject.DocumentObject.getProperty	(		self,
			attr
	)

References DocumentObject.DocumentObject.__object__.

getTypeOfProperty()

def DocumentObject.DocumentObject.getTypeOfProperty	(		self,
			attr
	)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.getTypeOfProperty().

Referenced by DocumentObject.DocumentObject.getTypeOfProperty().

init()

void App.DocumentObject.init

(

self

)

Reimplemented in DocumentObject.Box.

Referenced by DocumentObject.DocumentObject.onChanged().

InList()

def DocumentObject.DocumentObject.InList

(

self

)

References DocumentObject.DocumentObject.__object__.

isDerivedFrom()

def DocumentObject.DocumentObject.isDerivedFrom	(		self,
			obj
	)

returns True if this object is derived from the given C++ class, for
example Part::Feature

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.isDerivedFrom().

Referenced by DocumentObject.DocumentObject.isDerivedFrom().

MemSize()

def DocumentObject.DocumentObject.MemSize

(

self

)

References DocumentObject.DocumentObject.__object__.

Module()

def DocumentObject.DocumentObject.Module

(

self

)

References DocumentObject.DocumentObject.__object__.

Name()

def DocumentObject.DocumentObject.Name

(

self

)

References DocumentObject.DocumentObject.__object__.

onChanged()

def DocumentObject.DocumentObject.onChanged	(		self,
			prop
	)

References DocumentObject.DocumentObject.__object__, App::PropertyData.addProperty(), App::DynamicProperty.addProperty(), PathTests.TestPathDressupDogbone.TestFeature.addProperty(), DocumentObject.DocumentObject.addProperty(), DocumentObject.ViewProvider.addProperty(), PathScripts.PathProperty.OpPrototype.addProperty(), PathScripts.PathSetupSheetOpPrototype.OpPrototype.addProperty(), e57::E57XmlParser.init(), SMESH_Block.init(), SMESH::Controls::BelongToGeom.init(), SMESH::Controls::LyingOnGeom.init(), Base::BaseClass.init(), Base::Type.init(), SMDS_SetIterator< M::key_type, M::const_iterator, SMDS::KeyAccessor< M::key_type, M::const_iterator > >.init(), SMDS_SetIterator< M::mapped_type, M::const_iterator, SMDS::ValueAccessor< M::mapped_type, M::const_iterator > >.init(), SMDS_SetIterator< M::mapped_type, M::const_reverse_iterator, SMDS::ValueAccessor< M::mapped_type, M::const_reverse_iterator > >.init(), SMESHDS_TSubMeshHolder< const SMESHDS_SubMesh >::Iterator.init(), SMESHDS_TSubMeshHolder< SMESH_subMesh >::Iterator.init(), SMESHDS_TSubMeshHolder< SUBMESH >::Iterator.init(), SMDS_VtkFace.init(), SMDS_VtkVolume.init(), SMDS_SetIterator< VALUE, VALUE_SET_ITERATOR, ACCESSOR, VALUE_FILTER >.init(), App::DocInfo.init(), Py::ExtensionExceptionType.init(), App::Application.init(), Base::InterpreterSingleton.init(), SMDS_MeshNode.init(), SMDS_MeshElement.init(), App::FeaturePythonImp.init(), SMESH_MAT2d::Branch.init(), SMDS_VtkEdge.init(), Base::Exception.init(), Base::Persistence.init(), SMDS_BallElement.init(), Gui::Dialog::DlgCustomizeSpNavSettings.init, Gui::Dialog::DownloadItem.init(), Gui::ExpressionCompleter.init(), QSint::ActionBox.init(), QSint::ActionLabel.init(), SIM::Coin3D::Quarter::SoQTQuarterAdaptor.init(), Gui::SoFCDB.init(), Stats.init(), Gui::View3DInventorViewer.init(), ShapeCache.init(), PartDesignGui::WorkflowManager.init(), PathGui::PathSelectionObserver.init(), Sandbox::DocumentProtector.init(), TechDrawGui::QGVPage::Private.init(), QSint::ActionGroup.init(), Gui::Dialog::DlgPropertyLink.init(), MeshGui::ViewProviderMeshCurvature.init(), Gui::SoQtOffscreenRenderer.init(), Gui::DlgObjectSelection.init(), Gui::PythonDebuggerP.init, zipios::DeflateOutputStreambuf.init(), Sketcher::SolverGeometryExtension::EdgeParameterStatus.init(), zipios::ZipFile.init(), Sketcher::SolverGeometryExtension.init(), Gui::ViewProviderPythonFeatureImp.init(), femsolver.fenics.fenics_tools.CellExpressionFromXDMF.init(), femsolver.fenics.fenics_tools.FacetFunctionFromXDMF.init(), DocumentObject.DocumentObject.init(), DocumentObject.Box.init(), Gui::SoFCInteractiveElement.init(), Gui::SoGLWidgetElement.init(), Gui::SoGLRenderActionElement.init(), Gui::SoGLVBOActivatedElement.init(), MeshGui::SoFCMeshFacetElement.init(), MeshGui::SoFCMeshObjectElement.init(), MeshGui::SoFCMeshVertexElement.init(), CDxfWrite.init(), TechDraw::PATLineSpec.init(), TechDraw::LineGroup.init(), TechDrawGui::TileImage.init(), DocumentObject.DocumentObject.initialised, DocumentObject.DocumentObject.propertyChanged(), and DocumentObject.Box.propertyChanged().

Referenced by ArchStructure.CommandStructuralSystem.Activated(), draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), draftobjects.wire.Wire.execute(), ArchBuildingPart.ViewProviderBuildingPart.updateData(), ArchPanel.ViewProviderPanelCut.updateData(), ArchPanel.ViewProviderPanelSheet.updateData(), draftviewproviders.view_label.ViewProviderLabel.updateData(), draftviewproviders.view_layer.ViewProviderLayer.updateData(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.updateData().

OutList()

def DocumentObject.DocumentObject.OutList

(

self

)

References DocumentObject.DocumentObject.__object__.

PropertiesList()

def DocumentObject.DocumentObject.PropertiesList

(

self

)

References DocumentObject.DocumentObject.__object__.

propertyChanged()

def DocumentObject.DocumentObject.propertyChanged	(		self,
			prop
	)

Reimplemented in DocumentObject.Box.

Referenced by DocumentObject.DocumentObject.onChanged().

purgeTouched()

def DocumentObject.DocumentObject.purgeTouched

(

self

)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.purgeTouched().

Referenced by DocumentObject.DocumentObject.purgeTouched().

State()

def DocumentObject.DocumentObject.State

(

self

)

References DocumentObject.DocumentObject.__object__.

supportedProperties()

def DocumentObject.DocumentObject.supportedProperties

(

self

)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.supportedProperties().

Referenced by DocumentObject.DocumentObject.supportedProperties().

touch()

def DocumentObject.DocumentObject.touch

(

self

)

References DocumentObject.DocumentObject.__object__, and DocumentObject.DocumentObject.touch().

Referenced by DocumentObject.DocumentObject.touch().

Type()

def DocumentObject.DocumentObject.Type

(

self

)

References DocumentObject.DocumentObject.__object__.

Referenced by ArchPanel.CommandPanelSheet.Activated(), ArchStructure.CommandStructuralSystem.Activated(), draftobjects.draft_annotation.DraftAnnotation.add_missing_properties_0v19(), ArchStructure.StructSelectionObserver.addSelection(), ArchSite.Compass.buildCoordinates(), ArchComponent.Component.execute(), draftobjects.layer.LayerContainer.execute(), ArchSchedule.CommandArchSchedule.IsActive(), draftobjects.layer.Layer.set_properties(), and ArchReference.ArchReference.setProperties().

ViewObject() [1/2]

def DocumentObject.DocumentObject.ViewObject

(

self

)

References DocumentObject.DocumentObject.__object__.

ViewObject() [2/2]

def DocumentObject.DocumentObject.ViewObject	(		self,
			value
	)

returns or sets the ViewObject associated with this object. Returns
None if FreeCAD is running in console mode

References DocumentObject.DocumentObject.__object__.

Member Data Documentation

initialised

DocumentObject.DocumentObject.initialised

Referenced by DocumentObject.DocumentObject.onChanged().

---

The documentation for this class was generated from the following files:

• FreeCAD/src/Mod/TemplatePyMod/DocumentObject.py
• FreeCAD/src/App/DocumentObject.cpp