Gui Command/es: Difference between revisions

From FreeCAD Documentation
(Created page with "Los comandos de la interfaz gráfica de usuario (GuiCommand) son una de las funciones más importantes de FreeCAD en el principal punto de interacción del usuario. Cada vez q...")
(Created page with "=== Denominación === Los comandos de la interfaz gráfica de usuario se denominan de cierta forma: ''ModuleName_CommandName'' Por ejemplo "Base_Open" este es el comando Abrir...")
Line 8: Line 8:
* etc...
* etc...


=== Naming ===
=== Denominación ===
The GuiCommand is named in a certain way: ''ModuleName_CommandName''
Los comandos de la interfaz gráfica de usuario se denominan de cierta forma: ''ModuleName_CommandName''
e.g "Base_Open" this is the Open Gui Command in the Base system.
Por ejemplo "Base_Open" este es el comando Abrir de la interfaz gráfica de usuario en el sistema base.
Los comandos de la interfaz gráfica de usuario en un módulo determinado se denominan con el nombre del módulo como prefijo. Por ejemplo "Part_Cylinder".
The GuiCommand in a certain module is named with the module name
in front e.g. "Part_Cylinder".


If the docu is not finished use [[Template:UnfinishedDocu]]
If the docu is not finished use [[Template:UnfinishedDocu]]

Revision as of 09:49, 30 March 2014

Los comandos de la interfaz gráfica de usuario (GuiCommand) son una de las funciones más importantes de FreeCAD en el principal punto de interacción del usuario. Cada vez que el usuario selecciona un elemento del menú o presiona un botón de una barra de herramientas se activa un comando de la interfaz gráfica de usuario. Alguno de los atributos de un comandos de la interfaz gráfica de usuario (GuiCommand) son:

  • Define un nombre
  • Contiene un icono
  • Define el alcance para deshacer/rehacer
  • Tiene una página de ayuda
  • Abre y controla letreros de diálogo
  • Grabación de macros
  • etc...

Denominación

Los comandos de la interfaz gráfica de usuario se denominan de cierta forma: ModuleName_CommandName Por ejemplo "Base_Open" este es el comando Abrir de la interfaz gráfica de usuario en el sistema base. Los comandos de la interfaz gráfica de usuario en un módulo determinado se denominan con el nombre del módulo como prefijo. Por ejemplo "Part_Cylinder".

If the docu is not finished use Template:UnfinishedDocu

Help page

Every GuiCommand has to have a help page. The help page is hosted on the FreeCAD docu 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.

Preferable all Icons are drafted with SVG with e.g. 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 (Features) in FreeCAD which are experimental or used shortly for implementation purposes. 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 is the default start workbench of FreeCAD and incorporates all GuiCommands which meet certain Quality requirements which are described here:

  • The Command/Feature has to be finished. No work in progress!
  • Has to have a help page like Draft ShapeString
    • All the fields in Template:GuiCommand have to filled in
    • A picture of the dialogs the command eventually yield
    • detailed description of the command and all its parameters and settings
    • Description of the related python interfaces and classes with example code
  • Set up a proper Icon and menu position

Hopefully this becomes true for all GuiCommands in the List of Commands.