draftviewproviders.view_draftlink.ViewProviderDraftLink Class Reference

Public Member Functions

def claimChildren (self)
 
def getIcon (self)
 
- Public Member Functions inherited from draftviewproviders.view_base.ViewProviderDraft
def attach (self, vobj)
 
def execute (self, vobj)
 
def getDefaultDisplayMode (self)
 
def getDisplayModes (self, vobj)
 
def onChanged (self, vobj, prop)
 
def setDisplayMode (self, mode)
 
def setEdit (self, vobj, mode=0)
 
def unsetEdit (self, vobj, mode=0)
 
def updateData (self, obj, prop)
 

Additional Inherited Members

- Public Attributes inherited from draftviewproviders.view_base.ViewProviderDraft
 Object
 
 texcoords
 
 texture
 

Detailed Description

 A view provider for link type object.

Member Function Documentation

◆ claimChildren()

def draftviewproviders.view_draftlink.ViewProviderDraftLink.claimChildren (   self)
Return objects that will be placed under it in the tree view.

Override this method to return a list with objects
that will appear under this object in the tree view.
That is, this object becomes the `parent`,
and all those under it are the `children`.

By default the returned list is composed of objects from
`Object.Base`, `Object.Objects`, `Object.Components`,
and `Object.Group`, if they exist.

Returns
-------
list
    List of objects.

Reimplemented from draftviewproviders.view_base.ViewProviderDraft.

References Base::XMLReader::FileEntry.Object, Base::Writer::FileEntry.Object, Py::Object.Object(), Gui::SelectionChanges.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, ArchComponent.ViewProviderComponent.Object, ArchEquipment._ViewProviderEquipment.Object, ArchFloor._Floor.Object, ArchFloor._ViewProviderFloor.Object, ArchMaterial._ViewProviderArchMaterialContainer.Object, ArchMaterial._ViewProviderArchMaterial.Object, ArchReference.ViewProviderArchReference.Object, ArchRoof._ViewProviderRoof.Object, ArchSchedule._ViewProviderArchSchedule.Object, ArchSectionPlane._ViewProviderSectionPlane.Object, ArchSite._ViewProviderSite.Object, ArchSpace._ViewProviderSpace.Object, ArchStructure.StructureTaskPanel.Object, ArchWall._ViewProviderWall.Object, draftobjects.layer.Layer.Object, draftviewproviders.view_base.ViewProviderDraft.Object, draftviewproviders.view_dimension.ViewProviderDimensionBase.Object, draftviewproviders.view_dimension.ViewProviderLinearDimension.Object, draftviewproviders.view_dimension.ViewProviderAngularDimension.Object, draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.Object, draftviewproviders.view_label.ViewProviderLabel.Object, draftviewproviders.view_layer.ViewProviderLayer.Object, draftviewproviders.view_layer.ViewProviderLayerContainer.Object, draftviewproviders.view_text.ViewProviderText.Object, draftviewproviders.view_wire.ViewProviderWire.Object, draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.Object, femviewprovider.view_base_femconstraint.VPBaseFemConstraint.Object, femviewprovider.view_base_femobject.VPBaseFemObject.Object, femviewprovider.view_mesh_gmsh.VPMeshGmsh.Object, OpenSCADFeatures.ViewProviderTree.Object, BOPTools.JoinFeatures.ViewProviderConnect.Object, BOPTools.JoinFeatures.ViewProviderEmbed.Object, BOPTools.JoinFeatures.ViewProviderCutout.Object, BOPTools.SplitFeatures.ViewProviderBooleanFragments.Object, BOPTools.SplitFeatures.ViewProviderSlice.Object, BOPTools.SplitFeatures.ViewProviderXOR.Object, CompoundTools.CompoundFilter._ViewProviderCompoundFilter.Object, JoinFeatures._ViewProviderPartJoinFeature.Object, Mod.PartDesign.FeatureHole.ViewProviderHole.ViewProviderHole.Object, Mod.PartDesign.InvoluteGearFeature._ViewProviderInvoluteGear.Object, Mod.PartDesign.SprocketFeature.ViewProviderSprocket.Object, PathScripts.PathArray.ViewProviderArray.Object, PathScripts.PathCollision._ViewProviderCollisionSim.Object, PathScripts.PathCopy.ViewProviderPathCopy.Object, PathScripts.PathDressupDragknife.ViewProviderDressup.Object, PathScripts.PathHop.ViewProviderPathHop.Object, PathScripts.PathOpGui.ViewProvider.Object, Mod.Show.Containers.Container.Object, Spreadsheet_legacy.Spreadsheet.Object, Spreadsheet_legacy.ViewProviderSpreadsheet.Object, DocumentObject.ViewProvider.Object(), and Mod.Test.Document.DocumentBasicCases.Object.

Referenced by femviewprovider.view_mesh_gmsh.VPMeshGmsh.onDelete(), femviewprovider.view_result_mechanical.VPResultMechanical.onDelete(), BOPTools.JoinFeatures.ViewProviderConnect.onDelete(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.onDelete(), BOPTools.SplitFeatures.ViewProviderSlice.onDelete(), and BOPTools.SplitFeatures.ViewProviderXOR.onDelete().

◆ getIcon()

def draftviewproviders.view_draftlink.ViewProviderDraftLink.getIcon (   self)
Return the path to the icon used by the view provider.

The path can be a full path in the system, or a relative path
inside the compiled resource file.
It can also be a string that defines the icon in XPM format.

Override this method to provide a specific icon
for the object in the tree view.

By default it returns the path to the `Draft_Draft.svg` icon.

Returns
-------
str
    `':/icons/Draft_Draft.svg'`

Reimplemented from draftviewproviders.view_base.ViewProviderDraft.

References Base::XMLReader::FileEntry.Object, Base::Writer::FileEntry.Object, Py::Object.Object(), Gui::SelectionChanges.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, ArchComponent.ViewProviderComponent.Object, ArchEquipment._ViewProviderEquipment.Object, ArchFloor._Floor.Object, ArchFloor._ViewProviderFloor.Object, ArchMaterial._ViewProviderArchMaterialContainer.Object, ArchMaterial._ViewProviderArchMaterial.Object, ArchReference.ViewProviderArchReference.Object, ArchRoof._ViewProviderRoof.Object, ArchSchedule._ViewProviderArchSchedule.Object, ArchSectionPlane._ViewProviderSectionPlane.Object, ArchSite._ViewProviderSite.Object, ArchSpace._ViewProviderSpace.Object, ArchStructure.StructureTaskPanel.Object, ArchWall._ViewProviderWall.Object, draftobjects.layer.Layer.Object, draftviewproviders.view_base.ViewProviderDraft.Object, draftviewproviders.view_dimension.ViewProviderDimensionBase.Object, draftviewproviders.view_dimension.ViewProviderLinearDimension.Object, draftviewproviders.view_dimension.ViewProviderAngularDimension.Object, draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.Object, draftviewproviders.view_label.ViewProviderLabel.Object, draftviewproviders.view_layer.ViewProviderLayer.Object, draftviewproviders.view_layer.ViewProviderLayerContainer.Object, draftviewproviders.view_text.ViewProviderText.Object, draftviewproviders.view_wire.ViewProviderWire.Object, draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.Object, femviewprovider.view_base_femconstraint.VPBaseFemConstraint.Object, femviewprovider.view_base_femobject.VPBaseFemObject.Object, femviewprovider.view_mesh_gmsh.VPMeshGmsh.Object, OpenSCADFeatures.ViewProviderTree.Object, BOPTools.JoinFeatures.ViewProviderConnect.Object, BOPTools.JoinFeatures.ViewProviderEmbed.Object, BOPTools.JoinFeatures.ViewProviderCutout.Object, BOPTools.SplitFeatures.ViewProviderBooleanFragments.Object, BOPTools.SplitFeatures.ViewProviderSlice.Object, BOPTools.SplitFeatures.ViewProviderXOR.Object, CompoundTools.CompoundFilter._ViewProviderCompoundFilter.Object, JoinFeatures._ViewProviderPartJoinFeature.Object, Mod.PartDesign.FeatureHole.ViewProviderHole.ViewProviderHole.Object, Mod.PartDesign.InvoluteGearFeature._ViewProviderInvoluteGear.Object, Mod.PartDesign.SprocketFeature.ViewProviderSprocket.Object, PathScripts.PathArray.ViewProviderArray.Object, PathScripts.PathCollision._ViewProviderCollisionSim.Object, PathScripts.PathCopy.ViewProviderPathCopy.Object, PathScripts.PathDressupDragknife.ViewProviderDressup.Object, PathScripts.PathHop.ViewProviderPathHop.Object, PathScripts.PathOpGui.ViewProvider.Object, Mod.Show.Containers.Container.Object, Spreadsheet_legacy.Spreadsheet.Object, Spreadsheet_legacy.ViewProviderSpreadsheet.Object, DocumentObject.ViewProvider.Object(), and Mod.Test.Document.DocumentBasicCases.Object.

Referenced by ArchAxis.AxisSystemTaskPanel.update(), ArchComponent.ComponentTaskPanel.update(), and ArchSectionPlane.SectionPlaneTaskPanel.update().


The documentation for this class was generated from the following file:
  • Sources/FreeCAD/src/Mod/Draft/draftviewproviders/view_draftlink.py