draftguitools.gui_groups.AddToGroup Class Reference

Public Member Functions

def Activated (self)
 
def GetResources (self)
 
def proceed (self, labelname)
 
- Public Member Functions inherited from draftguitools.gui_base.GuiCommandNeedsSelection
def IsActive (self)
 

Public Attributes

 groups
 
 labels
 
 ui
 
 ungroup
 
- Public Attributes inherited from draftguitools.gui_base.GuiCommandSimplest
 command_name
 
 doc
 

Detailed Description

GuiCommand for the Draft_AddToGroup tool.

It adds selected objects to a group, or removes them from any group.

It inherits `GuiCommandNeedsSelection` to only be available
when there is a document and a selection.
See this class for more information.

Member Function Documentation

◆ Activated()

◆ GetResources()

def draftguitools.gui_groups.AddToGroup.GetResources (   self)
Set icon, menu and tooltip.

References draftutils.translate.QT_TRANSLATE_NOOP.

◆ proceed()

def draftguitools.gui_groups.AddToGroup.proceed (   self,
  labelname 
)
Place the selected objects in the chosen group or ungroup them.

Parameters
----------
labelname: str
    The passed string with the name of the group.
    It puts the selected objects inside this group.

References App::DynamicProperty::PropData.doc, App::RelabelDocumentExpressionVisitor.doc, App::LinkBaseExtension::PropInfo.doc, Py::PythonType.doc(), ExpressionCompleterModel::Info.doc, Gui::GraphvizView.doc, ItemInfo.doc, ItemInfo2.doc, importIFClegacy.IfcEntity.doc, draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.doc, draftguitools.gui_base.GuiCommandSimplest.doc, draftguitools.gui_base.GuiCommandBase.doc, draftguitools.gui_base_original.DraftTool.doc, drafttests.test_airfoildat.DraftAirfoilDAT.doc, drafttests.test_creation.DraftCreation.doc, drafttests.test_dwg.DraftDWG.doc, drafttests.test_dxf.DraftDXF.doc, drafttests.test_modification.DraftModification.doc, drafttests.test_oca.DraftOCA.doc, drafttests.test_pivy.DraftPivy.doc, drafttests.test_svg.DraftSVG.doc, WorkingPlane.Plane.doc, Import::ImportOCAF.doc, Import::ImportXCAF.doc, Import::ImportOCAFAssembly.doc, MeshPartGui::Mesh2ShapeGmsh::Private.doc, PartGui::FaceColors::Private.doc, PartDesignGui::ComboLinks.doc, Mod.PartDesign.WizardShaft.Shaft.Shaft.doc, Mod.PartDesign.WizardShaft.WizardShaft.TaskWizardShaft.doc, PathTests.TestPathHelix.TestPathHelix.doc, PathTests.TestPathPost.PathPostTestCases.doc, PathTests.TestPathPropertyBag.TestPathPropertyBag.doc, PathTests.TestPathSetupSheet.TestPathSetupSheet.doc, PathTests.TestPathStock.TestPathStock.doc, PathTests.TestPathToolController.TestPathToolController.doc, PathTests.TestPathUtil.TestPathUtil.doc, Sandbox::CustomAddObjectEvent.doc, Sandbox::CustomRemoveObjectEvent.doc, Sandbox::CustomRecomputeEvent.doc, Sandbox::DocumentSaverThread.doc, Mod.Show.SceneDetail.SceneDetail.doc, Mod.Show.SceneDetails.Camera.Camera.doc, Mod.Show.SceneDetails.ClipPlane.ClipPlane.doc, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.doc, Mod.Show.SceneDetails.Pickability.Pickability.doc, Mod.Show.SceneDetails.VProperty.VProperty.doc, TestSpreadsheet.SpreadsheetCases.doc, Commands.TemplatePyMod_Cmd2.doc, draftguitools.gui_groups.AddToGroup.groups, draftguitools.gui_groups.SetAutoGroup.groups, MaterialEditor.MaterialEditor.groups, GetDepObjsExpressionVisitor.labels, Gui::AxisOrigin.labels, Gui::SoFCColorGradient.labels, Gui::SoFCColorLegend.labels, ArchAxis._ViewProviderAxis.labels, ArchCommands._SurveyObserver.labels, draftguitools.gui_groups.AddToGroup.labels, draftguitools.gui_groups.SetAutoGroup.labels, ChildInfo.labels, 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::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::DlgPreferencesImp.ui, Gui::Dialog::DlgProjectInformationImp.ui, Gui::Dialog::DlgProjectUtility.ui, Gui::Dialog::DlgPropertyLink.ui, Gui::Dialog::DlgReportViewImp.ui, Gui::Dialog::DlgRunExternal.ui, Gui::Dialog::DlgSettings3DViewImp.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::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, test.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, 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::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::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::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::TaskBooleanParameters.ui, PartDesignGui::TaskChamferParameters.ui, PartDesignGui::TaskDraftParameters.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::TaskPadParameters.ui, PartDesignGui::TaskPipeParameters.ui, PartDesignGui::TaskPipeOrientation.ui, PartDesignGui::TaskPipeScaling.ui, PartDesignGui::TaskPocketParameters.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, plotAxes.TaskPanel.TaskPanel.ui, plotLabels.TaskPanel.TaskPanel.ui, plotPositions.TaskPanel.TaskPanel.ui, plotSave.TaskPanel.TaskPanel.ui, plotSeries.TaskPanel.TaskPanel.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, shipAreasCurve.TaskPanel.TaskPanel.ui, shipCapacityCurve.TaskPanel.TaskPanel.ui, shipCreateShip.TaskPanel.TaskPanel.ui, shipCreateTank.TaskPanel.TaskPanel.ui, shipCreateWeight.TaskPanel.TaskPanel.ui, shipGZ.TaskPanel.TaskPanel.ui, shipHydrostatics.TaskPanel.TaskPanel.ui, shipLoadExample.TaskPanel.TaskPanel.ui, shipOutlineDraw.TaskPanel.TaskPanel.ui, SketcherGui::SketcherRegularPolygonDialog.ui, SketcherGui::SketcherSettings.ui, SketcherGui::SketcherSettingsDisplay.ui, SketcherGui::SketcherSettingsColors.ui, SketcherGui::SketchMirrorDialog.ui, SketcherGui::SketchOrientationDialog.ui, SketcherGui::SketchRectangularArrayDialog.ui, SketcherGui::TaskSketcherConstrains.ui, SketcherGui::TaskSketcherElements.ui, SketcherGui::SketcherGeneralWidget.ui, SketcherGui::TaskSketcherMessages.ui, SketcherGui::TaskSketcherSolverAdvanced.ui, SketcherGui::SketcherValidation.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::DlgPrefsTechDrawAdvancedImp.ui, TechDrawGui::DlgPrefsTechDrawAnnotationImp.ui, TechDrawGui::DlgPrefsTechDrawColorsImp.ui, TechDrawGui::DlgPrefsTechDrawDimensionsImp.ui, TechDrawGui::DlgPrefsTechDrawGeneralImp.ui, TechDrawGui::DlgPrefsTechDrawHLRImp.ui, TechDrawGui::DlgPrefsTechDrawScaleImp.ui, TechDrawGui::SymbolChooser.ui, TechDrawGui::TaskActiveView.ui, TechDrawGui::TaskBalloon.ui, TechDrawGui::TaskCenterLine.ui, TechDrawGui::TaskCosmeticLine.ui, TechDrawGui::TaskCosVertex.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::TaskProjGroup.ui, TechDrawGui::TaskRichAnno.ui, TechDrawGui::TaskSectionView.ui, TechDrawGui::TaskWeldingSymbol.ui, TaskPanel.TaskPanel.ui, TestGui::UnitTestDialog.ui, and draftguitools.gui_groups.AddToGroup.ungroup.

Referenced by draftguitools.gui_split.Split.action(), draftguitools.gui_move.Move.get_object_selection(), draftguitools.gui_rotate.Rotate.get_object_selection(), draftguitools.gui_scale.Scale.get_object_selection(), and draftguitools.gui_subelements.SubelementHighlight.get_selection().

Member Data Documentation

◆ groups

◆ labels

◆ ui

draftguitools.gui_groups.AddToGroup.ui

Referenced by draftguitools.gui_beziers.BezCurve.action(), draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_ellipses.Ellipse.action(), draftguitools.gui_labels.Label.action(), draftguitools.gui_lines.Line.action(), draftguitools.gui_mirror.Mirror.action(), draftguitools.gui_offset.Offset.action(), draftguitools.gui_rectangles.Rectangle.action(), draftguitools.gui_shapestrings.ShapeString.action(), draftguitools.gui_splines.BSpline.action(), draftguitools.gui_texts.Text.action(), draftguitools.gui_arcs.Arc.Activated(), draftguitools.gui_circulararray.CircularArray.Activated(), draftguitools.gui_clone.Clone.Activated(), draftguitools.gui_downgrade.Downgrade.Activated(), draftguitools.gui_draft2sketch.Draft2Sketch.Activated(), draftguitools.gui_ellipses.Ellipse.Activated(), draftguitools.gui_facebinders.Facebinder.Activated(), draftguitools.gui_join.Join.Activated(), draftguitools.gui_orthoarray.OrthoArray.Activated(), draftguitools.gui_polararray.PolarArray.Activated(), draftguitools.gui_polygons.Polygon.Activated(), draftguitools.gui_rectangles.Rectangle.Activated(), draftguitools.gui_rotate.Rotate.Activated(), draftguitools.gui_shape2dview.Shape2DView.Activated(), draftguitools.gui_split.Split.Activated(), draftguitools.gui_stretch.Stretch.Activated(), draftguitools.gui_styles.ApplyStyle.Activated(), draftguitools.gui_texts.Text.Activated(), draftguitools.gui_upgrade.Upgrade.Activated(), draftguitools.gui_fillets.Fillet.Activated(), draftguitools.gui_array_simple.Array.Activated(), draftguitools.gui_stretch.Stretch.addPoint(), draftguitools.gui_ellipses.Ellipse.appendPoint(), draftguitools.gui_rectangles.Rectangle.appendPoint(), DraftGui.DraftToolBar.changeEvent(), draftguitools.gui_circulararray.CircularArray.click(), draftguitools.gui_orthoarray.OrthoArray.click(), draftguitools.gui_polararray.PolarArray.click(), draftguitools.gui_dimensions.Dimension.createObject(), draftguitools.gui_polygons.Polygon.drawPolygon(), draftguitools.gui_edit.Edit.endEditing(), draftguitools.gui_base_original.DraftTool.finish(), draftguitools.gui_fillets.Fillet.finish(), draftguitools.gui_dimensions.Dimension.finish(), draftguitools.gui_edit.Edit.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_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_splines.BSpline.finish(), draftguitools.gui_texts.Text.finish(), draftguitools.gui_points.Point.finish(), draftguitools.gui_shapestrings.ShapeString.finish(), draftguitools.gui_move.Move.get_object_selection(), draftguitools.gui_rotate.Rotate.get_object_selection(), draftguitools.gui_scale.Scale.get_object_selection(), draftguitools.gui_subelements.SubelementHighlight.get_selection(), draftguitools.gui_base_original.DraftTool.getStrings(), draftguitools.gui_move.Move.handle_mouse_click_event(), draftguitools.gui_move.Move.move(), draftguitools.gui_circulararray.CircularArray.move(), draftguitools.gui_points.Point.move(), draftguitools.gui_polararray.PolarArray.move(), draftguitools.gui_move.Move.move_object(), draftguitools.gui_move.Move.move_subelements(), draftguitools.gui_arcs.Arc.numericInput(), draftguitools.gui_polygons.Polygon.numericInput(), draftguitools.gui_rotate.Rotate.numericInput(), draftguitools.gui_shapestrings.ShapeString.numericInput(), draftguitools.gui_arcs.Arc.numericRadius(), draftguitools.gui_offset.Offset.numericRadius(), draftguitools.gui_rotate.Rotate.numericRadius(), draftguitools.gui_edit.Edit.proceed(), draftguitools.gui_groups.AddToGroup.proceed(), draftguitools.gui_groups.SetAutoGroup.proceed(), draftguitools.gui_trimex.Trimex.redraw(), draftguitools.gui_rotate.Rotate.rotate(), draftguitools.gui_fillets.Fillet.set_chamfer(), draftguitools.gui_fillets.Fillet.set_delete(), draftguitools.gui_move.Move.set_ghosts(), draftguitools.gui_rotate.Rotate.set_ghosts(), draftguitools.gui_scale.Scale.set_ghosts(), draftguitools.gui_rotate.Rotate.set_start_point(), draftguitools.gui_edit.Edit.startEditing(), and draftguitools.gui_edit.Edit.updateTrackerAndGhost().

◆ ungroup

draftguitools.gui_groups.AddToGroup.ungroup

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