From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page Command and the translation is 7% complete.
Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎română • ‎русский • ‎中文(中国大陆)‎


Un comando de FreeCAD es lo que se ejecuta cuando presiona un botón de la barra de herramientas o escribe un método abreviado de teclado. Puede ser una acción muy simple, como cambiar el nivel de zoom de la vista 3D o rotar el punto de vista, o un sistema complejo que abrirá cuadros de diálogo y esperará a que el usuario realice tareas específicas.

Cada comando de FreeCAD tiene un nombre único, que aparece en la página Category: Command_Reference. Los comandos se pueden iniciar mediante un botón de la barra de herramientas, un elemento del menú o desde una secuencia de comandos de Python o la consola de Python, ejecutando:



FreeCAD commands are defined per workbench. Workbenches will normally add their command definitions at FreeCAD init time, so the command exists and is available as soon as FreeCAD is started, no matter if the corresponding workbench has been activated yet or not. In some cases however, the workbench author might have decided to not overload/burden the FreeCAD startup process and therefore loaded the command definitions only at workbench init. In those cases, the command will only be available after the workbench has been activated (you have switched to it at least once with the workbench selector).

As most of them require user interaction, FreeCAD commands are only available in GUI-mode, and not in console mode. However, for convenience, most FreeCAD commands will either have a corresponding python function (like Part.makeBox or Draft.makeLine), or will execute code that is very easy to replicate in a python script and/or macro.

Commands can be defined either in C++ or in Python.

Commands defined in C++

Example of a C++ command definition, usually defined following the structure Mod/ModuleName/Gui/Command.cpp.


  : Command("Std_My_Command")
    sGroup        = QT_TR_NOOP("File");
    sMenuText     = QT_TR_NOOP("My Command");
    sToolTipText  = QT_TR_NOOP("Runs my command in the active document");
    sWhatsThis    = "Std_MyCommand";
    sStatusTip    = QT_TR_NOOP("Runs my command in the active document");
    sPixmap       = "MyCommand.svg";
    sAccel        = "Ctrl+A";

void StdCmdExport::activated(int iMsg)
    // place here the code to be executed when the command is ran

bool StdCmdMyCommand::isActive(void)
    // here you have a chance to return true or false depending if your command must be shown as active or inactive (greyed).

// the command must be "registered" in FreeCAD's command system
CommandManager &rcCmdMgr = Application::Instance->commandManager();
rcCmdMgr.addCommand(new StdCmdMyCommand());

Commands defined in Python

Example of a Python command definition, it can be placed in a directory like Mod/ModuleName/tools/

from PySide.QtCore import QT_TRANSLATE_NOOP

class MyCommand:
    """Explanation of the command."""

    def __init__(self):
        """Initialize variables for the command that must exist at all times."""

    def GetResources(self):
        """Return a dictionary with data that will be used by the button or menu item."""
        return {'Pixmap': 'MyCommand.svg',
                'Accel': "Ctrl+A",
                'MenuText': QT_TRANSLATE_NOOP("My_Command", "My Command"),
                'ToolTip': QT_TRANSLATE_NOOP("My_Command", "Runs my command in the active document")}

    def Activated(self):
        """Run the following code when the command is activated (button press)."""

    def IsActive(self):
        """Return True when the command should be active or False when it should be disabled (greyed)."""
        return True

# The command must be "registered" with a unique name by calling its class.
FreeCADGui.addCommand('My_Command', MyCommand())


See Line drawing function.