Gui Command: Difference between revisions
({{Powerdocnavi{{#translation:}}}} for the proper category) |
(remove return to lines to help future translators) |
||
Line 2: | Line 2: | ||
<translate> |
<translate> |
||
<!--T:1--> |
<!--T:1--> |
||
The GuiCommand is one of the most important functions of FreeCAD |
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: |
||
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 |
* Defines a name |
||
* Contains an icon |
* Contains an icon |
||
Line 15: | Line 12: | ||
== Naming == <!--T:2--> |
== Naming == <!--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 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 in a certain module is named with the module name |
|||
in front e.g., "[[Part_Cylinder|Part_Cylinder]]". |
|||
<!--T:3--> |
<!--T:3--> |
||
Line 24: | Line 19: | ||
== Help page == <!--T:4--> |
== Help page == <!--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. [[ |
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]]. |
||
<!--T:5--> |
<!--T:5--> |
||
To create your own help pages you can use the template [[ |
To create your own help pages you can use the template [[GuiCommand_model|GuiCommand model]] |
||
<!--T:6--> |
<!--T:6--> |
||
Example: |
Example: |
||
* [[ |
* [[Draft_ShapeString|Draft ShapeString]] |
||
* [[ |
* [[Draft_Line|Draft Line]] |
||
== Icons == <!--T:7--> |
== Icons == <!--T:7--> |
||
[[Image:Tango-Palette.png|400px|right]] |
[[Image:Tango-Palette.png|400px|right]] |
||
<!--T:8--> |
<!--T:8--> |
||
Every GuiCommand has to have an icon. We use the [http://tango-project.org/Tango_Desktop_Project/ Tango icon set] and its guidelines. |
Every GuiCommand has to have an icon. We use the [http://tango-project.org/Tango_Desktop_Project/ Tango icon set] and its guidelines. On the right side you see the tango color palette. |
||
On the right side you see the tango color palette. |
|||
<!--T:9--> |
<!--T:9--> |
||
All icons should be created in [[SVG|SVG]] format with a vector image application, such as [http://inkscape.org Inkscape]. |
All icons should be created in [[SVG|SVG]] format with a vector image application, such as [http://inkscape.org Inkscape]. This makes it easier to apply changes and derive additional icons in the same application space. |
||
This makes it easier to apply changes and derive |
|||
additional icons in the same application space. |
|||
===Icons color coding chart=== <!--T:10--> |
===Icons color coding chart=== <!--T:10--> |
||
Line 56: | Line 49: | ||
== Quality requirements == <!--T:13--> |
== Quality requirements == <!--T:13--> |
||
{{VeryImportantMessage|The [[ |
{{VeryImportantMessage|The [[Complete_Workbench|Complete Workbench]] is deprecated, it no longer holds each of the commands in FreeCAD.}} |
||
<!--T:17--> |
<!--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: |
|||
<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--> |
<!--T:14--> |
||
* The command or feature has to be "finished", that is, not be a work in progress. |
* 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 set up a proper icon and menu position. |
||
* It has to have a help page, like [[ |
* It has to have a help page, like [[Draft_ShapeString|Draft ShapeString]]. |
||
** All the fields in [[Template:GuiCommand]] have to be filled in |
** 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 detailed description of the command and all its parameters and settings. |
||
Line 76: | Line 65: | ||
<!--T:15--> |
<!--T:15--> |
||
Hopefully this becomes true for all GuiCommands in the [[ |
Hopefully this becomes true for all GuiCommands in the [[Category:Command_Reference|List of Commands]].</s> |
||
</translate> |
</translate> |
Revision as of 08:59, 14 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.
Quality requirements
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:
- 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.
- 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 interfaces and classes with example code.
Hopefully this becomes true for all GuiCommands in the.
- FreeCAD scripting: Python, Introduction to Python, Python scripting tutorial, FreeCAD Scripting Basics
- Modules: Builtin modules, Units, Quantity
- Workbenches: Workbench creation, Gui Commands, Commands, Installing more workbenches
- Meshes and Parts: Mesh Scripting, Topological data scripting, Mesh to Part, PythonOCC
- Parametric objects: Scripted objects, Viewproviders (Custom icon in tree view)
- Scenegraph: Coin (Inventor) scenegraph, Pivy
- Graphical interface: Interface creation, Interface creation completely in Python (1, 2, 3, 4, 5), PySide, PySide examples beginner, intermediate, advanced
- Macros: Macros, How to install macros
- Embedding: Embedding FreeCAD, Embedding FreeCADGui
- Other: Expressions, Code snippets, Line drawing function, FreeCAD vector math library (deprecated)
- Hubs: User hub, Power users hub, Developer hub