Public Member Functions
def	action (self, arg)

def	Activated (self)

def	create (self)

def	finish (self, closed=False, cont=False)

def	GetResources (self)

def	numericInput (self, numx, numy, numz)

def	setmode (self, i)

def	Activated (self, name="None", noplanesetup=False)

Public Member Functions inherited from draftguitools.gui_base_original.DraftTool
def	Activated (self, name="None", noplanesetup=False, is_subtool=False)

def	commit (self, name, func)

def	finish (self, close=False)

def	getStrings (self, addrot=None)

def	IsActive (self)

Public Attributes
	call

	ghost

	labeltype

	point

	sel

Public Attributes inherited from draftguitools.gui_base_original.Creator
	support

Public Attributes inherited from draftguitools.gui_base_original.DraftTool
	call

	commitList

	constrain

	doc

	extendedCopy

	featureName

	node

	obj

	planetrack

	point

	pos

	support

	ui

	view

Detailed Description

Gui Command for the Label tool.

Member Function Documentation

◆ action()

def draftguitools.gui_labels.Label.action	(	self,
		arg
	)

Handle the 3D scene events.

This is installed as an EventCallback in the Inventor view.

Parameters
----------
arg: dict
    Dictionary with strings that indicates the type of event received
    from the 3D view.

References Base::BaseClass.create(), Gui::OpenGLBuffer.create(), Gui::OpenGLMultiBuffer.create(), Part::GeometryDefaultExtension< T >.create(), nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >.create(), Gui::ViewProviderBuilder.create(), MeshPart::BrepMesh.create(), Base::Vector2dPy.create(), nlohmann::detail::parse_error.create(), nlohmann::detail::invalid_iterator.create(), nlohmann::detail::type_error.create(), nlohmann::detail::out_of_range.create(), nlohmann::detail::other_error.create(), Path::Voronoi.create(), nlohmann::detail::iterator_input_adapter_factory< IteratorType, Enable >.create(), nlohmann::detail::iterator_input_adapter_factory< IteratorType, enable_if_t< is_iterator_of_multibyte< IteratorType >::value > >.create(), Gui::MainWindowPy.create(), Gui::MDIViewPy.create(), Gui::Dialog::AboutDialogFactory.create(), ArchWindow._ArchWindowTaskPanel.create(), draftguitools.gui_labels.Label.create(), Commands.SphereCreator.create(), Mod.PartDesign.WizardShaft.ShaftDiagram.Diagram.create(), Base::Exception.create(), Base::Persistence.create(), Gui::ManualAlignment.finish(), Gui::SoFCBoundingBox.finish(), Gui::SoFCColorBarBase.finish(), Gui::SoFCColorBar.finish(), Gui::SoFCColorGradient.finish(), Gui::SoFCColorLegend.finish(), Gui::SoFCDB.finish(), zipios::GZIPOutputStream.finish(), zipios::GZIPOutputStreambuf.finish(), zipios::ZipOutputStream.finish(), zipios::ZipOutputStreambuf.finish(), DraftGui.DraftToolBar.finish(), draftguitools.gui_base.GuiCommandBase.finish(), draftguitools.gui_subelements.SubelementHighlight.finish(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.finish(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.finish(), drafttaskpanels.task_polararray.TaskPanelPolarArray.finish(), drafttaskpanels.task_shapestring.ShapeStringTaskPanelEdit.finish(), draftviewproviders.view_text.ViewProviderText.finish(), draftguitools.gui_arcs.Arc_3Points.finish(), draftguitools.gui_base_original.DraftTool.finish(), draftguitools.gui_clone.Clone.finish(), draftguitools.gui_fillets.Fillet.finish(), draftguitools.gui_selectplane.Draft_SelectPlane.finish(), draftguitools.gui_dimensions.Dimension.finish(), draftguitools.gui_edit.Edit.finish(), draftguitools.gui_offset.Offset.finish(), draftguitools.gui_stretch.Stretch.finish(), draftguitools.gui_trimex.Trimex.finish(), draftguitools.gui_arcs.Arc.finish(), draftguitools.gui_beziers.BezCurve.finish(), draftguitools.gui_beziers.CubicBezCurve.finish(), draftguitools.gui_ellipses.Ellipse.finish(), draftguitools.gui_labels.Label.finish(), draftguitools.gui_lines.Line.finish(), draftguitools.gui_mirror.Mirror.finish(), draftguitools.gui_move.Move.finish(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_rectangles.Rectangle.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_scale.Scale.finish(), draftguitools.gui_splines.BSpline.finish(), draftguitools.gui_texts.Text.finish(), draftguitools.gui_points.Point.finish(), draftguitools.gui_shapestrings.ShapeString.finish(), Gui::SoFCBackgroundGradient.finish(), Gui::SoSkipBoundingGroup.finish(), Gui::SoFCSelection.finish(), Gui::SoFCHighlightAction.finish(), Gui::SoFCSelectionAction.finish(), Gui::SoFCEnableSelectionAction.finish(), Gui::SoFCEnableHighlightAction.finish(), Gui::SoFCSelectionColorAction.finish(), Gui::SoFCHighlightColorAction.finish(), Gui::SoFCDocumentAction.finish(), Gui::SoFCDocumentObjectAction.finish(), Gui::SoUpdateVBOAction.finish(), Gui::SoFCUnifiedSelection.finish(), Gui::SoFCPathAnnotation.finish(), Gui::SoFCSeparator.finish(), Gui::SoFCSelectionRoot.finish(), ifc4.ifcworktime.finish, draftguitools.gui_drawing.Drawing.ghost, draftguitools.gui_edit.Edit.ghost, draftguitools.gui_labels.Label.ghost, draftguitools.gui_mirror.Mirror.ghost, draftguitools.gui_offset.Offset.ghost, draftguitools.gui_trimex.Trimex.ghost, uvPtStruct.node, StdMeshers_Quadrangle_2D::ForcedPoint.node, Gui::AxisOrigin.node, Gui::Dialog::Clipping::Private.node, draftguitools.gui_arcs.Arc.node, draftguitools.gui_base_original.DraftTool.node, draftguitools.gui_beziers.CubicBezCurve.node, draftguitools.gui_dimensions.Dimension.node, draftguitools.gui_edit.Edit.node, draftguitools.gui_lines.Line.node, draftguitools.gui_mirror.Mirror.node, draftguitools.gui_move.Move.node, draftguitools.gui_polygons.Polygon.node, draftguitools.gui_rotate.Rotate.node, draftguitools.gui_scale.Scale.node, draftguitools.gui_stretch.Stretch.node, drafttaskpanels.task_shapestring.ShapeStringTaskPanel.node, draftviewproviders.view_dimension.ViewProviderLinearDimension.node, draftviewproviders.view_dimension.ViewProviderAngularDimension.node, GRIDElement.node, Commands.TemplatePyMod_Cmd2.node, draftguitools.gui_base.GuiCommandBase.planetrack, draftguitools.gui_base_original.DraftTool.planetrack, FaceQuadStruct::Side::Contact.point, Gui::DAG::VertexProperty.point, Gui::PickedPoint.point, draftguitools.gui_arcs.Arc.point, draftguitools.gui_base_original.DraftTool.point, draftguitools.gui_circulararray.CircularArray.point, draftguitools.gui_dimensions.Dimension.point, draftguitools.gui_ellipses.Ellipse.point, draftguitools.gui_labels.Label.point, draftguitools.gui_lines.Line.point, draftguitools.gui_mirror.Mirror.point, draftguitools.gui_move.Move.point, draftguitools.gui_orthoarray.OrthoArray.point, draftguitools.gui_points.Point.point, draftguitools.gui_polararray.PolarArray.point, draftguitools.gui_polygons.Polygon.point, draftguitools.gui_rectangles.Rectangle.point, draftguitools.gui_rotate.Rotate.point, draftguitools.gui_scale.Scale.point, draftguitools.gui_texts.Text.point, drafttaskpanels.task_shapestring.ShapeStringTaskPanel.point, MeshGui::SoFCMeshFaceSet.point, MeshGui::SoFCMeshNode.point, MeshGui::SoFCMeshVertex.point, MeshPartGui::CurveOnMeshHandler::Private::PickedPoint.point, PathScripts.PathDressupTagGui.HoldingTagMarker.point, PathScripts.PathGetPoint.TaskPanel.point, TechDraw::Vertex.point(), TechDrawGui::dimVertex.point, Gui::Dialog::Clipping::Private.ui, Gui::Dialog::DemoMode.ui, Gui::Dialog::DlgCustomActionsImp.ui, Gui::Dialog::IconDialog.ui, Gui::Dialog::DlgActivateWindowImp.ui, Gui::Dialog::DlgAddProperty.ui, Gui::Dialog::DlgCheckableMessageBoxPrivate.ui, Gui::Dialog::DlgCustomCommandsImp.ui, Gui::Dialog::DlgCreateNewPreferencePackImp.ui, Gui::Dialog::DlgCustomizeSpNavSettings.ui, Gui::Dialog::DlgDisplayPropertiesImp::Private.ui, Gui::Dialog::DlgSettingsEditorImp.ui, Gui::Dialog::DlgExpressionInput.ui, Gui::Dialog::DlgGeneralImp.ui, Gui::Dialog::DlgInputDialogImp.ui, Gui::Dialog::DlgCustomKeyboardImp.ui, Gui::Dialog::DlgMacroExecuteImp.ui, Gui::Dialog::DlgMacroRecordImp.ui, Gui::Dialog::DlgMaterialPropertiesImp.ui, Gui::DlgObjectSelection.ui, Gui::Dialog::DlgOnlineHelpImp.ui, Gui::Dialog::DlgParameterFind.ui, Gui::Dialog::DlgParameterImp.ui, Gui::Dialog::DlgPreferencePackManagementImp.ui, Gui::Dialog::DlgPreferencesImp.ui, Gui::Dialog::DlgProjectInformationImp.ui, Gui::Dialog::DlgProjectUtility.ui, Gui::Dialog::DlgPropertyLink.ui, Gui::Dialog::DlgReportViewImp.ui, Gui::Dialog::DlgRevertToBackupConfigImp.ui, Gui::Dialog::DlgRunExternal.ui, Gui::Dialog::DlgSettings3DViewImp.ui, Gui::Dialog::DlgSettingsCacheDirectory.ui, Gui::Dialog::DlgSettingsColorGradientImp.ui, Gui::Dialog::DlgSettingsDocumentImp.ui, Gui::Dialog::DlgSettingsImageImp.ui, Gui::Dialog::DlgSettingsLazyLoadedImp.ui, Gui::Dialog::DlgSettingsMacroImp.ui, Gui::Dialog::DlgSettingsNavigation.ui, Gui::Dialog::DlgSettingsPythonConsole.ui, Gui::Dialog::DlgSettingsSelection.ui, Gui::Dialog::DlgSettingsUnitsImp.ui, Gui::Dialog::DlgSettingsViewColor.ui, Gui::Dialog::DlgCustomToolbars.ui, Gui::Dialog::DlgUnitsCalculator.ui, Gui::Dialog::DlgWorkbenchesImp.ui, Gui::Dialog::DocumentRecoveryPrivate.ui, Gui::Dialog::DownloadManager.ui, Gui::LocationDialogImp< Ui >.ui, Gui::LocationImpUi< Ui >.ui, Gui::LocationDialogUiImp.ui, Gui::Dialog::Placement.ui, Gui::Dialog::DlgInspector.ui, Gui::Dialog::AboutDialog.ui, Gui::TaskBoxPosition.ui, Gui::TaskBoxAngle.ui, Gui::ElementColors::Private.ui, Gui::TaskView::TaskAppearance.ui, Gui::TaskView::TaskSelectLinkProperty.ui, Gui::Dialog::TextureMapping.ui, Gui::Dialog::Transform.ui, Gui::VectorListEditor.ui, Gui::CheckListDialog.ui, change_branch.ChangeBranchDialog.ui, package_details.PackageDetails.ui, package_list.PackageList.ui, package_list.CompactView.ui, package_list.ExpandedView.ui, draftguitools.gui_base_original.DraftTool.ui, draftguitools.gui_circulararray.CircularArray.ui, draftguitools.gui_edit.Edit.ui, draftguitools.gui_groups.AddToGroup.ui, draftguitools.gui_groups.SetAutoGroup.ui, draftguitools.gui_orthoarray.OrthoArray.ui, draftguitools.gui_polararray.PolarArray.ui, draftguitools.gui_snapper.Snapper.ui, DrawingGui::TaskOrthoViews.ui, FemGui::DlgSettingsFemCcxImp.ui, FemGui::DlgSettingsFemElmerImp.ui, FemGui::DlgSettingsFemExportAbaqusImp.ui, FemGui::DlgSettingsFemGeneralImp.ui, FemGui::DlgSettingsFemGmshImp.ui, FemGui::DlgSettingsFemInOutVtkImp.ui, FemGui::DlgSettingsFemMaterialImp.ui, FemGui::DlgSettingsFemMystranImp.ui, FemGui::DlgSettingsFemZ88Imp.ui, FemGui::TaskAnalysisInfo.ui, FemGui::TaskCreateNodeSet.ui, FemGui::TaskDriver.ui, FemGui::TaskFemConstraintBearing.ui, FemGui::TaskFemConstraintContact.ui, FemGui::TaskFemConstraintDisplacement.ui, FemGui::TaskFemConstraintFixed.ui, FemGui::TaskFemConstraintFluidBoundary.ui, FemGui::TaskFemConstraintForce.ui, FemGui::TaskFemConstraintHeatflux.ui, FemGui::TaskFemConstraintInitialTemperature.ui, FemGui::TaskFemConstraintPlaneRotation.ui, FemGui::TaskFemConstraintPressure.ui, FemGui::TaskFemConstraintSpring.ui, FemGui::TaskFemConstraintTemperature.ui, FemGui::TaskFemConstraintTransform.ui, FemGui::TaskObjectName.ui, FemGui::TaskPostDisplay.ui, FemGui::TaskPostClip.ui, FemGui::TaskPostDataAlongLine.ui, FemGui::TaskPostDataAtPoint.ui, FemGui::TaskPostScalarClip.ui, FemGui::TaskPostWarpVector.ui, FemGui::TaskPostCut.ui, FemGui::TaskTetParameter.ui, FemGui::PlaneWidget.ui, FemGui::SphereWidget.ui, ImageGui::ImageOrientationDialog.ui, InspectionGui::VisualInspection.ui, MeshGui::DlgDecimating.ui, MeshGui::DlgEvaluateMeshImp::Private.ui, MeshGui::DlgEvaluateSettings.ui, MeshGui::DlgRegularSolidImp.ui, MeshGui::DlgSettingsImportExport.ui, MeshGui::DlgSettingsMeshView.ui, MeshGui::DlgSmoothing.ui, MeshGui::GmshWidget::Private.ui, MeshGui::RemoveComponents.ui, MeshGui::Segmentation.ui, MeshGui::SegmentationBestFit.ui, MeshGui::Selection.ui, MeshPartGui::CrossSections.ui, MeshPartGui::CurveOnMeshWidget.ui, MeshPartGui::Tessellation.ui, PartGui::CrossSections.ui, PartGui::DlgBooleanOperation.ui, PartGui::DlgExtrusion.ui, PartGui::DlgFilletEdges.ui, PartGui::DlgPartImportIgesImp.ui, PartGui::DlgPartImportStepImp.ui, PartGui::DlgPrimitives.ui, PartGui::Location.ui, PartGui::DlgProjectionOnSurface.ui, PartGui::DlgRevolution.ui, PartGui::DlgSettings3DViewPart.ui, PartGui::DlgSettingsGeneral.ui, PartGui::DlgImportExportIges.ui, PartGui::DlgImportExportStep.ui, PartGui::DlgSettingsObjectColor.ui, PartGui::Mirroring.ui, PartGui::SectionCut.ui, PartGui::ShapeFromMesh.ui, PartGui::TaskAttacher.ui, PartGui::FaceColors::Private.ui, PartGui::LoftWidget::Private.ui, PartGui::OffsetWidget::Private.ui, PartGui::ShapeBuilderWidget::Private.ui, PartGui::SweepWidget::Private.ui, PartGui::ThicknessWidget::Private.ui, Mod.PartDesign.FeatureHole.TaskHole.TaskHole.ui, PartDesignGui::DlgActiveBody.ui, PartDesignGui::TaskBooleanParameters.ui, PartDesignGui::TaskChamferParameters.ui, PartDesignGui::TaskDraftParameters.ui, PartDesignGui::TaskExtrudeParameters.ui, PartDesignGui::TaskFeaturePick.ui, PartDesignGui::TaskFilletParameters.ui, PartDesignGui::TaskHelixParameters.ui, PartDesignGui::TaskHoleParameters.ui, PartDesignGui::TaskLinearPatternParameters.ui, PartDesignGui::TaskLoftParameters.ui, PartDesignGui::TaskMirroredParameters.ui, PartDesignGui::TaskMultiTransformParameters.ui, PartDesignGui::TaskPipeParameters.ui, PartDesignGui::TaskPipeOrientation.ui, PartDesignGui::TaskPipeScaling.ui, PartDesignGui::TaskPolarPatternParameters.ui, PartDesignGui::TaskBoxPrimitives.ui, PartDesignGui::TaskRevolutionParameters.ui, PartDesignGui::TaskScaledParameters.ui, PartDesignGui::TaskShapeBinder.ui, PartDesignGui::TaskThicknessParameters.ui, PartDesignGui::TaskTransformedMessages.ui, PathGui::DlgProcessorChooser.ui, PathGui::DlgSettingsPathColor.ui, PathGui::TaskWidgetPathCompound.ui, PointsGui::DlgPointsReadImp.ui, RaytracingGui::DlgSettingsRayImp.ui, ReenGui::FitBSplineSurfaceWidget::Private.ui, ReenGui::PoissonWidget::Private.ui, ReverseEngineeringGui::Segmentation.ui, ReverseEngineeringGui::SegmentationManual.ui, RobotGui::TaskEdge2TracParameter.ui, RobotGui::TaskRobot6Axis.ui, RobotGui::TaskRobotControl.ui, RobotGui::TaskRobotMessages.ui, RobotGui::TaskTrajectory.ui, RobotGui::TaskTrajectoryDressUpParameter.ui, RobotGui::TrajectorySimulate.ui, SketcherGui::ConstraintMultiFilterDialog.ui, SketcherGui::ConstraintSettingsDialog.ui, SketcherGui::SketcherRegularPolygonDialog.ui, SketcherGui::SketcherSettings.ui, SketcherGui::SketcherSettingsDisplay.ui, SketcherGui::SketcherSettingsColors.ui, SketcherGui::SketchMirrorDialog.ui, SketcherGui::SketchOrientationDialog.ui, SketcherGui::SketchRectangularArrayDialog.ui, SketcherGui::TaskSketcherConstraints.ui, SketcherGui::TaskSketcherElements.ui, SketcherGui::SketcherGeneralWidget.ui, SketcherGui::TaskSketcherMessages.ui, SketcherGui::TaskSketcherSolverAdvanced.ui, SketcherGui::SketcherValidation.ui, SpreadsheetGui::DlgBindSheet.ui, SpreadsheetGui::DlgSettingsImp.ui, SpreadsheetGui::DlgSheetConf.ui, SpreadsheetGui::PropertiesDialog.ui, SpreadsheetGui::SheetView.ui, StartGui::DlgStartPreferencesImp.ui, SurfaceGui::FillingPanel.ui, SurfaceGui::FillingEdgePanel.ui, SurfaceGui::FillingVertexPanel.ui, SurfaceGui::GeomFillSurface.ui, SurfaceGui::SectionsPanel.ui, TechDrawGui::DlgPageChooser.ui, TechDrawGui::DlgPrefsTechDrawAdvancedImp.ui, TechDrawGui::DlgPrefsTechDrawAnnotationImp.ui, TechDrawGui::DlgPrefsTechDrawColorsImp.ui, TechDrawGui::DlgPrefsTechDrawDimensionsImp.ui, TechDrawGui::DlgPrefsTechDrawGeneralImp.ui, TechDrawGui::DlgPrefsTechDrawHLRImp.ui, TechDrawGui::DlgPrefsTechDrawScaleImp.ui, TechDrawGui::DlgTemplateField.ui, TechDrawGui::SymbolChooser.ui, TechDrawGui::TaskActiveView.ui, TechDrawGui::TaskAlignViews.ui, TechDrawGui::TaskBalloon.ui, TechDrawGui::TaskCenterLine.ui, TechDrawGui::TaskCosmeticLine.ui, TechDrawGui::TaskCosVertex.ui, TechDrawGui::TaskCustomizeFormat.ui, TechDrawGui::TaskDetail.ui, TechDrawGui::TaskDimension.ui, TechDrawGui::TaskGeomHatch.ui, TechDrawGui::TaskHatch.ui, TechDrawGui::TaskLeaderLine.ui, TechDrawGui::TaskLineDecor.ui, TechDrawGui::TaskRestoreLines.ui, TechDrawGui::TaskLinkDim.ui, TechDrawGui::TaskProjection.ui, TechDrawGui::TaskProjGroup.ui, TechDrawGui::TaskRichAnno.ui, TechDrawGui::TaskSectionView.ui, TechDrawGui::TaskSelectLineAttributes.ui, TechDrawGui::TaskWeldingSymbol.ui, TechDrawTools.CommandMoveView.CommandMoveView.ui, TechDrawTools.CommandShareView.CommandShareView.ui, TaskPanel.TaskPanel.ui, and TestGui::UnitTestDialog.ui.

◆ Activated()

def draftguitools.gui_labels.Label.Activated ( self )

Execute when the command is called.

Reimplemented from draftguitools.gui_base_original.Creator.

References draftguitools.gui_labels.Label.Activated().

◆ create()

def draftguitools.gui_labels.Label.create ( self )

Create the actual object.

Referenced by draftguitools.gui_labels.Label.action().

◆ finish()

def draftguitools.gui_labels.Label.finish	(	self,
		closed = `False`,
		cont = `False`
	)

Finish the command.

Reimplemented from draftguitools.gui_base_original.DraftTool.

References draftguitools.gui_labels.Label.finish(), draftguitools.gui_drawing.Drawing.ghost, draftguitools.gui_edit.Edit.ghost, draftguitools.gui_labels.Label.ghost, draftguitools.gui_mirror.Mirror.ghost, draftguitools.gui_offset.Offset.ghost, and draftguitools.gui_trimex.Trimex.ghost.

◆ GetResources()

def draftguitools.gui_labels.Label.GetResources ( self )

Set icon, menu and tooltip.

References draftutils.translate.QT_TRANSLATE_NOOP.

◆ numericInput()

def draftguitools.gui_labels.Label.numericInput	(	self,
		numx,
		numy,
		numz
	)

Validate the entry fields in the user interface.

This function is called by the toolbar or taskpanel interface
when valid x, y, and z have been entered in the input fields.

Referenced by draftguitools.gui_scale.Scale.handle_mouse_click_event().

◆ setmode()

def draftguitools.gui_labels.Label.setmode	(	self,
		i
	)

Set the type of label, if it is associated to an object.

References draftobjects.label.get_label_types(), and draftguitools.gui_labels.Label.labeltype.

Member Data Documentation

◆ call

draftguitools.gui_labels.Label.call

◆ ghost

draftguitools.gui_labels.Label.ghost

◆ labeltype

draftguitools.gui_labels.Label.labeltype

Referenced by draftguitools.gui_labels.Label.create(), and draftguitools.gui_labels.Label.setmode().

◆ point

draftguitools.gui_labels.Label.point

◆ sel

draftguitools.gui_labels.Label.sel

Referenced by draftguitools.gui_offset.Offset.action(), draftguitools.gui_labels.Label.create(), draftguitools.gui_mirror.Mirror.mirror(), and draftguitools.gui_offset.Offset.numericRadius().

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

FreeCAD/src/Mod/Draft/draftguitools/gui_labels.py

Public Member Functions

Public Attributes