draftobjects.label.Label Class Reference

Public Member Functions
def	execute (self, obj)
def	onChanged (self, obj, prop)
def	onDocumentRestored (self, obj)
def	set_label_properties (self, obj)
def	set_leader_properties (self, obj)
def	set_properties (self, obj)
def	set_target_properties (self, obj)
def	show_and_hide (self, obj, prop)
Public Member Functions inherited from draftobjects.draft_annotation.DraftAnnotation
def	add_missing_properties_0v19 (self, obj, vobj)
def	execute (self, obj)
def	onChanged (self, obj, prop)
def	onDocumentRestored (self, obj)

Additional Inherited Members
Public Attributes inherited from draftobjects.draft_annotation.DraftAnnotation
	Type

Detailed Description

The Draft Label object.

Member Function Documentation

execute()

def draftobjects.label.Label.execute	(		self,
			obj
	)

Execute when the object is created or recomputed.

Reimplemented from draftobjects.draft_annotation.DraftAnnotation.

References draftobjects.label.return_info().

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().

onChanged()

def draftobjects.label.Label.onChanged	(		self,
			obj,
			prop
	)

Execute when a property is changed.

Reimplemented from draftobjects.draft_annotation.DraftAnnotation.

References draftobjects.label.Label.onChanged(), draftobjects.array.Array.show_and_hide(), draftobjects.label.Label.show_and_hide(), and draftobjects.patharray.PathArray.show_and_hide().

Referenced by ArchStructure.CommandStructuralSystem.Activated(), draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), draftobjects.wire.Wire.execute(), draftobjects.label.Label.onChanged(), 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().

onDocumentRestored()

def draftobjects.label.Label.onDocumentRestored	(		self,
			obj
	)

Execute code when the document is restored.

It calls the parent class to add missing annotation properties.

Reimplemented from draftobjects.draft_annotation.DraftAnnotation.

References draftobjects.label.Label.onDocumentRestored().

Referenced by draftobjects.label.Label.onDocumentRestored().

set_label_properties()

def draftobjects.label.Label.set_label_properties	(		self,
			obj
	)

Set label properties only if they don't exist.

References draftobjects.label.get_label_types(), and draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by draftobjects.label.Label.set_properties().

set_leader_properties()

def draftobjects.label.Label.set_leader_properties	(		self,
			obj
	)

Set leader properties only if they don't exist.

References draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by draftobjects.label.Label.set_properties().

set_properties()

def draftobjects.label.Label.set_properties	(		self,
			obj
	)

Set properties only if they don't exist.

References draftobjects.label.Label.set_label_properties(), draftobjects.label.Label.set_leader_properties(), and draftobjects.label.Label.set_target_properties().

Referenced by draftobjects.array.Array.attach(), draftobjects.patharray.PathArray.attach(), draftobjects.pathtwistedarray.PathTwistedArray.attach(), draftobjects.pointarray.PointArray.attach(), draftobjects.layer.Layer.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), draftobjects.pathtwistedarray.PathTwistedArray.onDocumentRestored(), and draftobjects.pointarray.PointArray.onDocumentRestored().

set_target_properties()

def draftobjects.label.Label.set_target_properties	(		self,
			obj
	)

Set position properties only if they don't exist.

References draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by draftobjects.label.Label.set_properties().

show_and_hide()

def draftobjects.label.Label.show_and_hide	(		self,
			obj,
			prop
	)

Show and hide the properties depending on the touched property.

Referenced by draftobjects.array.Array.onChanged(), draftobjects.label.Label.onChanged(), and draftobjects.patharray.PathArray.onChanged().

---

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

• FreeCAD/src/Mod/Draft/draftobjects/label.py