Control.ControlCommand Class Reference

ControlCommand class specifying Animate workbench's Control button/command. More...

Inheritance diagram for Control.ControlCommand:

Public Member Functions
def	GetResources (self)
	Method used by FreeCAD to retrieve resources to use for this command. More...
def	Activated (self)
	Method used as a callback when the toolbar button or the menu item is clicked. More...
def	IsActive (self)
	Method to specify when the toolbar button and the menu item are enabled. More...

Detailed Description

ControlCommand class specifying Animate workbench's Control button/command.

This class provides resources for a toolbar button and a menu button. It controls their behaivor(Active/Inactive) and responds to callbacks after either of them was clicked(Activated).

Definition at line 1422 of file Control.py.

Member Function Documentation

Activated()

def Control.ControlCommand.Activated

(

self

)

Method used as a callback when the toolbar button or the menu item is clicked.

This method creates a Control instance in currently active document. Afterwards it adds a ControlProxy as a Proxy to this instance as well as ViewProviderControlProxy to its ViewObject.Proxy, if FreeCAD runs in the Graphic mode.

Definition at line 1445 of file Control.py.

    def Activated(self):
        doc = FreeCAD.ActiveDocument
        a = doc.addObject("App::DocumentObjectGroupPython", "Control")
        ControlProxy(a)
        if FreeCAD.GuiUp:
            ViewProviderControlProxy(a.ViewObject)
        doc.recompute()
        return

GetResources()

def Control.ControlCommand.GetResources

(

self

)

Method used by FreeCAD to retrieve resources to use for this command.

Returns

A dict with items PixMap, MenuText and ToolTip which contain a path to a command icon, a text to be shown in a menu and a tooltip message.

Definition at line 1432 of file Control.py.

    def GetResources(self):
        return {'Pixmap': path.join(PATH_TO_ICONS, "ControlCmd.png"),
                'MenuText': "Control",
                'ToolTip': "Create Control instance."}

IsActive()

def Control.ControlCommand.IsActive

(

self

)

Method to specify when the toolbar button and the menu item are enabled.

The toolbar button Control and menu item Control are set to be active only when there is an active document in which a Control instance can be created.

Returns

True if buttons shall be enabled and False otherwise.

Definition at line 1463 of file Control.py.

    def IsActive(self):
        if FreeCAD.ActiveDocument is None:
            return False
        else:
            return True

---

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

• Doxypypy outputs/Control.py