Gui Command

From FreeCAD Documentation
Revision as of 18:50, 4 September 2008 by Jriegel (talk | contribs)

The GuiCommand is one of the most important function of FreeCAD. Is the main interaction point of the User. Every time the user selects a menu item or press a toolbar button it activates a GuiCommand. Some of the attributes of a GuiCommand are:

  • Defined name
  • Contains a Icon
  • Defines the scope for an Undo/Redo
  • Have a help page
  • opens and controls modal Dialogs
  • Macro recording
  • and so forth....

Naming

The GuiCommand is named in a certain way: ModuleName_CommandName e.g "Base_Open" this is the Open Gui Command in the Base system. The GuiCommands in a certain module is named with the module name in front e.g. "Part_Cylinder".

Help page

Every GuiCommand have to have a Help page. The help page is hosted in the FreeCAD docu wiki. The Article has the same name as the GuiCommand, e.g. Part_Cylinder.

To create your own help pages you can use the Template: GuiCommand model

Example:

Icons

Every Gui Command have to have a Icon. We use the icon set and its guidelines. E.g. the Color palette: Tango_Palette.png


Quality requirements

There are a lot GuiCommands (Features) in FreeCAD which are experimental or used shortly for implementation purpose. This GuiCommands a mostly in the dedicated Workbenches like Part, Mesh or Cam. To ensure a good user experience the Workbenc Complete was created. This is the default start Workbench of FreeCAD and incorporate all GuiCommand which meat cretin Quality requirements which are described here: