Gui Command: Difference between revisions

Revision as of 08:17, 26 August 2008

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:

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

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:

Help page

Every GuiCommand have to have a Help page

@@ Line 1: / Line 1: @@
-The GuiCommand is one of the most important functions of FreeCAD.
+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 attributs of a GuiCommand are:
+GuiCommand. Some of the attributes of a GuiCommand are:
 * Contains a Icon
-* Defines the scope of an Undo/Redo
+* Defines the scope for an Undo/Redo
 * Have a help page
 * opens and controls modal Dialogs
+* Macro recording
 * and so forth....
+== 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:
+=== Help page ===
+Every GuiCommand have to have a Help page