Gui Command: Difference between revisions

From FreeCAD Documentation
(remove return to lines to help future translators)
(Marked this version for translation)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}
<translate>
<translate>

<!--T:1-->
<!--T:1-->
The GuiCommand is one of the most important functions of FreeCAD in the main interaction point of the user. Every time the user selects a menu item or presses a toolbar button it activates a GuiCommand. Some of the attributes of a GuiCommand are:
The GuiCommand is one of the most important functions of FreeCAD in the main interaction point of the user. Every time the user selects a menu item or presses a toolbar button it activates a GuiCommand. Some of the attributes of a GuiCommand are:
Line 11: Line 13:
* and others.
* and others.


== Naming == <!--T:2-->
== Naming == <!--T:19-->


<!--T:2-->
The GuiCommand is named in a standard way: ''ModuleName_CommandName'' e.g., "[[Base_Open|Base_Open]]" this is the Open Gui Command in the Base system. The GuiCommand in a certain module is named with the module name in front e.g., "[[Part_Cylinder|Part Cylinder]]".
The GuiCommand is named in a standard way: ''ModuleName_CommandName'' e.g., "[[Base_Open|Base_Open]]" this is the Open Gui Command in the Base system. The GuiCommand in a certain module is named with the module name in front e.g., "[[Part_Cylinder|Part_Cylinder]]".


<!--T:3-->
<!--T:3-->
If the documentation is not finished use [[Template:UnfinishedDocu]].
If the documentation is not finished use [[Template:UnfinishedDocu]].


== Help page == <!--T:4-->
== Help page == <!--T:20-->


<!--T:4-->
Every GuiCommand has to have a help page. The help page is hosted on the FreeCAD documentation wiki. The article has the same name as the GuiCommand, e.g. [[Draft_ShapeString|Draft ShapeString]].
Every GuiCommand has to have a help page. The help page is hosted on the FreeCAD documentation wiki. The article has the same name as the GuiCommand, e.g. [[Draft_ShapeString|Draft ShapeString]].


Line 32: Line 36:
== Icons == <!--T:7-->
== Icons == <!--T:7-->


<!--T:21-->
[[Image:Tango-Palette.png|400px|right]]
[[Image:Tango-Palette.png|400px|right]]


Line 48: Line 53:
We try as much as possible to respect this chart, so the color of the icons has a direct meaning.
We try as much as possible to respect this chart, so the color of the icons has a direct meaning.


== Quality requirements == <!--T:13-->

{{VeryImportantMessage|The [[Complete_Workbench|Complete Workbench]] is deprecated, it no longer holds each of the commands in FreeCAD.}}

<!--T:17-->
<s>There are a lot of GuiCommands (tools) in FreeCAD which are experimental or used for a short time to test implementation of new features. These GuiCommands are mostly in the dedicated workbenches like Part, Mesh or Cam. To ensure a good user experience the workbench ''Complete'' was created. This workbench incorporates all GuiCommands which meet certain quality requirements which are described here:

<!--T:14-->
* The command or feature has to be "finished", that is, not be a work in progress.
* It has to set up a proper icon and menu position.
* It has to have a help page, like [[Draft_ShapeString|Draft ShapeString]].
** All the fields in [[Template:GuiCommand]] have to be filled in
** It should have a detailed description of the command and all its parameters and settings.
** It should have a picture of the dialogs that the command will produce.
** It should have a description of the related [[Python|Python]] interfaces and classes with example code.

<!--T:15-->
Hopefully this becomes true for all GuiCommands in the [[Category:Command_Reference|List of Commands]].</s>


</translate>
</translate>
{{Powerdocnavi{{#translation:}}}}
{{Powerdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 09:05, 16 August 2022

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

  • Defines a name
  • Contains an icon
  • Defines the scope for an undo/redo
  • Has a help page
  • Opens and controls dialogs
  • Macro recording
  • and others.

Naming

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

If the documentation is not finished use Template:UnfinishedDocu.

Help page

Every GuiCommand has to have a help page. The help page is hosted on the FreeCAD documentation wiki. The article has the same name as the GuiCommand, e.g. Draft ShapeString.

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

Example:

Icons

Every GuiCommand has to have an icon. We use the Tango icon set and its guidelines. On the right side you see the tango color palette.

All icons should be created in SVG format with a vector image application, such as Inkscape. This makes it easier to apply changes and derive additional icons in the same application space.

Icons color coding chart

We try as much as possible to respect this chart, so the color of the icons has a direct meaning.