Server.ServerCommand Class Reference

ServerCommand class specifying Animate workbench's Server button/command. More...

Inheritance diagram for Server.ServerCommand:

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

ServerCommand class specifying Animate workbench's Server 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 394 of file Server.py.

Member Function Documentation

Activated()

def Server.ServerCommand.Activated

(

self

)

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

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

Definition at line 417 of file Server.py.

    def Activated(self):
        doc = FreeCAD.ActiveDocument
        a = doc.addObject("Part::FeaturePython", "Server")
        ServerProxy(a)
        if FreeCAD.GuiUp:
            ViewProviderServerProxy(a.ViewObject)
        doc.recompute()

GetResources()

def Server.ServerCommand.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 404 of file Server.py.

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

IsActive()

def Server.ServerCommand.IsActive

(

self

)

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

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

Returns

True if buttons shall be enabled and False otherwise.

Definition at line 435 of file Server.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/Server.py