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

def draftguitools.gui_groups.AddToGroup.Activated (   self)
Execute when the command is called.

Reimplemented from draftguitools.gui_base.GuiCommandSimplest.

◆ GetResources()

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

◆ 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 Gui::GraphvizView.doc, draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.doc, draftguitools.gui_base.GuiCommandSimplest.doc, ExpressionCompleterModel::Info.doc, App::RelabelDocumentExpressionVisitor.doc, App::DynamicProperty::PropData.doc, App::LinkBaseExtension::PropInfo.doc, ItemInfo.doc, ItemInfo2.doc, importIFClegacy.IfcEntity.doc, draftguitools.gui_groups.AddToGroup.groups, Gui::SoFCColorLegend.labels, draftguitools.gui_groups.AddToGroup.labels, Gui::SoFCColorGradient.labels, Gui::AxisOrigin.labels, ArchAxis._ViewProviderAxis.labels, ArchCommands._SurveyObserver.labels, GetDepObjsExpressionVisitor.labels, test.ui, Gui::Dialog::Clipping::Private.ui, Gui::Dialog::DlgAddProperty.ui, Gui::TaskBoxPosition.ui, Gui::Dialog::DlgProjectInformationImp.ui, draftguitools.gui_circulararray.CircularArray.ui, Gui::Dialog::DlgGeneralImp.ui, Gui::Dialog::DlgSettings3DViewImp.ui, Gui::ElementColors::Private.ui, Gui::Dialog::TextureMapping.ui, Gui::Dialog::DlgSettingsNavigation.ui, Gui::Dialog::DlgCustomCommandsImp.ui, Gui::Dialog::DlgSettingsEditorImp.ui, Gui::Dialog::DlgDisplayPropertiesImp::Private.ui, Gui::Dialog::DlgParameterFind.ui, Gui::TaskBoxAngle.ui, Gui::Dialog::DlgCustomKeyboardImp.ui, Gui::Dialog::DlgWorkbenchesImp.ui, Gui::Dialog::DlgMacroExecuteImp.ui, Gui::TaskView::TaskAppearance.ui, Gui::Dialog::DlgMaterialPropertiesImp.ui, Gui::Dialog::DlgInputDialogImp.ui, Gui::Dialog::DlgExpressionInput.ui, Gui::Dialog::DlgMacroRecordImp.ui, Gui::Dialog::DemoMode.ui, Gui::Dialog::DlgSettingsColorGradientImp.ui, Gui::DlgObjectSelection.ui, Gui::Dialog::DlgCustomizeSpNavSettings.ui, Gui::Dialog::DlgProjectUtility.ui, Gui::Dialog::DlgInspector.ui, Gui::Dialog::DlgActivateWindowImp.ui, Gui::Dialog::DlgCustomActionsImp.ui, Gui::Dialog::DlgReportViewImp.ui, Gui::Dialog::DlgSettingsMacroImp.ui, Gui::Dialog::DlgSettingsViewColor.ui, Gui::Dialog::Placement.ui, Gui::Dialog::DlgSettingsUnitsImp.ui, Gui::Dialog::DownloadManager.ui, draftguitools.gui_groups.AddToGroup.ui, Gui::Dialog::DlgSettingsDocumentImp.ui, Gui::TaskView::TaskSelectLinkProperty.ui, Gui::Dialog::DlgOnlineHelpImp.ui, Gui::Dialog::DlgPropertyLink.ui, Gui::Dialog::DlgRunExternal.ui, Gui::Dialog::DlgUnitsCalculator.ui, Gui::Dialog::IconDialog.ui, Gui::Dialog::DlgParameterImp.ui, Gui::Dialog::DlgCustomToolbars.ui, draftguitools.gui_base_original.DraftTool.ui, Gui::Dialog::DlgSettingsImageImp.ui, Gui::Dialog::DlgCheckableMessageBoxPrivate.ui, Gui::Dialog::AboutDialog.ui, Gui::Dialog::Transform.ui, Gui::Dialog::DlgPreferencesImp.ui, Gui::Dialog::DocumentRecoveryPrivate.ui, Gui::CheckListDialog.ui, draftguitools.gui_edit.Edit.ui, Gui::LocationDialogImp< Ui >.ui, Gui::LocationImpUi< Ui >.ui, Gui::LocationDialogUiImp.ui, and draftguitools.gui_groups.AddToGroup.ungroup.

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

Member Data Documentation

◆ groups

◆ labels

◆ ui

◆ ungroup

draftguitools.gui_groups.AddToGroup.ungroup

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