draftguitools.gui_groups.SelectGroup Class Reference

Public Member Functions

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

Additional Inherited Members

- Public Attributes inherited from draftguitools.gui_base.GuiCommandSimplest
 command_name
 
 doc
 

Detailed Description

GuiCommand for the Draft_SelectGroup tool.

If the selection is a group, it selects all objects
with the same "parents" as this object. This means all objects
that are inside this group, including those in nested sub-groups.

If the selection is a simple object inside a group,
it will select the "brother" objects, that is, those objects that are
at the same level as this object, including the upper group
that contains them all.

NOTE: the second functionality is a bit strange, as it produces results
that are not very intuitive. Maybe we should change it and restrict
this command to only groups (`App::DocumentObjectGroup`) because
in this case it works in an intuitive manner, selecting
only the objects under the 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.SelectGroup.Activated (   self)
Execute when the command is called.

If the selection is a single group, it selects all objects
inside this group.

In other cases it selects all objects (children)
in the OutList of this object, and also all objects (parents)
in the InList of this object.
For all parents, it also selects the children of these.

Reimplemented from draftguitools.gui_base.GuiCommandSimplest.

◆ GetResources()

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

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